Skip to main content

ReferenceTasks

Tasks

Record tasks. PATCH completed closes or reopens.

POST/api/v1/tasks

List and create require one parent (contact_id, company_id or deal_id). PATCH "completed": true completes. "completed": false reopens.

HTTPPathScope
GET/api/v1/tasksrest.crm.tasks.read
POST/api/v1/tasksrest.crm.tasks.write
GET/api/v1/tasks/{id}rest.crm.tasks.read
PATCH/api/v1/tasks/{id}rest.crm.tasks.write

Query

ParameterTypeNotes
contact_id | company_id | deal_idUUIDExactly one on list/create.
limit / cursornumber / stringCursor page.

Fields

FieldTypeNotes
idUUIDImmutable.
titlestringRequired on create.
bodystring | nullOptional.
completedbooleanPATCH true completes. false reopens.
due_atdatetime | nullISO-8601.
contact_id / company_id / deal_idUUID | nullParent.