Contacts
Delete a contact
Permanently remove a contact and its list memberships from your workspace.
DELETE
/api/v1/contacts/{contactId}On this page
Authentication
Send a RouteKite API key as a Bearer token. This endpoint requires the audience:write scope.
| Name | Type | Requirement | Description |
|---|---|---|---|
Authorization | string | Required | Bearer rk_ API key. The key determines the workspace. |
Idempotency-Key | string | Required | 8 to 200 characters. Reuse only when retrying the same operation with the same input. |
Path parameters
| Name | Type | Requirement | Description |
|---|---|---|---|
contactId | UUID | Required | ID of the contact in your workspace. |
Response
| Name | Type | Requirement | Description |
|---|---|---|---|
object | string | Always | Always deleted. |
id | UUID | Always | The deleted contact ID. |
deleted | boolean | Always | True when deletion succeeded. |
Choose the contact
Use the ID returned when listing or creating a contact. Deletion cannot be undone.
Writes and retries
The API key must have been created by a current workspace member. Use a unique Idempotency-Key for each intended write. Reuse it only when retrying the same operation with the same input.
Errors
| Status | Code | What it means | What to do |
|---|---|---|---|
| 400 | INVALID_REQUEST | One or more request fields are invalid. | Correct the request and retry. |
| 401 | UNAUTHORIZED | The API key is missing or invalid. | Send a valid Bearer API key. |
| 403 | FORBIDDEN | The key does not have the required scope. | Use a key with the scope shown above. |
| 429 | RATE_LIMITED | The API key or workspace has reached its request limit. | Wait for the Retry-After interval before retrying. |
| 503 | RATE_LIMIT_UNAVAILABLE | RouteKite could not check request limits. | Retry shortly. |
| 500 | INTERNAL_ERROR | RouteKite could not complete the contact operation. | Retry shortly. Reuse the same Idempotency-Key for write retries. |
| 400 | IDEMPOTENCY_KEY_REQUIRED | The write needs a stable idempotency key. | Send an Idempotency-Key of 8 to 200 characters. |
| 403 | API_KEY_ACTOR_UNAVAILABLE | The API key has no current workspace member as its creator. | Use a key created by a current member. |
| 409 | IDEMPOTENCY_CONFLICT | This idempotency key was used with different input. | Reuse the original input for a retry. Use a new key for a new write. |
| 409 | OPERATION_IN_PROGRESS | An identical write is already in progress. | Retry shortly with the same key and input. |
| 503 | OPERATION_UNAVAILABLE | RouteKite could not complete the write. | Retry with the same key and input. |
| 404 | CONTACT_NOT_FOUND | The contact does not exist in this workspace. | Check the ID using List contacts. |
| 409 | CONTACT_DELETE_FAILED | The contact could not be deleted. | Check whether the contact still exists before retrying. |