Tasks

Create a task

Create a new task

post/v1/tasks

Headers

Idempotency-Keystring

Unique key to ensure idempotent request handling. If a request with the same key was already processed, the original response will be returned.

Request body

book_idstring required

The book ID

titlestring required

Task title

descriptionstring

Task description

deadline_atstring date-time

Deadline for the task

all_dayboolean

Whether this is an all-day task

status'todo' | 'done'

Task status

priority'low_priority' | 'medium_priority' | 'high_priority' | 'urgent_priority'

Task priority

is_privateboolean

When true, only the creator, assignee (or members of the assigned team), and collaborators can see this task. Defaults to false.

household_idstring

Associate task with a household (mutually exclusive with contact_id and business_id)

contact_idstring

Associate task with a contact (mutually exclusive with household_id and business_id)

business_idstring

Associate task with a business (mutually exclusive with household_id and contact_id)

assigned_to_idstring

User ID from the relevant book users list to assign the task to

assigned_team_idstring

Team ID to assign the task to (mutually exclusive with assigned_to_id)

tag_idsstring[]

Label IDs to apply to the task

Example request

{
  "book_id": "abc123xyz",
  "title": "Follow up with client",
  "description": "Call to discuss portfolio",
  "deadline_at": "2024-12-31T23:59:59Z"
}

Response

task created

idstring required

The task ID

titlestring required

Task title

descriptionstring nullable

Task description

deadline_atstring date-time nullable

Deadline for the task

all_dayboolean required

Whether this is an all-day task

status'todo' | 'done' required

Task status

priority'low_priority' | 'medium_priority' | 'high_priority' | 'urgent_priority' nullable

Task priority

is_privateboolean

When true, only the creator, assignee (or members of the assigned team), and collaborators can see this task. Use for sensitive tasks like HR or payroll.

completed_atstring date-time nullable

When the task was completed

created_atstring date-time required

When the task was created

updated_atstring date-time required

When the task was last updated

Example response

{
  "id": "abc123xyz",
  "title": "Follow up with client"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.