v1

latestOpenAPI 3.1.02026-08-0420819698.7 KB
Routes
Statuses

Create Status

Creates a new custom status for the customer account.

Request Body:

  • name (string, required) - Status name, 1-100 characters, must be unique (case-insensitive)

  • description (string, optional) - Status description, max 65535 characters

  • sortOrder (integer, optional) - Display order, 0-99, auto-assigned if omitted

Response (201 Created):

  • statusID (number) - ID of the newly created status

  • Location header: /v2/statuses?statuses={statusID}

Validation:

  • Name must not conflict with existing statuses or defaults ("Open", "In Progress", "Complete")

  • Name is compared case-insensitively

post/v2/statuses

Request body

namestring
descriptionstring
sortOrderinteger

Response

201 Created - Success

statusIDinteger