Skip to main content
DELETE
Bulk-delete all matching contacts (async)

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Shared filter shape used by query-count, query-bulk-move, query-bulk-delete, and query-bulk-export. Either supply stageIds[] OR set orgWide: true. pipelineType selects whether the operation runs against the Contact or Application collection.

stageIds
string[]

One or more pipeline-stage IDs. Required unless orgWide is true.

pipelineType
enum<string>

Which collection to target. Defaults to Contact.

Available options:
Contact,
Application
orgWide
boolean

When true, ignore stageIds and run across the whole organization.

ownerFilter
string

Owner-based scope (e.g. owned, unowned) — same semantics as the Contacts list view.

advancedParams
object

Optional advanced filter object (same shape as the Contacts list view).

Response

Bulk delete job started

202 Accepted response — the delete runs in the background. Poll GET /api/contacts/bulk-job/{jobId} for progress.

jobId
string
required

UUID to use with GET /api/contacts/bulk-job/{jobId}.

message
string
required