task_request

The writable fields of a task, shared by create and update.

namestringrequired

descriptionstring

notesstring

task_typestring

The key of a task type, not its id

Example: follow_up

statusstring

Possible values: [pending, in_progress, completed, cancelled]

prioritystring

Possible values: [low, medium, high]

due_atstring<date-time>

start_atstring<date-time>

reminder_atstring<date-time>

When to remind. Only the primary owner is reminded, never the co-owners.

recurrence_intervalinteger

How many units between repeats

recurrence_unitstring

Possible values: [day, week, month]

positioninteger

Order inside the stage, on a pipeline that accepts tasks

owner_idinteger

assignee_idsinteger[]

deal_idinteger

Attach the task to a deal. Leave it out for a task that stands on its own.

contact_idinteger

organization_idinteger

deal_pipeline_idinteger

deal_stage_idinteger

label_liststring[]

Replaces the task's labels

custom_fieldsobject

Merged into what the task already has, on update

checklist object[]

Array [

idstring

contentstring

completedboolean

]

task_request

{
  "name": "string",
  "description": "string",
  "notes": "string",
  "task_type": "follow_up",
  "status": "pending",
  "priority": "low",
  "due_at": "2024-07-29T15:51:28.071Z",
  "start_at": "2024-07-29T15:51:28.071Z",
  "reminder_at": "2024-07-29T15:51:28.071Z",
  "recurrence_interval": 0,
  "recurrence_unit": "day",
  "position": 0,
  "owner_id": 0,
  "assignee_ids": [
    0
  ],
  "deal_id": 0,
  "contact_id": 0,
  "organization_id": 0,
  "deal_pipeline_id": 0,
  "deal_stage_id": 0,
  "label_list": [
    "string"
  ],
  "custom_fields": {},
  "checklist": [
    {
      "id": "string",
      "content": "string",
      "completed": true
    }
  ]
}