Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Tasks & Appointments V2

Create Task

Creates a new task or appointment on the target lead. Whether an appointment or a regular task is created depends on the payload's type field.

Notes:

  • content, assignedRole, leadId and endAt are required.
  • Caller must have manage permission on the lead.
  • The response contains only the new entry's ID under the 'taskId' key.
post/v2.0/tasks

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

contentstring

Description of the task

leadIdinteger

The ID of the lead this task is related to

typestring required

The type of the task. Could be Other, Call, Email, Text, Appointment

assignedRolestring

Role the task should be assigned to (Agent or Assistant)

startAtstring

When this task/appointment should start. ISO8601 format in specified timezone, e.g., '2026-03-01T15:00:00-08:00'

endAtstring

When this task/appointment should end. ISO8601 format in specified timezone, e.g., '2026-03-01T16:00:00-08:00'. For regular tasks, this represents the deadline

timeZoneCodestring

Timezone code for this task/appointment

addressstring

Address/location for appointment type tasks

Example request

{
  "content": "Send an email to my lead",
  "leadId": 563172647619608,
  "type": "Call",
  "assignedRole": "Agent",
  "startAt": "2026-03-01T15:00:00-08:00",
  "endAt": "2026-03-01T16:00:00-08:00",
  "timeZoneCode": "America/Los_Angeles",
  "address": "123 Main St, Los Angeles, CA"
}

Response

Task or appointment created. Response contains the new entry's ID.

taskIdinteger

ID of the newly created task or appointment.

Example response

{
  "taskId": 563172647619608
}