The request
Reference for Create client, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.
POST /api/v1/commands/create-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 create-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 |
|---|---|---|---|---|
name | text, in the JSON body | Yes | At least 2 characters. | R. Azoulay |
phone | text, in the JSON body | Yes | Any format; stored as E.164. Must not belong to another client. | +12175550142 |
secondary_phone | text, in the JSON body | No | A second phone. Optional. | +12175550199 |
email | text, in the JSON body | No | Optional. | r.azoulay@example.com |
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, name and position: the event position, usable as after= on the next read so you see your own write. A phone that another client already holds is refused with 422 naming the field, so sending it twice adds one client.
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. |
position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
name | text | The name, as the app shows it. |
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.
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. |
| `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
- Update client: Correct a client's name, phones or email. Only the fields you send change.
- Delete client: Erase a person from the book. Their jobs stay, but lose the name and phone. It cannot be undone.
- The same records in the app: the Jobs panel.
- How the API fits together: the model, API keys, errors and the MCP server.