latestOpenAPI 3.1.02026-08-18104219248.1 KB

ad6ac1d13526

contacts

Unenroll Contacts

Remove contacts from outreach entirely.

Every non-finished sequence of each contact is marked failed and manually stopped — including leads still waiting for approval — and the contact is excluded from all outreach for three months. Scope it to one template with sequence_template_id.

This is not POST /v1/sequences/{sequence_id}/stop: that closes one enrollment with an outcome (won or lost) and leaves the contact reachable.

Requires the sequences:write scope on the API key.

post/v1/contacts/unenroll

Request body

contact_idsstring[] required

Contacts to unenroll from every non-finished sequence.

sequence_template_idstring uuid nullable

Only stop sequences built from this template. Omit to stop every non-finished sequence.

Response

Successful Response

stopped_sequence_idsstring[] required

Sequences that were stopped.

stopped_countinteger required

How many sequences were stopped.