Update an action by id

curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/actions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "attributes": {
    "key": "<string>",
    "question": "<string>",
    "options": [
      {
        "id": "<string>",
        "label": "<string>"
      }
    ],
    "minimumNumberOfAnswersRequired": 2,
    "maximumNumberOfAnswersAllowed": 2,
    "correctAnswers": [
      "<string>"
    ]
  },
  "progressPeriod": "daily",
  "maxCompletionsPerPeriod": 1,
  "isGlobalTemplate": true,
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "videoMetadata": {
    "startsAtMs": 1,
    "shouldPause": true,
    "validatesAtMs": 1,
    "endsAtMs": 1
  },
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "config": {
    "isOptional": true,
    "socialValidation": "validation-on",
    "prerequisites": {
      "requiredActionCount": 123,
      "actionIds": [
        "<string>"
      ]
    },
    "requiresCorrectAnswer": true
  }
}
'

{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "allocationId": "<string>",
  "allocatedTo": "achievement",
  "position": 123,
  "category": "nudj",
  "key": "facebook-comment",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "progressPeriod": "daily",
  "maxCompletionsPerPeriod": 1,
  "attributes": {
    "key": "<string>",
    "question": "<string>",
    "options": [
      {
        "id": "<string>",
        "label": "<string>"
      }
    ],
    "minimumNumberOfAnswersRequired": 2,
    "maximumNumberOfAnswersAllowed": 2,
    "correctAnswers": [
      "<string>"
    ]
  },
  "config": {
    "isOptional": true,
    "socialValidation": "validation-on",
    "prerequisites": {
      "requiredActionCount": 123,
      "actionIds": [
        "<string>"
      ]
    },
    "requiresCorrectAnswer": true
  },
  "videoMetadata": {
    "startsAtMs": 1,
    "shouldPause": true,
    "validatesAtMs": 1,
    "endsAtMs": 1
  },
  "createdAt": "<string>",
  "createdBy": "<string>",
  "actionGroupId": "<string>",
  "actionGroupIndex": 123,
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "isGlobalTemplate": true,
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

POST

actions

{id}

Update an action by id

curl --request POST \
  --url https://{subdomain}.nudj.cx/api/v2/admin/actions/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-token: <api-key>' \
  --data '
{
  "attributes": {
    "key": "<string>",
    "question": "<string>",
    "options": [
      {
        "id": "<string>",
        "label": "<string>"
      }
    ],
    "minimumNumberOfAnswersRequired": 2,
    "maximumNumberOfAnswersAllowed": 2,
    "correctAnswers": [
      "<string>"
    ]
  },
  "progressPeriod": "daily",
  "maxCompletionsPerPeriod": 1,
  "isGlobalTemplate": true,
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "videoMetadata": {
    "startsAtMs": 1,
    "shouldPause": true,
    "validatesAtMs": 1,
    "endsAtMs": 1
  },
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "config": {
    "isOptional": true,
    "socialValidation": "validation-on",
    "prerequisites": {
      "requiredActionCount": 123,
      "actionIds": [
        "<string>"
      ]
    },
    "requiresCorrectAnswer": true
  }
}
'

{
  "id": "<string>",
  "organisationId": "<string>",
  "communityId": "<string>",
  "allocationId": "<string>",
  "allocatedTo": "achievement",
  "position": 123,
  "category": "nudj",
  "key": "facebook-comment",
  "details": {
    "title": "<string>",
    "description": "<string>",
    "light": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    },
    "dark": {
      "primaryImageUrl": "<string>",
      "secondaryImageUrl": "<string>"
    }
  },
  "progressPeriod": "daily",
  "maxCompletionsPerPeriod": 1,
  "attributes": {
    "key": "<string>",
    "question": "<string>",
    "options": [
      {
        "id": "<string>",
        "label": "<string>"
      }
    ],
    "minimumNumberOfAnswersRequired": 2,
    "maximumNumberOfAnswersAllowed": 2,
    "correctAnswers": [
      "<string>"
    ]
  },
  "config": {
    "isOptional": true,
    "socialValidation": "validation-on",
    "prerequisites": {
      "requiredActionCount": 123,
      "actionIds": [
        "<string>"
      ]
    },
    "requiresCorrectAnswer": true
  },
  "videoMetadata": {
    "startsAtMs": 1,
    "shouldPause": true,
    "validatesAtMs": 1,
    "endsAtMs": 1
  },
  "createdAt": "<string>",
  "createdBy": "<string>",
  "actionGroupId": "<string>",
  "actionGroupIndex": 123,
  "availableAsTemplateForOrganisations": [
    "<string>"
  ],
  "isGlobalTemplate": true,
  "updatedAt": "<string>",
  "updatedBy": "<string>"
}

Authorizations

x-api-token

string

header

required

Headers

x-language

string

The language to update the action in. This will update the action's content for the specified language.

Path Parameters

string

required

The id of the action to update

Body

application/json

The input required to update an action

attributes

Multiple Choice Question · object

The attributes of an action

Multiple Choice Question
Open Ended Question
Rate Your Experience Question
Secret Access Code Question
Select From Images Question
Select From List Question
Single Fixed Answer Question
Vote Question
Select A Date Question
Select Value In Range Question
External Link Interaction
Engage With Content Interaction
Action Attributes
Spot Object Action
Object Detection Action Attributes
Receipt Detection Action Attributes
Facebook Comment Action Attributes
Facebook Follow Action Attributes
Facebook Like Action Attributes
Instagram Follow Action Attributes
Instagram Like Action Attributes
Instagram Comment Action Attributes
Instagram Share Action Attributes
Instagram Post Action Attributes
Comment On Post Action Attributes
Complete Achievement Action Attributes
Generative Action Attributes
Like Post Action Attributes
Play Game Action Attributes
Validate Event Action Attributes
Spotify Follow Action Attributes
Spotify Listen Action Attributes
Spotify Save Action Attributes
Youtube Comment Action Attributes
Youtube Subscribe Action Attributes
Youtube Like Action Attributes
TikTok Follow Action Attributes
TikTok Post Video With Hashtag Action Attributes
TikTok Watch Video Action Attributes

Show child attributes

attributes.key

string

required

The multiple choice question action key

Allowed value: "question-multiple-choice"

attributes.question

string

required

The multiple choice question to be answered ie 'What is your favorite color?'

Minimum string length: 1

attributes.options

object[]

required

The multiple choice options available to answer the question

Minimum array length: 2

Show child attributes

attributes.options.id

string

required

The id of the option. This is used to identify the option and each option must be unique ie '1' or '2'

attributes.options.label

string

required

The label of the option ie 'Red' or 'Blue'

attributes.minimumNumberOfAnswersRequired

number

required

The minimum number of answers required

Required range: x >= 1

attributes.maximumNumberOfAnswersAllowed

number

required

The maximum number of answers allowed

Required range: x >= 1

attributes.correctAnswers

string[]

required

The correct answers for this question. This must match the ids of the options array.

progressPeriod

enum<string>

The progress period of the action

Available options:

daily,

weekly,

monthly,

yearly,

open

maxCompletionsPerPeriod

The maximum number of completions per period for the action

Required range: x >= 0

isGlobalTemplate

boolean | null

Indicates if this action is available as a template globally across all organisations

availableAsTemplateForOrganisations

string[] | null

List of organisation IDs that can use this action as a template

videoMetadata

Video Metadata · object

Video metadata for actions with video content

Show child attributes

videoMetadata.startsAtMs

number

required

The start time of the action in milliseconds from the start of the video

Required range: x >= 0

videoMetadata.shouldPause

boolean

required

Whether the video should pause at the validation point

videoMetadata.validatesAtMs

number | null

required

The validation time in milliseconds, null if the user will validate themselves

Required range: x >= 0

videoMetadata.endsAtMs

number

required

The end time of the action in milliseconds from the start of the video

Required range: x >= 0

details

Details Update Input · object

Input for updating entity details with all fields optional

Show child attributes

details.title

string

The title of the entity

details.description

string | null

The description of the entity

details.light

object

Light theme images

Show child attributes

details.light.primaryImageUrl

string | null

The url of the primary image for this theme mode

details.light.secondaryImageUrl

string | null

The url of the secondary image for this theme mode

details.dark

object

Dark theme images

Show child attributes

details.dark.primaryImageUrl

string | null

The url of the primary image for this theme mode

details.dark.secondaryImageUrl

string | null

The url of the secondary image for this theme mode

config

ActionConfigInput · object

Used to configure an action

Show child attributes

config.isOptional

boolean

Whether this action is optional

Controls how social media validation is handled:

validation-on: Strict validation is enforced. The action will only be marked as complete if the social media activity is verified.
validation-off: No validation is performed. The action is automatically marked as complete.
user-choice: Allows users to choose whether to bypass validation by setting isBypass=true in their action input. If isBypass=false, full validation will be performed.

Available options:

validation-on,

validation-off,

user-choice

config.prerequisites

ActionPrerequisite · object

Used to configure a prerequisite for an action

Show child attributes

config.prerequisites.requiredActionCount

number

required

Number of actions that must be completed within the same allocation to unlock this action

config.prerequisites.actionIds

string[]

required

Array of specific action IDs that must be completed in the same allocation

config.requiresCorrectAnswer

boolean

Whether the action must be answered correctly to count toward challenge completion. When false, any participation counts toward completion but only correct answers earn rewards.

Response

Successful response

An action

string

required

The id of the action

organisationId

string

required

The organisation that the action belongs to

communityId

string

required

The community that the action belongs to

allocationId

string | null

required

The allocation this action is assigned to. When null, indicates this is a template action.

allocatedTo

enum<string>

required

The entity type this action is allocated to. This can be set to a 'challenge' only at the moment.

Available options:

achievement,

action,

community,

challenge,

post,

reward,

reward-asset,

reward-entry

position

number

required

The display position of this action

Achievements

Action Participations

Actions

Auth Config

Campaigns

Challenge Groups

Challenges

Communities

Domains

Events

Feature Flags

Game

Games

Languages

Leaderboards

Legal Policies

Organisations

Posts

Rewards

Streaks

Tags

Teams

Templates

Themes

Third Party Config

Users

Variables

Webhooks

Xp

Update an action by id

Authorizations

Headers

Path Parameters

Body

Response