v1

latestOpenAPI 3.1.02026-07-247601.0 MB
Tasks

Skip a Task

This endpoint doesn't consume Apollo credits. Learn more about API pricing and credits.

<a href="https://knowledge.apollo.io/hc/en-us/articles/28705458602125-Tasks-Overview" target="_blank">Tasks</a> let you track, prioritize, and help you complete actions required for your outbound sales motion.<br><br>Use the Skip a Task endpoint to mark an existing task as skipped without completing it.<br><br>To find task IDs, use the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the id value for the task you want to skip.<br><br>If the task no longer exists (for example, because the sequence it belonged to was paused and the task was removed), Apollo returns a 200 response with deleted: true on the task instead of an error.<br><br>To mark a task as done instead of skipping it, use the <a href="https://docs.apollo.io/reference/complete-a-task">Complete a Task endpoint</a>.

post/tasks/{id}/skip

Path parameters

idstring required

The Apollo ID for the task. <br><br>To find task IDs, call the <a href="https://docs.apollo.io/reference/search-tasks">Search for Tasks endpoint</a> and identify the id value for the task. <br><br>Example: 67a1b2c3d4e5f60001234567

Request body

notestring

An optional note to record when skipping the task. <br><br>Example: No longer a good fit, moving to a different sequence.

on_task_pageboolean

Whether to reindex the task synchronously so the change is immediately reflected in search results. <br><br>Defaults to false (indexed asynchronously).

Response

200

Example response

{
  "task": {
    "id": "67a1b2c3d4e5f60001234567",
    "status": "skipped"
  }
}