Sign in

v1

latestOpenAPI 3.0.12026-07-22120163333.7 KB
Tasks & Appointments

Update Task (V1)

Partially updates an existing task. Fields not supplied are left unchanged.

Notes:

  • When finishFlag is true, the task is marked completed and all other fields are ignored. Completion is rejected for smart-plan tasks (TASK_IS_SMARTPLAN).
  • When leadId is supplied, it must match the task's existing lead; otherwise 400 INVALID_UPDATE_OPERATION_LEADID.
  • At least one field must be supplied; an entirely empty payload returns 400 MISSING_PARAMETER.
  • Caller must have manage permission on the task's lead.
  • The response body is empty.
put/v1.0/tasks/{taskId}

Path parameters

taskIdinteger required

ID of the task to update.

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 updated successfully. No response body.