# POST /api/v1/pending-changes

> Propose a change

- **Tag:** pending-changes
- **Operation ID:** `create_pending_change`

## Description

Store a previewed write for a person to approve in the app. Nothing is applied until someone approves it.

## Authentication

Bearer token in `Authorization` header.
Required header: `x-business-id: <business uuid>`.

## Request body

Schema: `PendingChangeCreateRequest`

- `tool_name` (string · required) — Write tool to run on approval, e.g. bulk_edit_transactions.
- `arguments` (object · required) — The exact arguments the apply takes (the tool's own parameter names). business_id and dry_run are set by the server.
- `preview` (object | array · object · required) — What the dry run / preview returned. Rows shaped {id, field, from, to, amount_cents} render as a diff.
- `plan_hash` (string) — The preview's plan_hash; the apply refuses a changed plan.
- `summary` (string · required) — One line a person reads first, e.g. 'Recategorize 14 AWS rows'.
- `round_id` (string) — Approval round to add the change to (an open round of this business, from open_approval_round).

## Responses

### 201 — Successful Response

Schema: `SuccessEnvelope_PendingChangeResponse_`

- `success` (boolean)
- `message` (string)
- `code` (string)
- `data` (PendingChangeResponse)

### 400 — Bad Request - Invalid input

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 401 — Unauthorized - Missing or expired token, an MCP OAuth token used against the REST API, or no access to this business

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 403 — Forbidden - Insufficient permissions

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

### 422 — Validation Error

Schema: `ErrorResponse`

- `error` (string · required) — Error category: `validation_error`, `unauthorized`, `forbidden`, `not_found`, `conflict`, `rate_limited`, `server_error`, or `service_unavailable`.
- `message` (string · required) — Human-readable explanation, safe to show to end users.
- `code` (string · required) — Stable machine-readable code in `CATEGORY_NNN` form (e.g. `NOT_FOUND_006`, `AUTH_010`, `GEN_002`).
- `request_id` (string) — Correlation id for support requests. Echoes the `x-request-id` request header when one was supplied.
- `errors` (object) — Field-level validation messages keyed by field name. Present on 400/422 validation failures only.

## Code samples

### cURL

```bash
curl -X POST 'https://api.ondayzero.com/api/v1/pending-changes' \
  -H 'Authorization: Bearer dz_your_token' \
  -H 'x-business-id: YOUR_BUSINESS_ID' \
  -H 'Content-Type: application/json' \
  -d '{
  "tool_name": "string",
  "arguments": {},
  "preview": "string",
  "summary": "string"
}'
```

### JavaScript

```javascript
const response = await fetch('https://api.ondayzero.com/api/v1/pending-changes', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer dz_your_token',
    'x-business-id': 'YOUR_BUSINESS_ID',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
  "tool_name": "string",
  "arguments": {},
  "preview": "string",
  "summary": "string"
}),
});
const data = await response.json();
```

### Python

```python
import httpx

headers = {
    "Authorization": "Bearer dz_your_token",
    "x-business-id": "YOUR_BUSINESS_ID",
}

payload = {'tool_name': 'string',
 'arguments': {},
 'preview': 'string',
 'summary': 'string'}

response = httpx.post("https://api.ondayzero.com/api/v1/pending-changes", headers=headers, json=payload)
data = response.json()
```

## See also

- HTML version: https://www.ondayzero.com/docs/reference/pending-changes/create-pending-change
- OpenAPI slice: https://www.ondayzero.com/docs/reference/pending-changes/create-pending-change/openapi.json
- Other endpoints in **pending-changes**: https://www.ondayzero.com/docs/reference/pending-changes (markdown bundle: https://www.ondayzero.com/docs/reference/pending-changes.md, OpenAPI: https://www.ondayzero.com/docs/reference/pending-changes/openapi.json)
- Endpoint catalog: https://www.ondayzero.com/docs/reference/index.md