# Delete contacts from a list

Source: https://kirora.io/docs/api/reference/deleteListContacts

`POST /v1/lists/{id}/contacts/delete`

Requires an API key with the `lists:write` scope. [About keys and scopes](https://kirora.io/docs/api/reference/authentication)

Works with integration and partner keys, not agent keys.

Safe to retry: a repeat sets the same values again. [About idempotency](https://kirora.io/docs/api/reference/idempotency)

Takes up to 500 contacts out of a list in one batch, named by exactly one of `contactIds`, `externalIds` or `emails`: a POST, since some clients and proxies drop the body of a DELETE. The contacts themselves are kept. Contacts that were not members are ignored; the response reports how many were actually taken out, and lists in `notFound` the identifiers that name no contact in this workspace. Agent keys are refused with 403 `AGENT_KEY_REFUSED`.

## Path parameters

- `id` (string, required, uuid) — The list's id.

## Header parameters

- `Kirora-Workspace` (string, optional, pattern `^[A-Za-z0-9._:-]{1,128}$`) — Partner keys only: the child workspace to act in, by the external id the partner gave it. Without it, a partner key acts in its own workspace. Any other key that sends it is refused with 403, and an unknown workspace is 404.
- `Idempotency-Key` (string, optional, 8–255 characters) — Makes a retry safe: a repeat with the same key and body within 24 hours gets the first response again, with `Idempotency-Replay: true`. The same key with another request is 409 `IDEMPOTENCY_KEY_REUSED`; while the first is still running, 409 `IDEMPOTENCY_KEY_IN_USE`; after an `unsafe` first request failed or never returned, 409 `IDEMPOTENCY_KEY_OUTCOME_UNKNOWN`. Use a new key, such as a UUID, for each new request.

## Request body

- Any of: **By contact ids**
  - `contactIds` (string[], required, at least 1 item, at most 500 items) — Kirora's ids for the contacts.
- Any of: **By external ids**
  - `externalIds` (string[], required, at least 1 item, at most 500 items) — Your own ids for the contacts, as set with identify.
- Any of: **By emails**
  - `emails` (string[], required, at least 1 item, at most 500 items) — Email addresses, matched trimmed and without case.

## Returns

Returns `200 OK` with a `DeletedListContacts` in `data`. It can also return `409 Conflict`, `413 Payload Too Large` or `415 Unsupported Media Type`; see the statuses below. Otherwise returns an error; [Errors](https://kirora.io/docs/api/reference/errors) lists every code and which to retry.

- `deletedCount` (integer, required, min 0) — Contacts taken out of the list.
- `notFound` (string[], required) — Identifiers as sent (emails normalised) that name no contact in the workspace.

Statuses:

- `200 OK`: How many contacts were taken out, and the identifiers that matched none.
- `409 Conflict`: The request conflicts with current state — a duplicate unique value, or a resource whose status does not allow this operation.
- `413 Payload Too Large`: The body is larger than this operation accepts (`PAYLOAD_TOO_LARGE`).
- `415 Unsupported Media Type`: The body is not JSON, or not the upload the operation takes (`UNSUPPORTED_MEDIA_TYPE`).

Headers on `200 OK`:

- `Idempotency-Replay` (string, optional, one of `true`) — `true` when this is the stored response to an earlier request with the same key.

## Example: Take contacts out by your own id

```bash
curl -X POST https://api.kirora.io/v1/lists/018f2a4e-6b1c-7d3e-9f40-37386ae05a6b/contacts/delete \
  -H "Authorization: Bearer $KIRORA_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalIds": [
      "customer-4821"
    ]
  }'
```

Response `200`:

```json
{
  "data": {
    "deletedCount": 1,
    "notFound": []
  }
}
```