Loyalty

Create a reward tier

Create a loyalty reward tier for the application, enforcing a unique visit threshold and defining the accrual ratio.

post/v1/loyalty/reward-tiers

Request

  • Base URL: https://api.prod.keyban.io
  • URL: https://api.prod.keyban.io/v1/loyalty/reward-tiers
  • Auth: API key in header X-Api-Key

Request body

applicationstring uuid required

The unique identifier of the application

namestring required

The name of the loyalty reward tier

requiredVisitsinteger required

The number of visits required to reach this reward tier

currencyToPointRatiointeger required

Number of loyalty points earned for each 1 unit of currency spent (e.g., if the ratio is 2 and currency is EUR, spending €1 earns 2 points). Used to calculate point accruals from transaction amounts.

bgImageUrlstring uri nullable

Background image for the reward tier. Supported formats: WEBP (preferred), PNG. Recommended size: 1920×1080 px (landscape). Max file size: 1 MB.

Response

Loyalty reward tier created successfully

idstring uuid required

Entity UUID

createdAtstring date-time required

Creation date (ISO 8601)

updatedAtstring date-time required

Last update date (ISO 8601)

applicationstring uuid required

The unique identifier of the application

namestring required

The name of the loyalty reward tier

requiredVisitsinteger required

The number of visits required to reach this reward tier

currencyToPointRatiointeger required

Number of loyalty points earned for each 1 unit of currency spent (e.g., if the ratio is 2 and currency is EUR, spending €1 earns 2 points). Used to calculate point accruals from transaction amounts.

bgImageUrlstring uri nullable

Background image for the reward tier. Supported formats: WEBP (preferred), PNG. Recommended size: 1920×1080 px (landscape). Max file size: 1 MB.

Changes

No recorded changes to this operation across all 1 revision of this API.