LoyaltyProgram

Update loyalty program

Updates loyalty program

Authentication

api-keystring

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

Path parameters

pidstringRequiredformat: "uuid"
Loyalty Program ID. A unique identifier for the loyalty program.

Request

Update Loyalty Program Payload
namestringRequired
Loyalty Program name
descriptionstringOptional
Loyalty Program description
metaobjectOptional
Loyalty Program meta data

Response

Successfully updated 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