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.
idstringOptionalformat: "uuid"
Loyalty Program unique identifier.
namestringOptional
Loyalty Program name.
descriptionstringOptional
Loyalty Program description.
metamap from strings to anyOptional
Loyalty Program metadata.
stateenumOptional
Current state of the loyalty program.
subscriptionPoolIdstringOptionalformat: "uuid"
Loyalty Program subscription pool ID.
subscriptionGeneratorIdstringOptionalformat: "uuid"
Loyalty Program subscription generator ID.
patternstringOptional
Subscription code pattern.
codeCountlongOptional
Number of available subscription codes.
documentIdstringOptionalformat: "uuid"
Associated document identifier.
birthdayAttributestringOptional
Contact attribute name used for birthday tracking.
createdAtdatetimeOptional
Timestamp when the loyalty program was created.
updatedAtdatetimeOptional
Timestamp when the loyalty program was last modified.

Errors

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