POST
/
api
/
loyalty
/
currencies

Authorizations

X-API-KEY
string
headerrequired

Headers

x-api-key
string
required

Body

application/json

Schema for creating a new loyalty currency

organizationId
string
required

Unique identifier for the organization

websiteId
string
required

Unique identifier for the website

name
string
required

Name of the loyalty currency

symbol
string
required

Symbol representing the loyalty currency

decimals
number
required

Number of decimal places for the currency

Required range: x > 0
imageUrl
string | null

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

apiGetUrl
string | null

Optional API GET URL for fetching data

Minimum length: 1
apiGetTransactionEntryUrl
string | null

Optional API GET URL for fetching transaction entry data

Minimum length: 1
apiPostUrl
string | null

Optional API POST URL for sending data

Minimum length: 1
sortId
number

Optional sorting identifier

apiAuthType
enum<string> | null

Type of authentication used for API

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

Authentication key for API

Minimum length: 1
apiAuthValue
string | null

Authentication value for API

Minimum length: 1

Response

200 - application/json

Schema for a loyalty currency

id
string
required

Unique identifier for the loyalty currency

organizationId
string
required

Unique identifier for the organization

websiteId
string
required

Unique identifier for the website

imageUrl
string | null
required

URL of the image

name
string
required

Name of the loyalty currency

symbol
string
required

Symbol representing the loyalty currency

decimals
number
required

Number of decimal places for the currency

Required range: x > 0
createdById
string | null
required

ID of the user who created the currency

createdAt
string
required

Timestamp when the currency was created

updatedAt
string
required

Timestamp when the currency was last updated

apiGetUrl
string | null
required

API GET URL for fetching data

apiGetTransactionEntryUrl
string | null
required

API GET URL for fetching transaction entry data

apiPostUrl
string | null
required

API POST URL for sending data

apiAuthType
enum<string> | null
required

Type of authentication used for API

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

Authentication key for API

apiAuthValue
string | null
required

Authentication value for API

sortId
number | null
required

Sorting identifier

deletedAt
string | null
required

Timestamp when the currency was deleted, if applicable