tasks/update_description

Endpoint#

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

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	-
description	json primitive (encoded as string)	Yes	No	-
type	task_type enum (space, project)	Yes	No	-

Outputs#

Field	Type	Required	Nullable
task	task object	Yes	No

cURL Example#

Copied

curl --request POST \
  --url "https://app.operately.com/api/external/v1/tasks/update_description" \
  --header "Authorization: Bearer ${OPERATELY_API_TOKEN}" \
  --header "Content-Type: application/json" \
  --data '{"description":"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"
  }
}