POST/api/v2/loyalty/merchants

Create a new merchant for the authenticated company

Authentication

Send your API key in the x-api-key header on every request.

Request body

application/json

Request body fields
FieldTypeRequiredDescription
NamestringYes
DescriptionstringNo
CategorystringNo
IsActivebooleanNo
IsPartnerbooleanNo
ContactEmailstringNo
ContactPhonestringNo
AddressstringNo
WebsitestringNo

Responses

201 — Created

Response 201 fields
FieldTypeRequiredDescription
IdunknownNo
NamestringNo
DescriptionstringNo
CategorystringNo
CompanyIdunknownNo
IsActivebooleanNo
IsPartnerbooleanNo
ContactEmailstringNo
ContactPhonestringNo
AddressstringNo
WebsitestringNo
MerchantIdsarray of MerchantIdResponseNo
LoyaltyRulesarray of MerchantLoyaltyRuleResponseNo
CreatedAtstring (date-time)No
UpdatedAtstring (date-time)No

400 — Bad Request

Response 400 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

401 — Unauthorized

Response 401 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

500 — Internal Server Error

Response 500 fields
FieldTypeRequiredDescription
MessagestringNo
CodestringNo
StatusunknownNo
ValidationErrorsobjectNo
DetailsstringNo

Example request

curl -X POST "https://{base_url}/api/v2/loyalty/merchants" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"Name":"…"}'

This page is generated from the live OpenAPI specification and always matches the current API.