Skip to main content
POST
Un-enrol a contact
This is how you remove someone from a sequence. There is no DELETE — an enrollment is a record of what happened, so it is finished rather than destroyed and its timeline survives. Once finished, the contact can be enrolled in the same sequence again.

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

id
string
required

24-character enrollment id.

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"

note
string

Recorded against the approval decision.

Response

Success.

The outcome of an action. Shape varies by endpoint — for example enable returns the sequence and how many enrollments it activated, and a bulk verb returns how many rows it moved.