Sign in
tasks

Execute Task

Execute an actionable task (send a reply, approve a lead, log a call, etc.).

Requires the tasks:write scope on the API key.

post/v1/tasks/{task_id}/execute

Path parameters

task_idstring uuid required

ID of the task.

Request body

Response

Successful Response

idstring uuid required

Unique identifier.

organization_idstring uuid required

Workspace this task belongs to.

type'EMAIL_REPLY' | 'LINKEDIN_REPLY' | 'NEW_LEAD_REVIEW' | 'CALL' | 'PLAYBOOK_APPROVAL' | 'TODO' required
priority'HOT' | 'TODAY' | 'EXTRA' required
status'PENDING' | 'IN_PROGRESS' | 'COMPLETED' | 'SKIPPED' required
titlestring nullable

Task title for standalone tasks.

due_datestring date nullable

Due date for standalone tasks.

sequence_idstring uuid nullable required

Sequence run this task was projected from, if any.

assignee_user_idstring uuid nullable required

User the task is assigned to, if any.

disposition'ANSWERED' | 'VOICEMAIL_LEFT' | 'NO_ANSWER' | 'INTERESTED' | 'NOT_INTERESTED' | 'WRONG_NUMBER' required
reopened_atstring date-time nullable required

When the task was last reopened, if ever.

reopen_reason'REMINDER_RULE' required
snoozed_untilstring date-time nullable

When the task is snoozed until, if deferred.

skipped_atstring date-time nullable required

When the task was skipped, if applicable.

completed_atstring date-time nullable required

When the task was completed, if applicable.

created_atstring date-time required

When the task was created.

updated_atstring date-time required

When the task last changed.

Changes

Changed in 4 of the 12 revisions of this API.37

  • 80f4fd40b75e1See the full diff
    • ○

      added the optional property snoozed_until to the response with the 200 status

      response-optional-property-added

  • 2f1c56db78f811See the full diff
    • ●

      added the new WRONG_NUMBER enum value to the disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new WRONG_NUMBER enum value to the request property payload/oneOf[subschema #4: CallPayload]/disposition/anyOf[subschema #1: CallDisposition]/

      request-property-enum-value-added

  • 2bd7bb8e3a3724See the full diff
    • ●

      added the new INTERESTED enum value to the disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new NOT_INTERESTED enum value to the disposition/anyOf[subschema #1: CallDisposition]/ response property for the response status 200

      response-property-enum-value-added

    • ○

      added the new optional request property payload/oneOf[subschema #3: NewLeadReviewPayload]/exclusion

      new-optional-request-property

    • ○

      added the new optional request property payload/oneOf[subschema #4: CallPayload]/excludeLead

      new-optional-request-property

    • ○

      added the new INTERESTED enum value to the request property payload/oneOf[subschema #4: CallPayload]/disposition/anyOf[subschema #1: CallDisposition]/

      request-property-enum-value-added

    • ○

      added the new NOT_INTERESTED enum value to the request property payload/oneOf[subschema #4: CallPayload]/disposition/anyOf[subschema #1: CallDisposition]/

      request-property-enum-value-added

  • b390cd1c4e2a1See the full diff
    • ○

      endpoint added

      endpoint-added