Create Loyalty Program

post

https://api.gameshift.dev/nx/loyalty-rewards/programs

Note: This action uses the developer wallet

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

name

string

Optional name of the program, shown in the UI

image

string

Optional associated image URL of the program, shown in the UI

enrollmentCurrencyId

string

required

The currency id of the enrollment currency. Register under /nx/currencies

rewardCurrencyId

string

required

The currency id of the enrollment currency. Register under /nx/currencies

maxEnrollments

number

required

The max number of enrollments that this pool can support (up to 32,000)

maxTokens

string

required

The max number of enrolled tokens that this pool can support (as a string). Up to 2^64.

maxEnrollmentPeriod

number

required

The max amount of time in seconds that an enrollment can last.

minEnrollmentPeriod

number

required

The minimum amount of time, in seconds, that an enrollment can last.

Headers

x-api-key

string

required

API key for your game

x-wallet-key

string

required

Response

201