• Features
  • Pricing
Get Started

List StatusesCreate StatusGet StatusUpdate StatusDelete StatusReorder Statuses

POST /v1/statuses

Create a new status by sending a JSON request body.

POST /v1/statuses creates a new status.

Authentication

Send an organization API key in x-api-key or Authorization: Bearer <key>.

Request Body

name, color, and type are required.

NameTypeRequiredDescription
namestringYesStatus name, from 1 to 100 characters.
colorstringYesStatus color, from 1 to 50 characters.
typeenumYesOne of in-storage, on-display, temporarily-unavailable, or offsite.
descriptionstringNoStatus description, up to 500 characters.

Example

curl -X POST "https://api.blueputto.com/v1/statuses" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "content-type: application/json" \
  -d '{"name":"On display","color":"#16a34a","type":"on-display"}'

Success Response

201 Created

{
  "data": {}
}

Error Responses

  • 400 Bad Request
  • 401 Unauthorized
  • 429 Too Many Requests

GET /v1/statuses

List statuses with pagination.

GET /v1/statuses/{statusId}

Retrieve a single status by its UUID.

On this page

AuthenticationRequest BodyExampleSuccess ResponseError Responses