API Reference

Create Redemption

post
https://{api_hostname}/alpha/redemption

Create the redemption and return the redemption object.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Request body to create a redemption.

string
length ≤ 250

Title of the redemption.

string
length ≤ 1000

Description of the redemption.

uuid
required

The id of the erc20 token payable for the redemption.

uuid
required

The id of the erc721 or erc1155 token receivable for the redemption.

string
enum
required

The type of the token receivable for the redemption.

Allowed:
number

Token id of the erc1155 token receivable for the redemption. Required only for erc1155 tokens. Not used for erc721 tokens.

number
required

The amount of erc20 tokens required to redeem the reward.

number

The maximum amount of rewards that can be redeemed by a single user.

number

The total amount of redemptions available for all users.

string
enum

The status of the redemption at time of creation.

Allowed:
date-time

The start date for the redemption.

date-time

The end date for the redemption.

Responses

Updated over 2 years ago

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated over 2 years ago