Skip to main content
POST
/
me
/
reward-entries
/
{rewardEntryId}
/
check
Check my reward entry
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/integration/me/reward-entries/{rewardEntryId}/check \
  --header 'x-api-token: <api-key>'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "rewardId": "<string>",
  "userId": "<string>",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "totalEntries": 123,
  "entries": [
    {
      "allocationId": "<string>",
      "amount": 123,
      "createdAt": "<string>"
    }
  ],
  "tags": [
    "<string>"
  ],
  "campaigns": [
    "<string>"
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "additionalCommunityIds": [
    "<string>"
  ],
  "status": "pending",
  "rewardAssetIds": [
    "<string>"
  ],
  "checkByDate": "<string>",
  "checkedAt": "<string>",
  "drawnAt": "<string>",
  "rewardAssets": [
    {
      "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": {
        "type": "rich-text",
        "additionalInformation": [
          {
            "variableConfigId": "<string>",
            "required": true,
            "position": 2
          }
        ],
        "content": "<string>",
        "instructions": "<string>",
        "instructionsImageUrl": "<string>",
        "supportEmail": "jsmith@example.com",
        "supportPhoneNumber": "<string>",
        "supportUrl": "<string>",
        "redeemByDate": "<string>"
      },
      "eventCategory": "achievement",
      "eventSubCategory": "achievement-completion",
      "tags": [
        "<string>"
      ],
      "campaigns": [
        "<string>"
      ],
      "metadata": {},
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "additionalCommunityIds": [
        "<string>"
      ],
      "eventSourceId": "<string>",
      "claimedAt": "<string>",
      "redeemedAt": "<string>",
      "expiresAt": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.nudj.cx/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-token
string
header
required

Headers

​
x-language
string

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

Path Parameters

​
rewardEntryId
string
required
Minimum string length: 1

Response

Successful response

A reward entry

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

Used to describe an entity

​
totalEntries
number
required
​
entries
Reward Entry Reference · object[]
required
​
tags
string[]
required
​
campaigns
string[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
additionalCommunityIds
string[]
required

Additional communities this reward entry belongs to/is available in

​
status
enum<string>
required

The status of the reward entry

Available options:
pending,
unchecked,
won,
lost
​
rewardAssetIds
string[] | null
​
checkByDate
string | null
​
checkedAt
string | null
​
drawnAt
string | null
​
rewardAssets
Reward Asset · object[] | null

The reward assets if the user won