v1

latestOpenAPI 3.1.02026-07-26359254.7 MB
Contacts

Bulk delete contacts

<small>Requires the contacts:write scope (or a broader one that includes it).</small>

Use this endpoint when you need to remove several contacts in a single call. Contacts are processed independently: the response maps each contact id that could not be deleted to the reason it was skipped.

post/v3/contacts/bulk-delete

Request body

idsinteger[] required

List of contact IDs to delete

Response

Non-atomic result. The response body is a dictionary keyed by contact id listing per-item failures. Empty object {} means all contacts were deleted successfully.

Per-item failures use the ContactError enum. Common per-item slugs:

SlugMeaning
notFoundContact does not exist, or is not visible to the caller
forbiddenCaller is not allowed to delete this contact
object required

Dictionary of per-item failures keyed by contact id. Empty object {} means all succeeded.