POST
/
api
/
loyalty
/
currencies

Authorizations

X-API-KEY
string
header
required

Headers

x-api-key
string
required

Body

application/json

Schema for creating a new loyalty currency

decimals
number
required

Number of decimal places for the currency

Required range: x > 0
name
string
required

Name of the loyalty currency

organizationId
string
required

Unique identifier for the organization

symbol
string
required

Symbol representing the loyalty currency

websiteId
string
required

Unique identifier for the website

apiAuthKey
string | null

Authentication key for API

Minimum length: 1
apiAuthType
enum<string> | null

Type of authentication used for API

Available options:
none,
basic,
bearer,
apiKey
apiAuthValue
string | null

Authentication value for API

Minimum length: 1
apiGetTransactionEntryUrl
string | null

Optional API GET URL for fetching transaction entry data

Minimum length: 1
apiGetUrl
string | null

Optional API GET URL for fetching data

Minimum length: 1
apiPostUrl
string | null

Optional API POST URL for sending data

Minimum length: 1
imageUrl
string | null

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

sortId
number

Optional sorting identifier

Response

200 - application/json
apiAuthKey
string | null
required

Authentication key for API

apiAuthType
enum<string> | null
required

Type of authentication used for API

Available options:
none,
basic,
bearer,
apiKey
apiAuthValue
string | null
required

Authentication value for API

apiGetTransactionEntryUrl
string | null
required

API GET URL for fetching transaction entry data

apiGetUrl
string | null
required

API GET URL for fetching data

apiPostUrl
string | null
required

API POST URL for sending data

createdAt
string
required

Timestamp when the currency was created

createdById
string | null
required

ID of the user who created the currency

decimals
number
required

Number of decimal places for the currency

Required range: x > 0
deletedAt
string | null
required

Timestamp when the currency was deleted, if applicable

id
string
required

Unique identifier for the loyalty currency

imageUrl
string | null
required

URL of the image

name
string
required

Name of the loyalty currency

organizationId
string
required

Unique identifier for the organization

sortId
number | null
required

Sorting identifier

symbol
string
required

Symbol representing the loyalty currency

updatedAt
string
required

Timestamp when the currency was last updated

websiteId
string
required

Unique identifier for the website