Contacts

Delete many contacts

Delete up to 100 contacts in one request, the same way deleting contacts in the Common Room app does. The ids parameter is required; this endpoint never deletes all contacts. Every ID is validated before anything is deleted, and an error names every offending ID. A merged contact ID deletes the contact it was merged into. Contacts that are already deleted are skipped, so a request can be retried as a whole. Contacts who can log in to the workspace cannot be deleted. This is not a privacy erasure; for right-to-be-forgotten requests use POST /right-to-be-forgotten-requests. Requires the contacts:write scope and a role that can delete contacts.

delete/contacts

Request

Query parameters

idsstring required

Comma-separated list of 1 to 100 prefixed contact IDs (format c_<number>). Duplicates are ignored.

Response

The contacts were deleted

successtrue required

Changes

No recorded changes to this operation across all 1 revision of this API.