PATCH /v1/statuses/{statusId}
Partially update a status with a JSON request body.
PATCH /v1/statuses/{statusId} updates an existing status.
Authentication
Send an organization API key in x-api-key or
Authorization: Bearer <key>.
Path Parameters
| Name | Type | Description |
|---|---|---|
statusId | string (uuid) | UUID of the status to update. |
Request Body
Send a JSON object containing the fields you want to change.
| Name | Type | Description |
|---|---|---|
name | string | Status name, from 1 to 100 characters. |
color | string | Status color, from 1 to 50 characters. |
type | enum | One of in-storage, on-display, temporarily-unavailable, or offsite. |
description | string | Status description, up to 500 characters. |
Example
curl -X PATCH "https://api.blueputto.com/v1/statuses/STATUS_ID" \
-H "x-api-key: YOUR_API_KEY" \
-H "content-type: application/json" \
-d '{"name":"On loan","type":"offsite"}'Success Response
200 OK
{
"data": {}
}Error Responses
400 Bad Request401 Unauthorized404 Not Found429 Too Many Requests