HeadHoncho

Update worker

Update worker is a command in the HeadHoncho API. Change a technician or subcontractor: name, contact, pay, cut, job types, or take them off the roster. Only the fields you send change.

Read as Markdown

The request

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

POST /api/v1/commands/update-worker

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

It runs the app's own command update-worker. 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

NameKindRequiredDescriptionExample
worker_idid, in the JSON bodyYesThe technician or subcontractor, from List technicians.wrk_3b90
first_nametext, in the JSON bodyNoThe first name.Samuel
last_nametext, in the JSON bodyNoThe last name.None
phonetext, in the JSON bodyNoAny format; stored as E.164. Empty clears it.None
emailtext, in the JSON bodyNoThe email. Empty clears it.None
activeboolean, in the JSON bodyNofalse takes them off the roster. true puts them back.false
is_team_leadboolean, in the JSON bodyNoTechnicians only.None
monthly_paymoney, in the JSON bodyNoA standing monthly rate. Null clears it. Technicians only.3400
hired_ondate, in the JSON bodyNoTechnicians only. Null clears it.None
ended_ondate, in the JSON bodyNoTechnicians only. Null clears it.None
business_nametext, in the JSON bodyNoThe subcontractor's business. Subcontractors only.None
default_cut_basistext, in the JSON bodyNojob_total, job_profit or fixed_amount. Send with default_cut_value. One of job_total, job_profit, fixed_amount.None
default_cut_valuemoney, in the JSON bodyNoThe percent, 0 to 100, or the dollars.None
job_type_idstext, in the JSON bodyNoReplaces the job types they take, ids comma separated. Empty: all of them.None

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, worker_id, name, changed (the fields you sent) and position. A field that does not fit the person's role, such as monthly_pay on a subcontractor, is refused by name. The role itself cannot change.

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.

FieldTypeMeaning
acceptedtrue or falseTrue when the command ran. A command that cannot run is an error instead.
worker_idid (text)The id of the worker.
positionwhole numberWhere the change landed in the event log. Pass it as after on a read to see your own write.
nametextThe name, as the app shows it.
changedlist of textThe changed.

Taking someone off the roster

Setting active to false stops tickets going to a subcontractor's group, as it does in the app. Their past jobs and balance stay.

Errors that apply

CodeStatusWhat it means
`missing_key`401Send your key as Authorization: Bearer hh_live_...
`unknown_key`401That key is not one we issued, or it was revoked.
`no_access`403This credential does not reach that. Ask the person who made it for access.
`read_only`403This credential may read this area but not change it.
`not_found`404No such record in the companies this credential reaches.
`invalid`422Some fields were refused. See fields.
`missing_idempotency_key`400Send an Idempotency-Key header on every command.
`idempotency_mismatch`409This Idempotency-Key was used with a different body.
`idempotency_in_progress`409A command with this Idempotency-Key is still running. Wait a moment and send it again.
`no_credits`402Out of credits. Top up on Settings › Credits, or turn on auto top-up.