tasks/update_status

Endpoint#

Property	Value
Type	mutation
Method	POST
Path	/api/external/v1/tasks/update_status
Handler	OperatelyWeb.Api.Tasks.UpdateStatus

Authentication#

• Requires a valid API token.
• Requires a write-enabled token.
• Read-only tokens return 403.

Inputs#

Field	Type	Required	Nullable	Default
task_id	id primitive (encoded as string)	Yes	No	-
status	task_status object	Yes	Yes	-
type	task_type enum (space, project)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
task	task object	Yes	No
updated_milestone	milestone object	Yes	Yes

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/tasks/update_status" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"status":{"closed":true, "color":"gray", "id":"value", "index":123, "label":"value", "value":"value"}, "task_id":"value", "type":"space"}'

Response Example#

{
  "task": {
    "assignees": [
      "<person>"
    ],
    "available_statuses": [
      "<task_status>"
    ],
    "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>",
    "size": "value",
    "space": "<space>",
    "status": "<task_status>",
    "subscription_list": "<subscription_list>",
    "type": "space",
    "updated_at": "2026-01-01"
  },
  "updated_milestone": {
    "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"
  }
}