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>",
  "rewardAssetIds": [
    "<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>"
  ],
  "checkByDate": "<string>",
  "checkedAt": "<string>",
  "drawnAt": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "additionalCommunityIds": [
    "<string>"
  ],
  "status": "pending",
  "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": {
        "instructions": "<string>",
        "instructionsImageUrl": "<string>",
        "supportEmail": "jsmith@example.com",
        "supportPhoneNumber": "<string>",
        "supportUrl": "<string>",
        "type": "rich-text",
        "additionalInformation": [
          {
            "variableConfigId": "<string>",
            "required": true,
            "position": 2
          }
        ],
        "redeemByDate": "<string>",
        "content": "<string>"
      },
      "eventCategory": "achievement",
      "eventSubCategory": "achievement-completion",
      "eventSourceId": "<string>",
      "tags": [
        "<string>"
      ],
      "campaigns": [
        "<string>"
      ],
      "metadata": {},
      "claimedAt": "<string>",
      "redeemedAt": "<string>",
      "expiresAt": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "additionalCommunityIds": [
        "<string>"
      ]
    }
  ]
}

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 length: 1

Response

Successful response

A reward entry

id
string
required
organisationId
string
required
communityId
string
required
rewardId
string
required
userId
string
required
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

I