Skip to main content
POST
Skip tasks in bulk
Passes on up to 500 tasks in one call, for example when an account moves to a partner.

Handling the response

Each task is skipped on its own, so one bad id never fails the batch. failed lists what did not happen, and why.
There is no bulk complete. Completing a manual_email task sends a real email, so tasks are completed one at a time with Complete a task.

Good to know

  • Skipping a sequence task moves its enrollment to the next step. To stop contacting the prospect, finish the enrollment instead.
  • held tasks, and tasks whose enrollment is no longer active, are refused and listed in failed.
  • Replaying the request without an Idempotency-Key lists the already-skipped tasks in failed.

Authorizations

x-api-key
string
header
required

Team-scoped API key generated in the Salesfinity dashboard under Settings → Connections → API & Webhooks. A missing or invalid key returns HTTP 403.

Headers

Idempotency-Key
string

Makes this write safe to retry. Send a unique value, such as a UUID, and send the same value again when you retry the same request. A retry with the same key and the same request (method, path including the query string, and JSON body) returns the original successful response without acting twice. The same key with a different body or path returns 409, and so does a retry while the first request is still running; that one is safe to repeat after a moment. A request that fails frees its key, so a retry runs the write again: after a 5xx on a create, confirm with a GET before retrying. Keys are kept for 24 hours and are scoped to your team.

Body

application/json
user_id
string
required

The team member this call acts as. Must be an active member of the team the API key belongs to.

Example:

"507f1f77bcf86cd799439011"

ids
string[]
required

Task ids, 1 to 500. Each is processed on its own, and a failure is returned in failed.

Maximum array length: 500
reason
string

Why the tasks were skipped. Recorded on each timeline.

Maximum string length: 200

Response

How many tasks were skipped, and which were not.

Per-task outcome of a bulk action.

ok
integer
required

Tasks the action succeeded on.

failed
object[]
required

Tasks it did not, each with the reason the single-task operation gave.