# Update organization

Update organization is a command in the HeadHoncho API. Rename the workspace. A company still carrying the old workspace name is renamed with it.

Page: https://headhoncho.app/docs/api/update_organization | 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 **Update organization**, HeadHoncho API v1. It is a command, sent to the base address `https://api.headhoncho.app`.

`POST /api/v1/commands/update-organization`

The key needs the **Company settings** 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 `update-organization`. 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 |
| --- | --- | --- | --- | --- |
| `name` | text, in the JSON body | Yes | At least 3 characters. | `Northwind Ads Group` |

## 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, organization_id, name 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. |
| `position` | whole number | Where the change landed in the event log. Pass it as `after` on a read to see your own write. |
| `organization_id` | id (text) | The id of the organization. |
| `name` | text | The name, as the app shows it. |

## Owner or admin only

Refused with no_access for anyone else, and for a credential that does not reach every company, because the rename can reach them all.

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

- [Update company](https://headhoncho.app/docs/api/update_company): Change one company's own facts: name, service area, time zone, country, color, week, opening hours or service places. Only what you send changes.
- [Create company](https://headhoncho.app/docs/api/create_company): Add another company to the workspace. It starts with the first company's time zone and country unless you send your own.
- [Add job type](https://headhoncho.app/docs/api/add_job_type): Add a kind of work the business does, such as Local move or Roof repair. A name already in use is refused.
- [Update job type](https://headhoncho.app/docs/api/update_job_type): Rename a job type, move it in the list, or retire it so new jobs cannot pick it. Old jobs keep it.
- [Update job status](https://headhoncho.app/docs/api/update_job_status): Rename a status, change its look, move it in the list, or retire it. A rename shows on every job at once. Its slug and band stay.
- [Set status band](https://headhoncho.app/docs/api/set_status_band): Put a status on the line (a step every job passes) or off it as a detour (a place a job gets stuck). The line closes up behind it.
- [Replace job status](https://headhoncho.app/docs/api/replace_job_status): Let another status stand in for this one: move its jobs onto the new status, retire the old word, or both. Name an existing status or a new one.
- [Add job status](https://headhoncho.app/docs/api/add_job_status): Add a status to the workspace's list, on the line or as a detour. It carries no role: it is a name and a color.
- [Reorder line](https://headhoncho.app/docs/api/reorder_line): Set the order of the statuses on the line, the order every picker offers. Send every status on the line, once each.
- [Update agency feed](https://headhoncho.app/docs/api/update_agency_feed): Change how closed jobs reach the agency: the webhook address, the daily file address and hour, or switch the feed on or off. Secrets are not touched.
- [Sync callrail](https://headhoncho.app/docs/api/sync_callrail): Pull the company's new CallRail calls and forms now, match them to jobs, and say how many landed. The hourly sync does this on its own.
- [Update callrail tracking](https://headhoncho.app/docs/api/update_callrail_tracking): Set the tracking phone numbers on a company's CallRail connection. They replace the list whole. The webhook signing key is set in the app.
- [Refresh sources](https://headhoncho.app/docs/api/refresh_sources): Clear the Call center source stamped on a company's jobs, pull all its CallRail history again and re-read every call, so each job's source is worked out afresh.
- [Sync ad platform](https://headhoncho.app/docs/api/sync_ad_platform): Pull a company's latest campaigns and spend from one ad platform now. The hourly sync does this on its own.
- The same records in the app: [Settings](https://headhoncho.app/docs/settings).
- 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,
  "position": 88611,
  "organization_id": "org_2c7d",
  "name": "Northwind Ads Group"
}
```

### cURL

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

### Python

```python
import requests
import uuid

response = requests.post(
    "https://api.headhoncho.app/api/v1/commands/update-organization",
    headers={
        "Authorization": "Bearer hh_live_...",
        "Idempotency-Key": str(uuid.uuid4()),
    },
    json={
        "name": "Northwind Ads Group",
    },
)
response.raise_for_status()
print(response.json())
```

### JavaScript

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

### Your AI

```text
Tool: update_organization
Arguments: name (text, required)
Access: do on Company settings
Hints: readOnly=false, destructive=false, idempotent=true, openWorld=false
Try asking: "Using HeadHoncho, update organization with name Northwind Ads Group."
```