Skip to main content
POST
/
me
/
rewards
/
{rewardAssetId}
/
redeem
Redeem my reward
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/integration/me/rewards/{rewardAssetId}/redeem \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "rewardId": "<string>",
  "allocationId": "<string>",
  "userId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "redeemable": {
    "additionalInformation": [
      {
        "variableConfigId": "<string>",
        "required": true,
        "position": 2
      }
    ],
    "content": "<string>",
    "instructions": "<string>",
    "instructionsImageUrl": "<string>",
    "supportEmail": "jsmith@example.com",
    "supportPhoneNumber": "<string>",
    "supportUrl": "<string>",
    "redeemByDate": "<string>"
  },
  "tags": [
    "<string>"
  ],
  "campaigns": [
    "<string>"
  ],
  "metadata": {},
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "additionalCommunityIds": [
    "<string>"
  ],
  "eventSourceId": "<string>",
  "claimedAt": "<string>",
  "redeemedAt": "<string>",
  "expiresAt": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

The language to return the reward in. If not provided, the default language for the organisation will be used.

Path Parameters

​
rewardAssetId
string
required
Minimum string length: 1

Response

Successful response

A reward asset

​
id
string
required
​
organisationId
string
required
​
communityId
string
required
​
rewardId
string
required
​
allocationId
string
required
​
userId
string
required
​
details
Details · object
required

Used to describe an entity

​
redeemable
Reward Asset Redeemable Rich Text · object
required

A reward asset redeemable rich text

​
eventCategory
enum<string>
required
Available options:
achievement,
action,
auth,
blog,
challenge,
community,
custom,
game,
leaderboard,
organisation,
points,
post,
referral,
reward,
shop,
social,
social-connection,
streak,
user,
variable,
xp
​
eventSubCategory
enum<string>
required
Available options:
achievement-completion,
facebook-comment,
facebook-follow,
facebook-like,
image-analysis-object-detection,
image-analysis-receipt-detection,
instagram-follow,
instagram-like,
instagram-comment,
instagram-share,
instagram-post,
interaction-engage-with-content,
interaction-external-link,
interaction-image-upload,
interaction-spot-object,
platform-comment-on-post,
platform-complete-achievement,
platform-generative-action,
platform-like-post,
platform-play-game,
platform-validate-event,
question-multiple-choice,
question-open-ended,
question-rate-your-experience,
question-secret-access-code,
question-select-date,
question-select-from-images,
question-select-value-in-range,
question-select-from-list,
question-closed-ended,
question-vote,
spotify-follow,
spotify-listen,
spotify-save,
tiktok-follow,
tiktok-watch,
tiktok-post,
youtube-like,
youtube-comment,
youtube-subscribe,
action-completion,
skip-action,
42-school,
api-auth-link,
api-token-link,
apple,
asgardeo,
atlassian,
auth0,
authentik,
azure-ad-b2c,
azure-ad,
azure-devops,
battlenet,
beyondidentity,
box,
boxyhq-saml,
bungie,
click-up,
cognito,
coinbase,
descope,
discord,
dribbble,
dropbox,
duende-identity-server6,
email,
eveonline,
facebook,
faceit,
foursquare,
freshbooks,
fusionauth,
github,
gitlab,
google,
hubspot,
identity-server4,
instagram,
kakao,
keycloak,
line,
linkedin,
mailchimp,
mailru,
mastodon,
mattermost,
medium,
naver,
netlify,
notion,
okta,
onelogin,
organisation-oidc,
osso,
osu,
passage,
patreon,
pinterest,
pipedrive,
reddit,
salesforce,
slack,
spotify,
strava,
tiktok,
todoist,
trakt,
twitch,
twitter,
united-effects,
vk,
wikimedia,
wordpress,
workos,
yandex,
youtube,
zitadel,
zoho,
zoom,
blog-comment,
blog-like,
blog-share,
blog-view,
challenge-started,
challenge-completion,
challenge-unlock,
community-visit,
parental-approval-requested,
parental-approval-approved,
parental-approval-rejected,
custom,
game-started,
game-completed,
leaderboard-finish,
invite-admin-user,
points-credit,
points-spend,
post-comment,
post-like,
post-view,
reward-redemption,
reward-allocation-purchase,
reward-giveaway-winner,
reward-claim,
reward-distribution,
manual-distribution,
referral-link-used,
shop-purchase,
share-challenge-details,
share-challenge-results,
share-community,
share-reward,
share-post,
share-profile,
share-anything,
streak-extended,
profile-picture-added,
bio-added,
variable-captured,
xp-gained,
xp-total,
xp-leaderboard-topper
​
tags
string[]
required
​
campaigns
string[]
required
​
metadata
object
required

Additional metadata inherited from the reward

​
createdAt
string
required
​
updatedAt
string
required
​
additionalCommunityIds
string[]
required

Additional communities this reward asset belongs to/is available in

​
eventSourceId
string | null
​
claimedAt
string | null
​
redeemedAt
string | null
​
expiresAt
string | null