Skip to main content

Create a new reward

POST 
/reward

Create a new reward

Request​

Body

Data for creating a new reward

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    name rewardName (string)required

    Possible values: <= 32 characters

    Name of the reward

    expiresAt date-timenullable

    Expiration date for special rewards

    id rewardId (string)

    Unique identifier for Reward

    data stringnullable

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

    projectId stringrequired

    ID of the project associated with the reward

    maxClaims integernullable

    Maximum number of times this reward can be redeemed.

    requiredPoints integer

    Possible values: <= 1000000

    Points required to claim the reward

    description stringrequired

    Detailed description of the reward

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

Responses​

Reward successfully created

Schema

    createdAt date-time

    Time representation of entity creation

    thumbnail urinullable

    Optional URL for the reward's thumbnail image.

    name rewardName (string)required

    Possible values: <= 32 characters

    Name of the reward

    expiresAt date-timenullable

    Expiration date for special rewards

    id rewardId (string)

    Unique identifier for Reward

    data stringnullable

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

    projectId stringrequired

    ID of the project associated with the reward

    maxClaims integernullable

    Maximum number of times this reward can be 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

    description stringrequired

    Detailed description of the reward

    userRewardCount integer

    Number of times this reward has been redeemed.

    rewardTypeId rewardTypeId (string)required

    Unique identifier for RewardType

Loading...