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 or null
Unique identifier of the contact.
createdAtstring or null
Timestamp when the subscription was created.
loyaltyProgramIdstring or null
Unique identifier of the loyalty program.
loyaltySubscriptionIdstring or null
Unique identifier of the subscription.
organizationIdinteger or null
Unique identifier of the organization.
updatedAtstring or null
Timestamp when the subscription was last updated.
versionIdinteger or null
Version number of the subscription.

Errors