CRM
Update Task
Change some fields of a task (`status: done` completes it).
API key access
Needs the
crm:write scope with an API key (ro_pat_...). A signed-in session uses the caller's role.PATCH
/api/v1/tasks/{task_id}AuthorizationBearer <token>
Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Path Parameters
task_idstring
Format
uuidHeader Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
title?string | null
Length
1 <= length <= 300notes?string | null
Length
length <= 10000due_at?string | null
Format
date-timeowner_id?string | null
Format
uuidstatus?TaskStatus | null
lead_id?string | null
Format
uuidcompany_id?string | null
Format
uuiddeal_id?string | null
Format
uuidResponse Body
curl -X PATCH "http://localhost:8000/api/v1/tasks/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "X-Workspace-Id: string" \ -H "Content-Type: application/json" \ -d '{}'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"title": "string",
"notes": "string",
"due_at": "2019-08-24T14:15:22Z",
"owner_id": "8826ee2e-7933-4665-aef2-2393f84a0d05",
"owner_name": "string",
"status": "open",
"completed_at": "2019-08-24T14:15:22Z",
"source": "user",
"lead_id": "9bddab70-98e6-43a9-8f32-c9788b9de0c0",
"company_id": "b2e6a1c3-1a5e-44ae-a8fd-81f76fd715cf",
"deal_id": "2fa5b64f-5b72-4263-958e-07b76f41abe3",
"record_label": "string",
"created_by": "ee824cad-d7a6-4f48-87dc-e8461a9201c4",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}