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 rule

POST

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

MissionRules

Creates a new mission rule with a system-generated ID.

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.eu-west-1.aworld.cloud/dashboard/v1/missionRules' \
--header 'Content-Type: application/json' \
--data-raw '{
    "missionType": "INDIVIDUAL",
    "name": "string",
    "groupTagId": "string",
    "usersMatchCondition": {},
    "missionsPool": [
        "string"
    ],
    "missionsMatchCondition": {},
    "timeframeType": "PERMANENT",
    "timeframeTimezoneType": "FIXED",
    "timeframeTimezone": "string",
    "timeframeStartsAt": "2019-08-24T14:15:22Z",
    "timeframeEndsAt": "2019-08-24T14:15:22Z",
    "recurrence": "DAILY",
    "scheduleCron": "string",
    "assignmentMode": "LAZY",
    "defaultLang": "string",
    "translations": [
        {
            "lang": "string",
            "description": "string"
        }
    ],
    "eventMatchType": "INSTANCE",
    "eventMatchEntity": "Activity",
    "eventMatchEntityId": "string",
    "eventMatchCondition": {}
}'

Response Example

{
    "missionRuleId": "string",
    "missionType": "INDIVIDUAL",
    "name": "string",
    "groupTagId": "string",
    "usersMatchCondition": {},
    "missionsPool": [
        "string"
    ],
    "missionsMatchCondition": {},
    "timeframeType": "PERMANENT",
    "timeframeTimezoneType": "FIXED",
    "timeframeTimezone": "string",
    "timeframeStartsAt": "2019-08-24T14:15:22Z",
    "timeframeEndsAt": "2019-08-24T14:15:22Z",
    "recurrence": "DAILY",
    "scheduleCron": "string",
    "assignmentMode": "LAZY",
    "state": "PENDING",
    "origin": "CATALOG",
    "missionRuleCatalogId": "string",
    "syncWithCatalog": true,
    "defaultLang": "string",
    "langs": [
        "string"
    ],
    "eventMatchType": "INSTANCE",
    "eventMatchEntity": "Activity",
    "eventMatchEntityId": "string",
    "eventMatchCondition": {},
    "accountId": "string",
    "workspaceId": "string",
    "sourceRegion": "string",
    "stage": "DRAFT",
    "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 create a new mission rule.

missionType

enum<string>

required

Allowed values:

INDIVIDUALGROUP

name

string

required

groupTagId

string

optional

usersMatchCondition

JsonLogicExpression

optional

Evaluated against: { user }.

One of

object

number

boolean

Object representation of a JSON Logic rule

missionsPool

array[string]

optional

missionsMatchCondition

JsonLogicExpression

required

Evaluated against: { mission }.

One of

object

number

boolean

Object representation of a JSON Logic rule

timeframeType

enum<string>

required

Allowed values:

PERMANENTRANGERECURRING

timeframeTimezoneType

enum<string>

required

Allowed values:

FIXEDUSER

timeframeTimezone

string

optional

timeframeStartsAt

string <date-time>

required

timeframeEndsAt

string <date-time>

optional

recurrence

enum<string>

optional

Allowed values:

DAILYWEEKLYMONTHLYCUSTOM

scheduleCron

string

optional

assignmentMode

enum<string>

required

Allowed values:

LAZYSCHEDULED_PUSHEVENTDISABLED

defaultLang

string

required

translations

array[object (MissionRuleTranslation) {2}]

required

>= 1 items<= 10 items

lang

string

required

description

string

optional

eventMatchType

enum<string>

optional

Allowed values:

INSTANCEENTITYTAG

eventMatchEntity

enum<string>

optional

Allowed values:

ActivityQuizTagUser

eventMatchEntityId

string

optional

eventMatchCondition

JsonLogicExpression

optional

Evaluated against: { event }.

One of

object

number

boolean

Object representation of a JSON Logic rule

Examples

Responses

🟢201Created

application/json

Mission rule created successfully.

Body

Defines rules for automatically assigning missions to users or groups.

missionRuleId

string

required

Unique identifier for the mission rule (NanoID).

missionType

enum<string>

required

Type of missions this rule assigns (individual or group).

Allowed values:

INDIVIDUALGROUP

name

string

required

Name of the mission rule.

groupTagId

string

optional

Required if missionType is 'GROUP'. The tag ID identifying the target group.

usersMatchCondition

JsonLogicExpression

optional

Required if missionType is 'INDIVIDUAL'. JSON Logic to filter users. Evaluated against: { user }.

One of

object

number

boolean

Object representation of a JSON Logic rule

missionsPool

array[string]

optional

Optional pool of mission IDs from which to select.

missionsMatchCondition

JsonLogicExpression

required

JSON Logic to select missions from the pool or all available missions. Every mission is evaluated singularly. Evaluated against: { mission }.

One of

object

number

boolean

Object representation of a JSON Logic rule

timeframeType

enum<string>

required

Defines the active period of the rule. Please note that 'PERMANENT' should be used only on one-time missions, since they cannot be assigned again after the first time

Allowed values:

PERMANENTRANGERECURRING

timeframeTimezoneType

enum<string>

required

Determines if the timeframe uses a fixed timezone or the user's timezone.

Allowed values:

FIXEDUSER

timeframeTimezone

string

optional

Required if timeframeTimezoneType is 'FIXED'. The IANA timezone string.

timeframeStartsAt

string <date-time>

required

Start date-time of the rule's active period.

timeframeEndsAt

string <date-time>

optional

Required for 'RANGE' and 'RECURRING' timeframeTypes. End date-time.

recurrence

enum<string>

optional

Required for 'RECURRING' timeframeType. How often the rule recurs.

Allowed values:

DAILYWEEKLYMONTHLYCUSTOM

scheduleCron

string

optional

Required if recurrence is 'CUSTOM' or assignmentMode is 'SCHEDULED_PUSH'. Cron expression for scheduling.

assignmentMode

enum<string>

required

How missions are assigned by this rule. LAZY would cause missions to be assigned (if applicable) every time a user requests its own missions. EVENT based assignments allows assigning missions in response to other events. Please note that SCHEDULED_PUSH is not supported at the moment, and will be supported in the future.

Allowed values:

LAZYSCHEDULED_PUSHEVENTDISABLED

state

enum<string>

required

Current operational state of the rule.

Allowed values:

PENDINGACTIVEENDED

Default:

PENDING

origin

enum<string>

required

Source of the rule definition.

Allowed values:

CATALOGCUSTOM

missionRuleCatalogId

string

optional

ID from catalog if origin is 'CATALOG'.

syncWithCatalog

boolean

optional

Whether to sync with catalog updates.

defaultLang

string

required

Default language for translations.

langs

array[string]

required

Available languages for translations.

eventMatchType

enum<string>

optional

Required for 'EVENT' assignmentMode. Type of event matching.

Allowed values:

INSTANCEENTITYTAG

eventMatchEntity

enum<string>

optional

Required for 'EVENT' assignmentMode. Entity involved in the event.

Allowed values:

ActivityQuizTagUser

eventMatchEntityId

string

optional

Required for 'EVENT' assignmentMode. Specific ID of the event entity.

eventMatchCondition

JsonLogicExpression

optional

Required for 'EVENT' assignmentMode. JSON Logic for event conditions. Evaluated against: { event } (where event is the specific entity like Activity, Quiz, Tag, or User that triggered the evaluation).

One of

object

number

boolean

Object representation of a JSON Logic rule

accountId

string

optional

The account ID that owns this mission rule.

workspaceId

string

optional

The workspace ID that contains this mission rule.

sourceRegion

string

optional

AWS region where the mission rule was created.

stage

enum<string>

optional

Current publication stage of the mission rule.

Allowed values:

DRAFTPUBLISHED

createdAt

string <date-time>

optional

Timestamp when the mission rule was created.

updatedAt

string <date-time>

optional

Timestamp when the mission rule was last updated.

🟠400Bad Request

🟠401Unauthorized

Modified at 2025-06-26 12:48:25

List mission rules

Get mission rule by ID