LoyaltyProgram

Create subscription

Subscribes to a 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

Create Subscription Payload
contactIdintegerRequired

Required contact ID; must be greater than 0.

creationDatestringOptional

Optional custom date-time format.

loyaltySubscriptionIdstringOptional<=64 characters

Optional subscription ID (max length 64).

Response

Successfully created subscription.
contactIdinteger
Unique identifier of the contact.
createdAtstring
Timestamp when the subscription was created.
loyaltyProgramIdstring
Unique identifier of the loyalty program.
loyaltySubscriptionIdstring
Unique identifier of the subscription.
organizationIdinteger
Unique identifier of the organization.
updatedAtstring
Timestamp when the subscription was last updated.
versionIdinteger
Version number of the subscription.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
500
Internal Server Error