Tasks API: Create
Endpoint#
Section titled “Endpoint#”| Property | Value |
|---|---|
| Type | mutation |
| Method | POST |
| Path | /api/external/v1/tasks/create |
| Handler | OperatelyWeb.Api.Tasks.Create |
Authentication#
Section titled “Authentication#”- Requires a valid API token.
- Requires a write-enabled token.
- Read-only tokens return
403.
| Field | Type | Required | Nullable | Default |
|---|---|---|---|---|
type | task_type enum (space, project) | Yes | No | - |
id | id primitive (encoded as string) | Yes | No | - |
milestone_id | id primitive (encoded as string) | No | Yes | - |
name | string | Yes | No | - |
assignee_id | id primitive (encoded as string) | No | Yes | - |
assignee_ids | array of id primitive (encoded as string) | No | Yes | - |
description | json primitive (encoded as string) | No | Yes | - |
due_date | contextual_date object | Yes | Yes | - |
status | task_status object | No | No | - |
Outputs#
Section titled “Outputs#”| Field | Type | Required | Nullable |
|---|---|---|---|
task | task object | Yes | No |
updated_milestone | milestone object | No | No |
updated_space | space object | No | No |
cURL Example#
Section titled “cURL Example#”Copied
curl --request POST \
--url "https://app.operately.com/api/external/v1/tasks/create" \
--header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
--header "Content-Type: application/json" \
--data '{"assignee_id":"value", "assignee_ids":["value"], "description":"value", "due_date":{"__typename":"value", "date":"2026-01-01", "date_type":"day", "value":"value"}, "id":"value", "milestone_id":"value", "name":"value", "status":{"__typename":"value", "closed":true, "color":"gray", "id":"value", "index":123, "label":"value", "value":"value"}, "type":"space"}'Response Example#
Section titled “Response Example#”{ "task": { "__typename": "value", "assignees": [ "<person>" ], "available_statuses": [ "<task_status>" ], "closed_at": "2026-01-01T09:30:00Z", "comments_count": 123, "creator": "<person>", "description": "value", "due_date": "<contextual_date>", "id": "value", "inserted_at": "2026-01-01", "milestone": "<milestone>", "name": "value", "permissions": "<project_permissions>", "priority": "value", "project": "<project>", "project_space": "<space>", "reminders": [ "<task_reminder>" ], "size": "value", "space": "<space>", "status": "<task_status>", "subscription_list": "<subscription_list>", "type": "space", "updated_at": "2026-01-01", "url": "value" }, "updated_milestone": { "__typename": "value", "available_statuses": [ "<task_status>" ], "comments": [ "<milestone_comment>" ], "comments_count": 123, "completed_at": "2026-01-01", "creator": "<person>", "description": "value", "id": "value", "inserted_at": "2026-01-01", "permissions": "<project_permissions>", "project": "<project>", "space": "<space>", "status": "pending", "subscription_list": "<subscription_list>", "tasks_kanban_state": "value", "tasks_ordering_state": [ "value" ], "timeframe": "<timeframe>", "title": "value", "url": "value" }, "updated_space": { "__typename": "value", "access_levels": "<access_levels>", "color": "value", "icon": "value", "id": "value", "is_company_space": true, "is_member": true, "members": [ "<person>" ], "mission": "value", "name": "value", "notifications": [ "<notification>" ], "permissions": "<space_permissions>", "potential_subscribers": [ "<subscriber>" ], "private_space": true, "task_statuses": [ "<task_status>" ], "tasks_kanban_state": "value", "url": "value" }}