LoyaltyProgram

Create loyalty program

Creates loyalty program

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

Request

Payload for creating a new loyalty program.
namestringRequired<=128 characters

Required name of the loyalty program (max 128 chars).

descriptionstringOptional<=256 characters

Optional description of the loyalty program (max 256 chars).

documentIdstringOptional
Optional unique document ID.
metamap from strings to anyOptional
Optional metadata related to the loyalty program.

Response

Successfully created loyalty program.
codeCountinteger or null
Loyalty Program code count
createdAtstring or null
Loyalty Program creation date
descriptionstring or null
Loyalty Program description
documentIdstring or null
string
idstring or null
Loyalty Program ID
metamap from strings to any or null
Loyalty Program meta data
namestring or null
Loyalty Program name
patternstring or null
string
stateenum or null
Loyalty Program state
Allowed values:
subscriptionGeneratorIdstring or null
Loyalty Program subscription generator ID
subscriptionPoolIdstring or null
Loyalty Program subscription pool ID
updatedAtstring or null
Loyalty Program last modification date

Errors