Sign in

v1

latestOpenAPI 3.0.1Apache 2.02026-07-26193304444.4 KB
Service Orders

Update a service status

Partially updates a custom service status. Only provided fields are updated.

System default statuses cannot be modified.

Only available with the Service Orders module enabled.

🔒 Requires: services:write scope

patch/service_statuses/{id}

Request body

display_orderinteger nullable

New display order. Can be set to null to clear it.

namestring

New human-readable name for the status. If provided, must not be blank.

Response

Service status updated successfully

created_atstring date-time

The date and time the status was created.

display_namestring

Human-readable name of the status.

display_orderinteger nullable

The order in which this status appears in the UI. Null if not set.

idstring

The unique ID of the status.

retailer_idstring

The retailer this status belongs to.

status_keystring

The underlying key mapping this status to a system status (e.g. NEW, IN_PROGRESS).

system_defaultboolean

Whether this is a system-managed default status.

updated_atstring date-time

The date and time the status was last updated.