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
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
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
500
Internal Server Error