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
Loyalty Program code count
createdAtstring
Loyalty Program creation date
descriptionstring
Loyalty Program description
documentIdstring
string
idstring
Loyalty Program ID
metamap from strings to any
Loyalty Program meta data
namestring
Loyalty Program name
patternstring
string
stateenum
Loyalty Program state
Allowed values:
subscriptionGeneratorIdstring
Loyalty Program subscription generator ID
subscriptionPoolIdstring
Loyalty Program subscription pool ID
updatedAtstring
Loyalty Program last modification date

Errors

401
Unauthorized Error
403
Forbidden Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error