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>"
}
]
}Check if the current user’s entry is a winning 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>"
}
]
}The language to return the reward entry in. If not provided, the default language for the organisation will be used.
1Successful response
A reward entry
Used to describe an entity
Show child attributes
Show child attributes
Additional communities this reward entry belongs to/is available in
The status of the reward entry
pending, unchecked, won, lost The reward assets if the user won
Show child attributes
Was this page helpful?