Skip to main content
POST
Delete people in batch
This action is not reversible. When removing a person from the workspace, all of their information is deleted, including their custom field values, notes, and any associations with groups, companies, and other entities.
Each person is deleted on its own, and the response gives the outcome of every record. See batch requests for the 100-record limit and how to read the response. A person designated by several records, by the same ID or through the ID of a person merged into it, is deleted once, and each of those records reports it as deleted.

Authorizations

Authorization
string
header
required

API key for authentication

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes retrying this request safe: a retry with the same key and body returns the original response without running the operation again. Keys are kept for 24 hours after the request completes.

Maximum string length: 255
Example:

"8e03978e-40d5-43e8-bc93-6894a57f9324"

Body

application/json
records
object[]
required
Maximum array length: 100

Response

The outcome of each record, with the ID of each deleted person.

data
object
required
Example:
deprecations
string[]
Example: