Skip to main content
POST
Cancel an enrolment run
Stops the run adding anyone else. It is not an undo — whoever is already enrolled stays enrolled. Finish them individually to reverse it.

Authorizations

x-api-key
string
header
required

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

Path Parameters

run_id
string
required

Run id, e.g. enroll_1a2b3c4d.

Body

application/json

Optional body. A cancellation is recorded against the team rather than a person, so user_id is accepted but not required here — unlike every other write on this API.

user_id
string

The team member this call acts as. Optional for this operation.

Example:

"507f1f77bcf86cd799439011"

Response

Success.

A background enrolment.

run_id
string
Example:

"enroll_1a2b3c4d"

status
enum<string>
Available options:
queued,
fetching,
running,
completed,
failed,
cancelled
sequence
string

24-character hexadecimal id.

Example:

"507f1f77bcf86cd799439011"

total
integer
processed
integer
enrolled
integer
skipped_count
integer
held_count
integer
truncated
boolean
sample_skipped
object[]

A sample of refusals with reasons.

error
string | null
finished_at
string<date-time> | null