v1

latestOpenAPI 3.1.02026-07-263788129.7 KB

Tasks

Update a Task

Updates an existing task by its task_id. Marking a task as DONE or CANCELLED sets completed_at; moving out of those states clears it. Updating account_id is only supported for manually created tasks.

patch/v1/tasks/{task_id}

Path parameters

task_idstring uuid required

Request body

titlestring nullable

Title of the task

descriptionstring nullable

Detailed description of the task

statusstring nullable

Current status of the task. One of TODO, DONE, CANCELLED.

account_idstring uuid nullable

ID of the account to associate the task with. Only supported for manually created tasks.

assignee_idstring uuid nullable

User ID to assign the task to

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",
  "status": "DONE",
  "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..."
    }
  }
}