Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Tasks

Update a task

<small>Requires the tasks:write scope (or a broader one that includes it).</small>

Full replacement update of a task. Only tasks with status New (0) can be updated. Sequence task type and contact cannot be changed.

put/v3/tasks/{id}

Path parameters

idinteger required

Task ID.

Request body

taskType'toDo' | 'call' | 'meeting' | 'linkedIn' | 'manualEmail' | 'sms' | 'whatsApp' required

Task type. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.

startAtstring date-time required

Task start time. Must be on or after 2015-01-01.

dueTostring date-time required

Task due time. Must be after startAt.

contactIdinteger nullable

Contact (prospect) ID. Cannot be changed for sequence-created tasks.

linkedInTaskType'message' | 'connect' | 'inMail' | 'viewProfile' nullable

LinkedIn action subtype. Only for LinkedIn tasks. Possible values: message, connect, inMail, viewProfile.

Response

Task updated successfully.

idinteger

Task ID.

contactIdinteger nullable

Associated contact (prospect) ID.

taskType'toDo' | 'call' | 'meeting' | 'linkedIn' | 'manualEmail' | 'sms' | 'whatsApp'

Task type. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.

status'new' | 'finished' | 'cancelled' | 'archived' | 'sequenceDetached'

Task status. Possible values: new, finished, cancelled, archived, sequenceDetached.

linkedInTaskType'message' | 'connect' | 'inMail' | 'viewProfile' nullable

LinkedIn action subtype. Only present for LinkedIn tasks. Possible values: message, connect, inMail, viewProfile.

sequenceIdinteger nullable

Sequence ID if this task was created by a sequence.

sequenceStepIdinteger nullable

Sequence step ID. Available when the ExtendedFilterInTasks feature is enabled.

sequenceStepDisplayNamestring nullable

Human-readable sequence step name (e.g. "Step 2 - Email").

assignedUserIdinteger

ID of the user this task is assigned to.

creationSource'user' | 'sequence' | 'meeting'

How the task was created. Possible values: user, sequence, meeting.

createdAtstring date-time

When the task was created.

startAtstring date-time

Task start time. When isScheduled is true, this is the scheduled execution time.

dueTostring date-time

Task due time.

finishedAtstring date-time nullable

When the task was completed. Null for active tasks.

isFailedboolean

Whether the task execution failed.

isScheduledboolean

Whether the task is scheduled for automatic execution.