Sign in

v1

latestOpenAPI 3.1.02026-07-263788129.7 KB
Tasks

Create a Task

Creates a new task.

Tasks can be associated with an account (via account_id) and/or an opportunity (via opportunity_id). If no assignee_id is provided, the task is assigned to the caller.

post/v1/tasks/

Request body

titlestring required

Title of the task

descriptionstring nullable

Detailed description of the task

account_idstring uuid nullable

ID of the account to associate the task with

opportunity_idstring uuid nullable

ID of the opportunity to associate the task with

task_typestring nullable

Type of task. One of GENERAL_ACTION_ITEM, EMAIL.

assignee_idstring uuid nullable

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

due_atstring date-time nullable

Due date and time for the task

Example request

{
  "title": "Send follow-up proposal",
  "description": "Send the updated pricing proposal to the procurement team",
  "task_type": "GENERAL_ACTION_ITEM",
  "due_at": "2025-07-01T17:00:00Z",
  "message_draft": {
    "recipients": [
      {
        "name": "Jane Smith",
        "email": "jane@acme.com"
      }
    ],
    "cc": [
      {
        "name": "Jane Smith",
        "email": "jane@acme.com"
      }
    ],
    "subject": "Pricing follow-up",
    "body": "Hi Jane, following up on the proposal we discussed..."
  }
}

Response

Successful Response

Example response

{
  "data": {
    "id": "tsk_abc123",
    "account_id": "acc_def456",
    "opportunity_id": "opp_ghi789",
    "title": "Send follow-up proposal",
    "description": "Send the updated pricing proposal to the procurement team",
    "task_type": "General Action Item",
    "assignee": {
      "id": "usr_abc123",
      "first_name": "Jane",
      "last_name": "Smith"
    },
    "status": "To Do",
    "due_at": "2025-07-01T17:00:00Z",
    "completed_at": "2025-06-28T11:00:00Z",
    "created_at": "2025-06-15T10:30:00Z",
    "updated_at": "2025-06-16T10:30:00Z",
    "message_draft": {
      "recipients": [
        {
          "name": "Jane Smith",
          "email": "jane@acme.com"
        }
      ],
      "cc": [
        {
          "name": "Jane Smith",
          "email": "jane@acme.com"
        }
      ],
      "subject": "Pricing follow-up",
      "body": "Hi Jane, following up on the proposal we discussed..."
    }
  }
}