Skip to main content

Create a new reward

POST 
/reward

Create a new reward

Request​

Body

Data for creating a new reward

    description stringrequired

    Detailed description of the reward

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    id rewardId (string)

    Unique identifier for Reward

    projectId stringrequired

    ID of the project associated with the reward

    expiresAt date-timenullable

    Expiration date for special rewards

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

    requiredPoints integer

    Possible values: <= 1000000

    Points required to claim the reward

    name stringrequired

    Name of the reward

    data stringnullable

    Additional JSON metadata for triggers, actions or general easy-access data

    maxClaims integernullable

    Maximum number of times this reward can be redeemed.

Responses​

Reward successfully created

Schema

    description stringrequired

    Detailed description of the reward

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    id rewardId (string)

    Unique identifier for Reward

    projectId stringrequired

    ID of the project associated with the reward

    expiresAt date-timenullable

    Expiration date for special rewards

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

    userRewardCount integer

    Number of times this reward has been redeemed.

    myUserRewardCount integer

    Number of times this reward has been redeemed by the current user.

    requiredPoints integer

    Possible values: <= 1000000

    Points required to claim the reward

    name stringrequired

    Name of the reward

    createdAt date-time

    Time representation of entity creation

    data stringnullable

    Additional JSON metadata for triggers, actions or general easy-access data

    maxClaims integernullable

    Maximum number of times this reward can be redeemed.

Loading...