Skip to main content
POST
Create a Task

Body

application/json

Request body for creating a task via POST.

title
string
required

Title of the task

Example:

"Send follow-up proposal"

description
string | null

Detailed description of the task

Example:

"Send the updated pricing proposal to the procurement team"

account_id
string<uuid> | null

ID of the account to associate the task with

opportunity_id
string<uuid> | null

ID of the opportunity to associate the task with

task_type
string | null
default:GENERAL_ACTION_ITEM

Type of task. One of GENERAL_ACTION_ITEM, EMAIL.

Example:

"GENERAL_ACTION_ITEM"

assignee_id
string<uuid> | null

User ID to assign the task to. Defaults to the caller if not provided.

due_at
string<date-time> | null

Due date and time for the task

Example:

"2025-07-01T17:00:00Z"

message_draft
MessageDraft · object | null

Optional draft message contents. Only valid when task_type is EMAIL.

Response

Successful Response

data
TaskResponse · object
required
meta
ResponseMeta · object