# Create state

URL: https://docs.hanzo.ai/docs/openapi/patrol/post-patrol-unit-by-name-state

> Moves a unit between states — on shift, on a break, off, or in trouble.

`POST /v1/patrol/unit/{name}/state`

> [Patrol →](https://docs.hanzo.ai/docs/openapi/patrol) · [All API references →](https://docs.hanzo.ai/docs/openapi) · [Get started →](https://docs.hanzo.ai/docs/guides)

|               |                                                    |
| ------------- | -------------------------------------------------- |
| **Address**   | `https://api.hanzo.ai/v1/patrol/unit/{name}/state` |
| **Method**    | `POST`                                             |
| **Operation** | `post_patrol_unit_by_name_state`                   |
| **Auth**      | `Authorization: Bearer $HANZO_API_KEY`             |

Moves a unit between states — on shift, on a break, off, or in
trouble. An officer may move only their own unit; the control room may move
any.

## Request

3 fields, body `application/json` (required).

| Field   | In   | Type   | Required | Description                                                                 |
| ------- | ---- | ------ | -------- | --------------------------------------------------------------------------- |
| `name`  | path | string | yes      | Name is the unit's call sign, from the path.                                |
| `name`  | body | string | —        | Name is the unit's call sign, from the path.                                |
| `state` | body | string | —        | State is available, assigned, enroute, onsite, offline, break or emergency. |

## Response

| Status    | Body                 | Meaning |
| --------- | -------------------- | ------- |
| `200`     | patrol.patrolUnitOut | ok      |
| `default` | problem-details      | refused |

`200` body — 13 fields.

| Field              | In   | Type                | Always | Description                                                                                                          |
| ------------------ | ---- | ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------- |
| `data`             | body | patrol.patrolUnit   | —      |                                                                                                                      |
| `data.due`         | body | string              | —      | Due is the lone-worker deadline, or empty when none is set.                                                          |
| `data.lat`         | body | number (double)     | —      | Lat is the unit's last latitude in degrees.                                                                          |
| `data.lon`         | body | number (double)     | —      | Lon is the unit's last longitude in degrees.                                                                         |
| `data.name`        | body | string              | —      | Name is the unit's call sign, which is its document name and the segment /v1/patrol/unit/{name}/fix addresses it by. |
| `data.officer`     | body | string              | —      | Officer is who is crewing it.                                                                                        |
| `data.sector`      | body | string              | —      | Sector is the patrol sector it works.                                                                                |
| `data.seen`        | body | string              | —      | Seen is when the unit last reported.                                                                                 |
| `data.state`       | body | string              | —      | State is available, assigned, enroute, onsite, offline, break or emergency.                                          |
| `data.trail`       | body | patrol.patrolFix\[] | —      | Trail is the tail of the unit's recorded positions, oldest first.                                                    |
| `data.trail[].at`  | body | string              | —      | At is when the position was recorded.                                                                                |
| `data.trail[].lat` | body | number (double)     | —      | Lat is the latitude in degrees.                                                                                      |
| `data.trail[].lon` | body | number (double)     | —      | Lon is the longitude in degrees.                                                                                     |

Failure carries the platform error shape — see [Errors](https://docs.hanzo.ai/docs/errors).

## Examples

**CLI**

```bash
hanzo patrol unit state <name>
```

**SDK**

**.ts**

```ts
import { Configuration, PatrolApi } from 'hanzoai';

const api = new PatrolApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.postPatrolUnitByNameState({ name: 'name', name: "<name>", state: "<state>" });
```

**.py**

```python
from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import PatrolApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = PatrolApi(client).post_patrol_unit_by_name_state(name='name', name="<name>", state="<state>")
```

**.go**

```go
cfg := hanzoai.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := hanzoai.NewAPIClient(cfg)

resp, _, err := client.PatrolAPI.PostPatrolUnitByNameState(context.Background()).Execute()
if err != nil {
	return err
}
```

**.rs**

```rust
use hanzo_client::apis::{configuration::Configuration, patrol_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = patrol_api::post_patrol_unit_by_name_state(&cfg, Default::default()).await?;
```

**.java**

```java
import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.PatrolApi;

ApiClient client = new ApiClient();
client.setBearerToken(System.getenv("HANZO_API_KEY"));

var result = new PatrolApi(client).postPatrolUnitByNameState();
```

**HTTP**

```bash
curl -X POST https://api.hanzo.ai/v1/patrol/unit/<name>/state \
  -H "Authorization: Bearer $HANZO_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
       "name": "<name>",
       "state": "<state>"
     }'
```

**MCP**

MCP reaches **patrol** through the `patrol` tool, which names its 26 operations with its own verbs — this one among them, under a name only MCP declares. `describe` explains any of them:

```bash
curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "get_patrol_camera"
         }
       }
     }'
```

---

[Patrol API](https://docs.hanzo.ai/docs/openapi/patrol) · [All Hanzo APIs](https://docs.hanzo.ai/docs/openapi) · [Interactive reference](https://docs.hanzo.ai/docs/openapi/reference)