Sign in

v1

latestOpenAPI 3.0.1MIT2026-07-263151,3912.3 MB
Loyalties

Create loyalty tiers

Creates loyalty tiers for desired campaign.

post/v1/loyalties/{campaignId}/tiers

Request body

namestring required

Loyalty Tier name.

earning_rulesobject

Contains a list of earning rule IDs and their points mapping for the given earning rule.

rewardsobject

Contains a list of reward IDs and their points mapping for the given reward.

metadataobject

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.

Response

Returns created loyalty tiers.

namestring required

Loyalty Tier name.

earning_rulesobject

Contains a list of earning rule IDs and their points mapping for the given earning rule.

rewardsobject

Contains a list of reward IDs and their points mapping for the given reward.

idstring required

Unique loyalty tier ID.

campaign_idstring required

Unique parent campaign ID.

metadataobject nullable required

The metadata object stores all custom attributes assigned to the loyalty tier. A set of key/value pairs that you can attach to a loyalty tier object. It can be useful for storing additional information about the loyalty tier in a structured format.

created_atstring date-time required

Timestamp representing the date and time when the loyalty tier was created. The value is shown in the ISO 8601 format.

updated_atstring date-time nullable

Timestamp representing the date and time when the loyalty tier was updated. The value is shown in the ISO 8601 format.

object'loyalty_tier' required

The type of the object represented by JSON. This object stores information about the loyalty.

Example response

[
  {
    "expiration": {
      "customer_id": "cust_7iUa6ICKyU6gH40dBU25kQU1",
      "campaign_id": "camp_rRsfatlwN7unSeUIJDCYedal",
      "created_at": "2021-12-22T10:13:06.487Z",
      "updated_at": "2021-12-22T10:13:06.487Z"
    }
  }
]