AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

AWorld API

Create mission assignment (manual)

POST

https://api.eu-west-1.aworld.cloud/dashboard/v1/missionAssignments

MissionAssignments

Manually assigns a mission to a user or a group. This is typically used for specific cases not covered by mission rules.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/dashboard/v1/missionAssignments' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userId": "string",
    "groupTagId": "string",
    "missionType": "INDIVIDUAL",
    "missionId": "string",
    "startsAt": "2019-08-24T14:15:22Z",
    "endsAt": "2019-08-24T14:15:22Z",
    "currentAmount": 0,
    "targetAmount": 0,
    "timeframeType": "RANGE"
}'

Response Example

{
    "missionAssignmentId": "string",
    "missionType": "INDIVIDUAL",
    "missionId": "string",
    "missionRuleId": "string",
    "periodId": "string",
    "timeframeType": "PERMANENT",
    "startsAt": "2019-08-24T14:15:22Z",
    "endsAt": "2019-08-24T14:15:22Z",
    "completedAt": "2019-08-24T14:15:22Z",
    "isCompleted": true,
    "state": "PENDING",
    "groupTagId": "string",
    "userId": "string",
    "currentAmount": 0,
    "targetAmount": 0,
    "incrementExpression": {},
    "targetAmountExpression": {},
    "accountId": "string",
    "workspaceId": "string",
    "sourceRegion": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Data required to manually create a mission assignment.

userId

string

optional

Required if missionType is 'INDIVIDUAL'. The ID of the user to assign the mission to.

groupTagId

string

optional

Required if missionType is 'GROUP'. The tag ID of the group to assign the mission to.

missionType

enum<string>

required

Type of the mission being assigned.

Allowed values:

INDIVIDUALGROUP

missionId

string

required

Identifier of the mission to assign.

startsAt

string <date-time>

required

Start date-time for this manual assignment.

endsAt

string <date-time>

optional

Optional. End date-time for this manual assignment (required if timeframeType is 'RANGE').

currentAmount

number

optional

Optional. Initial progress amount. Defaults to 0.

Default:

targetAmount

number

optional

Optional. Overrides the mission's targetAmountExpression if provided.

timeframeType

enum<string>

required

Timeframe type for this manual assignment. 'RECURRING' is not allowed for manual assignments.

Allowed values:

RANGEPERMANENT

Examples

Responses

🟢201Created

application/json

Mission assignment created successfully.

Body

Represents the assignment of a mission to a user or a group.

missionAssignmentId

string

required

Unique identifier for the mission assignment (NanoID).

missionType

enum<string>

required

Type of the assigned mission.

Allowed values:

INDIVIDUALGROUP

missionId

string

required

Identifier of the assigned mission.

missionRuleId

string

optional

Optional. Identifier of the mission rule that triggered this assignment.

periodId

string

required

Identifier for the specific period of a recurring mission assignment.

timeframeType

enum<string>

required

The timeframe type of this assignment.

Allowed values:

PERMANENTRANGERECURRING

startsAt

string <date-time>

required

Start date-time of this mission assignment.

endsAt

string <date-time>

optional

Optional. End date-time of this mission assignment (for RANGE and RECURRING).

completedAt

string <date-time>

optional

Optional. Timestamp when the mission assignment was completed.

isCompleted

boolean

optional

Indicates if the mission assignment is completed.

state

enum<string>

required

Current state of the mission assignment.

Allowed values:

PENDINGACTIVEENDED

groupTagId

string

optional

Required if missionType is 'GROUP'. The tag ID of the assigned group.

userId

string

optional

Required if missionType is 'INDIVIDUAL'. The ID of the assigned user.

currentAmount

number

required

Current progress amount towards the target.

targetAmount

number

required

Target amount required for mission completion.

incrementExpression

JsonLogicExpression

required

JSON Logic expression defining how progress is incremented for this assignment. Evaluated against: { event } (where event is the specific entity like Activity, Quiz, or Tag that triggered the evaluation).

One of

object

number

boolean

Object representation of a JSON Logic rule

targetAmountExpression

JsonLogicExpression

required

JSON Logic expression defining the target amount for this assignment. Evaluated against: { mission, user? } (user is optional and only present for INDIVIDUAL missions).

One of

object

number

boolean

Object representation of a JSON Logic rule

accountId

string

optional

The account ID associated with this assignment.

workspaceId

string

optional

The workspace ID associated with this assignment.

sourceRegion

string

optional

AWS region where this assignment was created.

createdAt

string <date-time>

optional

Timestamp when the assignment was created.

updatedAt

string <date-time>

optional

Timestamp when the assignment was last updated.

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

🟠409409

Modified at 2025-06-26 12:49:12

Publish a mission rule

List reward rules