# Update Reason Code

`PATCH /inventory/reason-codes/{id}`

Group: Inventory › Reason Codes · Operation ID: `updateReasonCode`

Updates the reason code with the given identifier. Only the fields in the request body change.

Everything omitted from the request body is left as it was. documentTypes replaces the whole set of linked document types rather than merging, so read the current set from GET inventory/reason-codes/:id first if you mean to add one. The response is only the reason code's id. Read the updated record with GET inventory/reason-codes/:id when you need its state after the update.

[Open in the interactive reference](https://docs.api.lensing.ai/?op=updateReasonCode)

## Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `Api-Version` | header | `"v1"` | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version `v1`. |
| `Idempotency-Key` | header | string | no | An opaque caller-chosen string (1-255 characters) that makes this request safe to retry. Repeating the same key with an identical request body replays the original response instead of re-executing - but only once that original request succeeded; a failed attempt re-executes on retry. Repeating the key with a different body is answered with 422. A key still in flight is answered with 409 - as is a key whose original request was interrupted before it finished, for a few minutes afterwards, until that attempt is presumed dead. A completed response stays replayable for 24 hours. The key is scoped to the caller, not to the action: reusing it for a different action is answered with 409 or 422 rather than treated independently. On read actions this header is ignored. On write actions that cannot offer the guarantee it is answered with `400 IDEMPOTENCY_NOT_SUPPORTED` rather than silently ignored. |
| `id` | path | string | yes | The unique identifier for the reason code to update. |

## Request body

Required, `application/json`: updateReasonCodeInput.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `code` | string | no | The business code of the reason code, for example 'DAMAGE'. It must stay unique within the tenant. Reusing the reason code's own current code is not a collision. |
| `description` | string | no | A free-form description of what the reason code means. |
| `isActive` | boolean | no | Whether the reason code can be selected on new documents. Set it to false to retire the reason code without deleting it: existing documents keep it and new ones cannot select it. |
| `requiresApproval` | boolean | no | Whether documents using this reason code require approval before they take effect. |
| `documentTypes` | array of string, one of `"InventoryIncrease"`, `"InventoryDecrease"`, `"SalesReturn"`, `"PurchaseReturn"`, `"Disposal"` | no | The complete set of document types this reason code may be selected on. It replaces the current set. Anything not listed is unlinked, and an empty array unlinks everything. Omit to leave the links unchanged. An unrecognized value fails the call with UNKNOWN_DOCUMENT_TYPES, which names every value it did not recognize. |

Example:

```json
{
  "code": "<code>",
  "description": "<description>",
  "isActive": true,
  "requiresApproval": true,
  "documentTypes": [
    "InventoryDecrease",
    "SalesReturn",
    "Disposal"
  ]
}
```

## Response

`200` Success

Under `data` (updateReasonCodeOutput):

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `id` | string | yes | The unique identifier for the reason code. |

## Response headers

- `Idempotency-Replayed` — Present and `true` only when this response replays a previously stored one for the same Idempotency-Key, rather than reflecting a live execution. Absent on a live response - never sent as `false`.

## Errors

| Code | Status |
| --- | --- |
| `NOT_FOUND` | 400 |
| `DUPLICATE_CODE` | 400 |
| `UNKNOWN_DOCUMENT_TYPES` | 400 |
| `IDEMPOTENCY_KEY_CONFLICT` | 409 |
| `IDEMPOTENCY_PAYLOAD_MISMATCH` | 422 |

## Statuses

- `400` — Invalid request or business failure. Codes: NOT_FOUND, DUPLICATE_CODE, UNKNOWN_DOCUMENT_TYPES
- `401` — Missing or invalid access token
- `403` — Not authorized
- `404` — Not found
- `409` — The Idempotency-Key is still being processed by another request.
- `422` — The Idempotency-Key was already used with a different request payload.
- `429` — Too many requests
- `500` — Internal server error