Create a loyalty currency

Create a loyalty currency

POST /api/loyalty/currencies

Create a loyalty currency

cURL

curl --request POST \
  --url https://admin.snagsolutions.io/api/loyalty/currencies \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "name": "Loyalty Points",
  "symbol": "LP",
  "decimals": 2,
  "imageUrl": "https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png",
  "apiGetUrl": "https://api.example.com/get-loyalty",
  "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty-tx",
  "apiPostUrl": "https://api.example.com/post-loyalty",
  "sortId": 1,
  "apiAuthType": "basic",
  "apiAuthKey": "apiKey123",
  "apiAuthValue": "apiValue456"
}
'

200

{
  "id": "123e4567-e89b-12d3-a456-426614174005",
  "organizationId": "123e4567-e89b-12d3-a456-426614174001",
  "websiteId": "123e4567-e89b-12d3-a456-426614174002",
  "imageUrl": "https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png",
  "name": "Loyalty Points",
  "symbol": "LP",
  "decimals": 2,
  "createdById": "123e4567-e89b-12d3-a456-426614174010",
  "createdAt": "2023-10-01T12:34:56.000Z",
  "updatedAt": "2023-10-05T15:30:00.000Z",
  "apiGetUrl": "https://api.example.com/get-loyalty",
  "apiGetTransactionEntryUrl": "https://api.example.com/get-loyalty",
  "apiPostUrl": "https://api.example.com/post-loyalty",
  "apiAuthType": "basic",
  "apiAuthKey": "apiKey123",
  "apiAuthValue": "apiValue456",
  "sortId": 1,
  "deletedAt": null,
  "isTokenRewardCurrency": false
}

Authorizations

X-API-KEY · string · header · required

Body

application/json

Body

Schema for creating a new loyalty currency

organizationId · string<uuid> · required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId · string<uuid> · required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

name · string · required

Name of the loyalty currency

Example:

"Loyalty Points"

symbol · string · required

Symbol representing the loyalty currency

Example:

"LP"

decimals · number · required

Number of decimal places for the currency

Required range: x >= 0

Example:

2

imageUrl · string | null

URL of the image; must start with AWS S3 asset URL base

Example:

"https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png"

apiGetUrl · string | null

Optional API GET URL for fetching data

Minimum string length: 1

Example:

"https://api.example.com/get-loyalty"

apiGetTransactionEntryUrl · string | null

Optional API GET URL for fetching transaction entry data

Minimum string length: 1

Example:

"https://api.example.com/get-loyalty-tx"

apiPostUrl · string | null

Optional API POST URL for sending data

Minimum string length: 1

Example:

"https://api.example.com/post-loyalty"

sortId · number

Optional sorting identifier

Example:

1

apiAuthType · enum<string> | null

Type of authentication used for API

Available options: none, basic, bearer, apiKey

Example:

"basic"

apiAuthKey · string | null

Authentication key for API

Minimum string length: 1

Example:

"apiKey123"

apiAuthValue · string | null

Authentication value for API

Minimum string length: 1

Example:

"apiValue456"

Response

200

application/json

200

Schema for a loyalty currency

id · string<uuid> · required

Unique identifier for the loyalty currency

Example:

"123e4567-e89b-12d3-a456-426614174005"

organizationId · string<uuid> · required

Unique identifier for the organization

Example:

"123e4567-e89b-12d3-a456-426614174001"

websiteId · string<uuid> · required

Unique identifier for the website

Example:

"123e4567-e89b-12d3-a456-426614174002"

imageUrl · string | null · required

URL of the image

Example:

"https://d1ked0nzx7in3u.cloudfront.net/images/loyalty.png"

name · string · required

Name of the loyalty currency

Example:

"Loyalty Points"

symbol · string · required

Symbol representing the loyalty currency

Example:

"LP"

decimals · number · required

Number of decimal places for the currency

Required range: x >= 0

Example:

2

createdById · string<uuid> | null · required

ID of the user who created the currency

Example:

"123e4567-e89b-12d3-a456-426614174010"

createdAt · string<date-time> · required

Timestamp when the currency was created

Example:

"2023-10-01T12:34:56.000Z"

updatedAt · string<date-time> · required

Timestamp when the currency was last updated

Example:

"2023-10-05T15:30:00.000Z"

apiGetUrl · string | null · required

API GET URL for fetching data

Example:

"https://api.example.com/get-loyalty"

apiGetTransactionEntryUrl · string | null · required

API GET URL for fetching transaction entry data

Example:

"https://api.example.com/get-loyalty"

apiPostUrl · string | null · required

API POST URL for sending data

Example:

"https://api.example.com/post-loyalty"

apiAuthType · enum<string> | null · required

Type of authentication used for API

Available options: none, basic, bearer, apiKey

Example:

"basic"

apiAuthKey · string | null · required

Authentication key for API

Example:

"apiKey123"

apiAuthValue · string | null · required

Authentication value for API

Example:

"apiValue456"

sortId · number | null · required

Sorting identifier

Example:

1

deletedAt · string<date-time> | null · required

Timestamp when the currency was deleted, if applicable

Example:

null

isTokenRewardCurrency · boolean

True for LoyaltyCurrency rows auto-created by resolveTokenReward (Option 1 hidden currency backing a token-reward rule). Excluded from list responses by default; opt in via excludeTokenRewardCurrencies=false on the list endpoint.

Example:

false