Hold back job

The request

Reference for Hold back job, HeadHoncho API v1. It is a command, sent to the base address https://api.headhoncho.app.

POST /api/v1/commands/hold-back-job

The key needs the Money area at do. An answered call costs 1 credit; a refusal costs nothing. See credits.

It runs the app's own command hold-back-job. 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
`worker_id`	id, in the JSON body	Yes	The technician, from Who am I's technicians.	`wrk_7a12`
`job_id`	id, in the JSON body	Yes	The job id, or its number.	`job_1138`
`reason`	text, in the JSON body	No	Why it waits.	`Customer disputes the bill`

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 API key worker_id (required, id) job_id (required, id) reason (optional, text)

Your key stays in this page and is never sent anywhere. Copy the line below and run it yourself.

What comes back

accepted, worker_id, job_id, number, hold_id, reason and position. A job already held back is refused, so the reason on it stays the live one.

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.
`worker_id`	id (text)	The id of the worker.
`position`	whole number	Where the change landed in the event log. Pass it as `after` on a read to see your own write.
`job_id`	id (text)	The id of the job.
`number`	whole number	The number people say out loud, such as the job number.
`hold_id`	id (text)	The id of the hold.
`reason`	text	The reason given.

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.

Close balance: Close what a technician is owed for the jobs you name, or for everything open through a day, as one payout netted against the cash they hold.
Record payout: Record money paid to a technician, or paid in by one, that names no jobs. It moves their balance and closes no particular job.
Void closed balance: Undo a balance close or a payout entered wrong. Its jobs open again, and it stays on the list, marked voided, with why.
Put back job: Let a held-back job count in the technician's next balance close again.
Post monthly pay: Add a month of pay to the balance of every active technician on a monthly rate. A month is posted once, however often this is sent.
The same records in the app: the Finance panel.
How the API fits together: the model, API keys, errors and the MCP server.

Answer cURL Python JavaScript Your AI

{
  "accepted": true,
  "worker_id": "wrk_7a12",
  "position": 88520,
  "job_id": "job_1138",
  "number": 1138,
  "hold_id": "hld_0c3e",
  "reason": "Customer disputes the bill"
}

curl -X POST "https://api.headhoncho.app/api/v1/commands/hold-back-job" \
  -H "Authorization: Bearer hh_live_..." \
  -H "Idempotency-Key: 6f1d2c9e-1b7a-4c1e-9a52-0d3f8e4b7a10" \
  -H "Content-Type: application/json" \
  -d '{
  "worker_id": "wrk_7a12",
  "job_id": "job_1138",
  "reason": "Customer disputes the bill"
}'

import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/hold-back-job",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "worker_id": "wrk_7a12",
        "job_id": "job_1138",
        "reason": "Customer disputes the bill",
    },
)
response.raise_for_status()
print(response.json())

const response = await fetch("https://api.headhoncho.app/api/v1/commands/hold-back-job", {
  method: "POST",
  headers: {
    Authorization: "Bearer hh_live_...",
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "worker_id": "wrk_7a12",
    "job_id": "job_1138",
    "reason": "Customer disputes the bill"
  }),
});
const data = await response.json();
console.log(data);

Tool: hold_back_job
Arguments: worker_id (id, required), job_id (id, required), reason (text, optional)
Access: do on Money
Hints: readOnly=false, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, hold back job with worker_id wrk_7a12 and job_id job_1138 and reason Customer disputes the bill."