Create assignment

POST

/assignments

Assignments

Creates a new assignment for a user. Requires targetId, userId, and timeframe configuration.

Request

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Assignment created successfully

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

🟠409

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://api.aworld.cloud/dashboard/v1/assignments' \
--header 'Content-Type: application/json' \
--data '{
    "targetType": "survey",
    "targetId": "FUMzPf00hz_kcj2R2Hlzq",
    "userId": "string",
    "startsAt": "2019-08-24T14:15:22.123Z",
    "endsAt": "2019-08-24T14:15:22.123Z",
    "visibility": "LOCKED",
    "groupId": "string",
    "priority": 0,
    "timeframeType": "RANGE",
    "assignmentType": "REQUIRED"
}'

Response Example

{
    "assignmentId": "FUMzPf00hz_kcj2R2Hlzq",
    "targetType": "survey",
    "targetId": "FUMzPf00hz_kcj2R2Hlzq",
    "userId": "string",
    "assignmentRuleId": "FUMzPf00hz_kcj2R2Hlzq",
    "contributingRuleIds": [
        "FUMzPf00hz_kcj2R2Hlzq"
    ],
    "groupId": "string",
    "periodId": "string",
    "timeframeType": "PERMANENT",
    "startsAt": "2019-08-24T14:15:22.123Z",
    "endsAt": "2019-08-24T14:15:22.123Z",
    "state": "PENDING",
    "visibility": "LOCKED",
    "assignmentType": "REQUIRED",
    "priority": 0,
    "unlockedAt": "2019-08-24T14:15:22.123Z",
    "unlockedByRuleId": "FUMzPf00hz_kcj2R2Hlzq",
    "currentAttempt": 1,
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z"
}

Modified at 2026-09-28 10:12:52

List assignments

Delete assignments (bulk)