The request
Reference for Delete client, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.
POST /api/v1/commands/delete-client
The key needs the Jobs area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.
It runs the app's own command delete-client. Send an Idempotency-Key header with every call: the same key with the same body returns the first answer and runs nothing twice. See the model.
Parameters
| Name | Kind | Required | Description | Example |
|---|---|---|---|---|
client_id | id, in the JSON body | Yes | From List clients. | cli_9c40 |
Try it with your key
Paste your key and change the values. The box builds the call as a cURL line and a fetch line, ready to copy. It never sends anything itself.
Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.
What comes back
accepted, client_id, jobs_detached (how many jobs lost this person), addresses_detached, scrubbed and position. scrubbed is true when the client had jobs: the row is kept as "Deleted client" with no phone or email, because every job needs a client. A client with no jobs is removed outright.
It never deletes anything. It changes only what the command names, and it writes the change to the job's history with who asked for it.
Every field in the answer
Types are read from the example answer. Money is a plain number in the company's currency. A time carries its offset from UTC (Z is UTC). Ids are opaque text. A field with no line of its own here has its name spelled out; the common fields mean the same on every page.
| Field | Type | Meaning |
|---|---|---|
accepted | true or false | True when the command ran. A command that cannot run is an error instead. |
client_id | id (text) | The id of the client. |
jobs_detached | whole number | The jobs detached. |
addresses_detached | whole number | The addresses detached. |
scrubbed | true or false | The scrubbed. |
position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
Needs every company
The client book is the whole workspace's, not one company's. A credential that reaches only some companies is refused with no_access, so it can never read or change a person who also belongs to a company it cannot see.
Erasing
This is the right to be forgotten, kept. The name, phone and email are gone for good, from the book and from the history of the client. The jobs and their money stay as business facts. Ask the person to confirm before you send it.
Errors that apply
| Code | Status | What it means |
|---|---|---|
| `missing_key` | 401 | Send your key as Authorization: Bearer hh_live_... |
| `unknown_key` | 401 | That key is not one we issued, or it was revoked. |
| `no_access` | 403 | This credential does not reach that. Ask the person who made it for access. |
| `read_only` | 403 | This credential may read this area but not change it. |
| `not_found` | 404 | No such record in the companies this credential reaches. |
| `invalid` | 422 | Some fields were refused. See fields. |
| `missing_idempotency_key` | 400 | Send an Idempotency-Key header on every command. |
| `idempotency_mismatch` | 409 | This Idempotency-Key was used with a different body. |
| `idempotency_in_progress` | 409 | A command with this Idempotency-Key is still running. Wait a moment and send it again. |
| `no_credits` | 402 | Out of credits. Top up on Settings › Credits, or turn on auto top-up. |
Related
- Create client: Add a client to the book before they have a job. One phone number is one client.
- Update client: Correct a client's name, phones or email. Only the fields you send change.
- The same records in the app: the Jobs panel.
- How the API fits together: the model, API keys, errors and the MCP server.