Sign in

v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Tasks

Execute and complete a task

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

Executes the task action (sends email or SMS) and completes it. Only ManualEmail (7) and Sms (8) task types support execution. Other task types return 400 — use the complete endpoint for those.

post/v3/tasks/{id}/execute

Path parameters

idinteger required

Task ID.

Request body

emailAccountIdinteger nullable

Email account to send from. Only for non-sequence ManualEmail tasks. If omitted, the user's default email account is used. Ignored for sequence tasks (account resolved from sequence configuration).

Response

Task executed and 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.