Skip to main content
POST
Create a task

Authorizations

Authorization
string
header
required

OAuth 2.0 authorization code flow with PKCE (S256). See the authorization guide.

Scopes

tasks:write

Create, update and delete your tasks

Body

application/json
name
string
required
Required string length: 1 - 512
due_on
string<date-time>
required

With a time zone offset.

tag_ids
string<uuid>[]

Active same-firm tag ids. Requires the resource write scope, not tags:write. Omit to preserve, [] to clear; null is rejected. Replaces the entire tag set.

Maximum array length: 100
description
string | null

Markdown or plain text. HTML is rejected.

Maximum string length: 100000
priority
enum<string> | null
Available options:
low,
medium,
high
assignee_id
string<uuid> | null

A user from GET /users. Without one, the task has no assignee.

contact_ids
string<uuid>[]

Contacts the user can see, each once.

household_ids
string<uuid>[]

Households the user can see, each once.

Response

The created task.

is_external
boolean
required
read-only

True when this record has an active integration link, including an export from Vega. This is current linkage, not historical origin, and is independent of linked contacts or households. Associated records cannot be patched or deleted through this API, except that a meeting may patch reviewed alone. No provider/account details are exposed.

id
string<uuid>
required
name
string
required
status
string | null
required

One of the values of TaskStatus. A task synced from another CRM can carry another value, or none.

priority
string | null
required

low, medium or high, or null. A task synced from another CRM can carry another value.

due_on
string<date-time> | null
required

Null only for a task synced from another CRM without a due date.

completed_on
string<date-time> | null
required

When status was last set to completed. Null when the task is not completed.

assignee
object | null
required
contacts
object[]
required

The linked contacts the user can see.

households
object[]
required

The linked households the user can see.

created_on
string<date-time>
required
updated_on
string<date-time>
required
description
string | null
required

Markdown or plain text.

recurrence_rule
string | null
required

The repeating series rule (iCalendar RRULE), read-only. Partner changes still apply only to this task.

recurrence_id
string<uuid> | null
required

Identifies this task's repeating series, null for a non-repeating task.

workflow
object | null
required

The task's workflow, null when absent, deleted, or inaccessible to the connected user. Its stage is this task's stage, not necessarily the workflow's current stage.

owner
object | null
required
creator
object | null
required
tags
object[]
required