Skip to main content
DELETE
Delete Clients

Authorizations

Authorization
string
header
required

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

Body

application/json

Submit the client_id values to delete. Unknown fields return HTTP 400 with invalid_request.

client_ids
string[]
required

The firm's client identifiers, the client_id values used in v2 upserts. Not client labels or Harvey client UUIDs. Surrounding whitespace is trimmed.

Required array length: 1 - 10000 elements

Response

Per-identifier results for the submitted clients.

Every identifier in the request has one result. Within each array, results keep the order of the request.

deleted
object[]
required

Clients deleted by this request.

already_absent
object[]
required

Missing or already-deleted clients. These are successful results. A repeated request returns a deleted client here.

errors
object[]
required