HeadHoncho

Change job status

Change job status is a command in the HeadHoncho API. Move a job to another status by its name, slug or id. The move lands in the job's history with who asked for it.

Read as Markdown

The request

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

POST /api/v1/commands/change-job-status

The key or app needs the Jobs area at do. It counts as a write call: 60 a minute for each key or connected app. See rate limits.

It runs the app's own command change-job-status. 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
job_idid, in the JSON bodyYesThe job id, or its number.job_1203
statustext, in the JSON bodyYesA status name or slug from Who am I. status_id works too.Dispatched
reasontext, in the JSON bodyNoRead on a move into Canceled: why.Customer found another mover

What comes back

accepted, job_id, number, position, and status: where the job now stands.

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.

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.
`expired_token`401That token has expired. Refresh it, or connect the app again.
`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.
`rate_limited`429Too many calls this minute. Wait and try again.
  • Create job: Open a job or a lead in one company: the customer, the address, and optionally the job type, the time window and the technician.
  • Update job: Change a job's facts: the customer, the address, the schedule, the price, the job type or the notes. Only the fields you send change.
  • Assign worker: Put a technician or subcontractor on a job. If Job follow-up is on, the automation acts on it at once, as it would from the app.
  • Unassign worker: Take a technician or subcontractor off a job. The ticket's cancellation reaches them the way it does from the app.
  • Add job note: Add a note to a job. It appends to the job's log and never overwrites.
  • The same records in the app: the Jobs panel.
  • How the API fits together: the model, API keys, errors and the MCP server.