Tasks

Complete a task

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

Marks a task as completed without execution (no email sent, no SMS sent). For tasks that require execution (sending), use the execute endpoint instead.

post/v3/tasks/{id}/complete

Request

Path parameters

idinteger required

Task ID.

Request body

callResolutioninteger nullable

Call resolution outcome. Only meaningful for Call tasks. Affects sequence branching. 0 = Positive, 1 = ToCall, 2 = Negative.

finishProspectInSequenceboolean

If true, also removes the prospect from the sequence. The finish reason is derived automatically from the task type (Call → Called, others → Manual).

Response

Task completed successfully. Returns the updated task.

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.

Changes

No recorded changes to this operation across all 1 revision of this API.