Skip to main content
PATCH
Update many stages

Authorizations

X-API-Key
string
header
required

Organization-scoped API key. Create one in the BuildingSwell app under Organization settings, API keys.

Query Parameters

Full-text search across the resource's search columns. Append :col1,col2 to limit which columns are searched.

filter
string

AND/OR filter expression, for example type eq 'phase' and isArchived eq false. Simple equality can also be passed as plain field parameters.

Body

application/json

Every field is optional. Only the fields you send are changed.

name
string

Station name, for example Welding.

shopId
string<uuid>

Department the station belongs to.

description
string | null

What happens at this station.

maxOrderCapacity
integer

How many orders the station can hold at once. Zero or greater.

Required range: x >= 0
costCode
string | null

Cost code. Trimmed on write, and an empty string is rejected: send a non-empty string or null.

Stored as a plain string. It is not validated against the cost code list, and renaming an entry in that list does not change this value.

isArchived
boolean
default:false

Archived stations are hidden from list results unless you ask for them.

Response

The updated stages.

values
object[]
required