The request
Reference for Create lead, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.
POST /api/v1/commands/create-lead
The key needs the Leads area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.
It runs the app's own command create-lead. 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 |
|---|---|---|---|---|
company_id | id, in the JSON body | Yes | From Who am I. | cmp_14f5 |
client_name | text, in the JSON body | No | The customer, as they gave it. | R. Azoulay |
client_phone | text, in the JSON body | No | Any format; stored as E.164. | +12175550142 |
address | object, in the JSON body | No | line1, city, state and postal_code, all four. line2 is optional. | {"line1": "2590 Main St", "city": "Bloomington", "state": "IL", "postal_code": "61701"} |
job_type_id | id, in the JSON body | No | The service asked for, from Who am I. | jt_02 |
wanted_start | datetime, in the JSON body | No | ISO 8601. When they want it, with wanted_end. | 2026-10-30T09:00:00-05:00 |
wanted_end | datetime, in the JSON body | No | ISO 8601. The end of the window. | 2026-10-30T12:00:00-05:00 |
urgency | text, in the JSON body | No | urgent, high or normal. One of urgent, high, normal. | normal |
notes | text, in the JSON body | No | Anything the crew or the office should know. | Two flights of stairs |
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, lead_id, ticket (for example L-2041), number, state (new) and position: the event position, usable as after= on the next read. A lead sent twice is two leads, so send it once; the Idempotency-Key protects a retry of the same call.
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. |
lead_id | id (text) | The id of the lead. |
state | text | The state or region. |
position | whole number | Where the change landed in the event log. Pass it as after on a read to see your own write. |
ticket | text | The job number the ticket shows. |
number | whole number | The number people say out loud, such as the job number. |
Which door this is
It is the app's New lead button: a lead typed by hand. It is never kept out by the take rules and no AI reads it. A call or a message from a leads group reaches the app by its own door, not this one.
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. |
| `out_of_scope` | 404 | No such company 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
- Update lead: Change what a lead asked for: the customer, the address, the service, the time, the urgency or the notes. Only the fields you send change.
- Mark lead lost: Close an open lead as lost, with the reason. It moves to Archive on the company's own clock.
- Pass lead: Say a new lead is not yours to take, with an optional reason. It leaves the list to answer.
- Book lead: Turn a lead into a job with everything the lead holds. The lead becomes won and is linked to the job.
- Dismiss lead: Send a lead to Trash as a mistake. It counts nowhere and is erased after 30 days.
- Review conversion: Decide an ad click the matcher would not guess at: pick the job it produced, or reject it. Only then does it reach the Google file.
- Schedule follow up: Book a date to chase a job or a draft lead again. The job moves onto Follow up when the company has that status.
- Update follow up: Move the date of an open follow-up, or change why it is open.
- Resolve follow up: Say the chase happened. The follow-up is closed, and the job goes back to the line when it was the last stop.
- Cancel follow up: Call off a follow-up that should never have been booked. It is removed, and no chase is recorded.
- The same records in the app: the Leads panel.
- How the API fits together: the model, API keys, errors and the MCP server.