# Archive job

Archive job is a command in the HeadHoncho API. File a finished job away, off the boards. It keeps its money and counts in every figure; Unarchive brings it back.

Page: https://headhoncho.app/docs/api/archive_job | Part of the HeadHoncho API docs: https://headhoncho.app/docs/api | Machine-readable: https://headhoncho.app/docs/api/openapi.json | Everything in one file: https://headhoncho.app/docs/api/llms-full.txt

## The request

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

`POST /api/v1/commands/archive-job`

The key needs the **Jobs** area at **do**. An answered call costs 1 credit; a refusal costs nothing. See [credits](https://headhoncho.app/docs/api/errors#credits).

It runs the app's own command `archive-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](https://headhoncho.app/docs/api/model#idempotency).

## Parameters

| Name | Kind | Required | Description | Example |
| --- | --- | --- | --- | --- |
| `job_id` | id, in the JSON body | Yes | The job id, or its number. | `job_1138` |

## 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.

Paste your key on the web page and it fills a cURL line and a fetch line with your key and the example values. The page never sends the key anywhere. The same lines with a placeholder key are under Examples below.

## What comes back

accepted, job_id, number and position.

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

## Errors that apply

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

## Related

- [Create job](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/update_job): Change a job's facts: the customer, the address, the schedule, the job type or the notes. Only the fields you send change.
- [Change job status](https://headhoncho.app/docs/api/change_job_status): 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.
- [Assign worker](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/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](https://headhoncho.app/docs/api/add_job_note): Add a note to a job. It appends to the job's log and never overwrites.
- [Update job note](https://headhoncho.app/docs/api/update_job_note): Fix what a note says. Only the person who wrote it may change it; the old text stays in the job's history.
- [Delete job note](https://headhoncho.app/docs/api/delete_job_note): Take a note off a job. Its author or an owner may. The removal is in the job's history.
- [Set job cut](https://headhoncho.app/docs/api/set_job_cut): What one technician or subcontractor on a job is paid on this job: a percent of the total, a percent of the profit, or a flat amount.
- [Release job status](https://headhoncho.app/docs/api/release_job_status): Hand a status set by hand back to the automation. The job moves at once to the status its facts hold, and History says why.
- [Resolve job detour](https://headhoncho.app/docs/api/resolve_job_detour): Close a job's detour, such as Waiting on parts. The job goes back to the status it left, then on to where its facts put it.
- [Unarchive job](https://headhoncho.app/docs/api/unarchive_job): Bring an archived job back onto the boards, as it was.
- [Trash job](https://headhoncho.app/docs/api/trash_job): Move a job to Trash, with why. It leaves every list and every figure, and can be restored for 30 days.
- [Restore job](https://headhoncho.app/docs/api/restore_job): Bring a job back from Trash, whole: its money, its history and its technicians.
- [Upload photo](https://headhoncho.app/docs/api/upload_photo): Put one photo on a job. Send the picture as base64 text; it is stored and confirmed in one call.
- [Delete photo](https://headhoncho.app/docs/api/delete_photo): Remove one photo from a job, for good: its record and its file.
- The same records in the app: [the Jobs panel](https://headhoncho.app/docs/jobs).
- How the API fits together: [the model](https://headhoncho.app/docs/api/model), [API keys](https://headhoncho.app/docs/api/keys), [errors](https://headhoncho.app/docs/api/errors) and [the MCP server](https://headhoncho.app/docs/api/mcp).

## Examples

### Answer

```json
{
  "accepted": true,
  "job_id": "job_1138",
  "number": 1138,
  "position": 88411
}
```

### cURL

```bash
curl -X POST "https://api.headhoncho.app/api/v1/commands/archive-job" \
  -H "Authorization: Bearer hh_live_..." \
  -H "Idempotency-Key: 6f1d2c9e-1b7a-4c1e-9a52-0d3f8e4b7a10" \
  -H "Content-Type: application/json" \
  -d '{
  "job_id": "job_1138"
}'
```

### Python

```python
import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/archive-job",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "job_id": "job_1138",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

```javascript
const response = await fetch("https://api.headhoncho.app/api/v1/commands/archive-job", {
  method: "POST",
  headers: {
    Authorization: "Bearer hh_live_...",
    "Idempotency-Key": crypto.randomUUID(),
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "job_id": "job_1138"
  }),
});
const data = await response.json();
console.log(data);
```

### Your AI

```text
Tool: archive_job
Arguments: job_id (id, required)
Access: do on Jobs
Hints: readOnly=false, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, archive job with job_id job_1138."
```