v1
latestOpenAPI 3.1.02026-07-26359254.7 MBCreate a task
<small>Requires the tasks:write scope (or a broader one that includes it).</small>
Creates a new task. The template body may contain handlebars variables (e.g. {{firstName}}) which are resolved when the task is read or executed.
Request body
Task type. Must be a valid enum value. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.
Task start time. Must be on or after 2015-01-01.
Task due time. Must be after startAt.
Contact (prospect) ID to associate with the task. Required for template variable rendering.
LinkedIn action subtype. Only applicable for LinkedIn tasks (taskType=linkedIn). Must be a valid enum value when provided. Possible values: message, connect, inMail, viewProfile.
Response
Task created successfully.
Task ID.
Associated contact (prospect) ID.
Task type. Possible values: toDo, call, meeting, linkedIn, manualEmail, sms, whatsApp.
Task status. Possible values: new, finished, cancelled, archived, sequenceDetached.
LinkedIn action subtype. Only present for LinkedIn tasks. Possible values: message, connect, inMail, viewProfile.
Sequence ID if this task was created by a sequence.
Sequence step ID. Available when the ExtendedFilterInTasks feature is enabled.
Human-readable sequence step name (e.g. "Step 2 - Email").
ID of the user this task is assigned to.
How the task was created. Possible values: user, sequence, meeting.
When the task was created.
Task start time. When isScheduled is true, this is the scheduled execution time.
Task due time.
When the task was completed. Null for active tasks.
Whether the task execution failed.
Whether the task is scheduled for automatic execution.