Skip to main content
POST
/
action-participations
Create action participation
curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/integration/action-participations \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "actionId": "<string>",
  "actionInput": {
    "key": "interaction-external-link",
    "nonce": "<string>"
  },
  "allocationId": "<string>",
  "communityId": "<string>",
  "isPreview": true
}
'
{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "actionId": "<string>",
  "userId": "<string>",
  "actionCategory": "nudj",
  "actionKey": "facebook-comment",
  "actionAttributes": {
    "key": "question-multiple-choice",
    "question": "<string>",
    "options": [
      {
        "id": "<string>",
        "label": "<string>"
      }
    ],
    "minimumNumberOfAnswersRequired": 2,
    "maximumNumberOfAnswersAllowed": 2
  },
  "allocationId": "<string>",
  "allocatedTo": "achievement",
  "participationStatuses": [
    {
      "id": "<string>",
      "criteriaMet": true,
      "output": {
        "key": "interaction-external-link",
        "eventId": "<string>"
      },
      "status": "pending",
      "participatedAt": "<string>",
      "processingStartedAt": "<string>",
      "processedAt": "<string>",
      "unmetCriteriaMessage": "<string>",
      "metCriteriaMessage": "<string>",
      "processingFailedMessage": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "actionGroupId": "<string>"
}

Authorizations

​
x-api-token
string
header
required

Body

application/json
​
actionId
string
required
​
actionInput
ExternalLinkActionInput · object
required

The input to create an external link action participation for a user.

​
allocationId
string
required
​
communityId
string

The ID of the community where the action is being participated from. Used for cross-community challenges to track which community the user is engaging with.

​
isPreview
boolean

If true, the action participation will be validated in preview mode so that the action can be previewed and tested. This is only available for admins.

Response

Successful response

An action participation

​
id
string
required
​
organisationId
string
required
​
communityId
string
required
​
actionId
string
required
​
userId
string
required
​
actionCategory
enum<string>
required
Available options:
nudj,
discord,
facebook,
imageAnalysis,
instagram,
interaction,
linkedin,
question,
platform,
spotify,
tiktok,
twitter,
youtube
​
actionKey
enum<string>
required
Available options:
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
​
actionAttributes
Multiple Choice Question · object
required

A multiple choice question with configurable options and correct answer validation. The question text is stored in the details.title field of the action, while technical configuration remains in attributes.

​
allocationId
string
required
​
allocatedTo
enum<string>
required
Available options:
achievement,
action,
community,
challenge,
leaderboard,
post,
reward,
reward-asset,
reward-entry
​
participationStatuses
ActionParticipationStatus · object[]
required
​
createdAt
string
required
​
updatedAt
string
required
​
actionGroupId
string | null