Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Tasks & Appointments

Create Task (V1)

Creates a task on the target lead.

Notes:

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

Headers

Authorizationstring required

Bearer [access_token]

Content-Typestring required

application/json

Request body

contentstring required

Description of the task.

leadIdinteger required

ID of the lead this task belongs to.

deadlineinteger required

Deadline of the task, in milliseconds since Unix epoch (UTC).

type'Other' | 'Call' | 'Email' | 'Text' required

Type of the task.

assignedRole'Agent' | 'Assistant' required

Role the task is assigned to.

finishFlagboolean

When true on update, the task is marked completed and other fields are ignored.

Example request

{
  "content": "Send an email to my lead",
  "leadId": 563172647619608,
  "deadline": 1508580010000,
  "type": "Call",
  "assignedRole": "Agent",
  "finishFlag": true
}

Response

Task created. Response contains the new task's ID.

taskIdinteger

ID of the newly created task.

Example response

{
  "taskId": 563172647619608
}