Skip to main content
POST
Delete audience contacts
Use this endpoint to soft-delete one or more contacts by contact ID.

Endpoint

POST /audience/delete-contacts Content-Type: application/json Authentication: Required (workspace auth)

Request Body

Response

Behavior

  • Soft delete — sets the contact’s status to deleted; records are not removed from the database.
  • Scoped to the caller’s company and workspace only — no audience_id is needed, and contact IDs outside the caller’s scope, or already deleted, are silently skipped.
  • Every audience whose contacts were affected has its denormalized contact count resynced.
  • Any pending dial rows for the deleted contacts are halted immediately (they will not be called even if already queued).

Error Cases

Example cURL

Headers

token
string
required

API token for authentication

Body

application/json
contact_id

Contact ID(s) to delete. Accepts a single ID, an array, a JSON-string array, or a comma-separated string.

contact_ids

Alias for contact_id. Either field is accepted.

Response

Contacts deleted successfully

message
string
data
object