Skip to main content
PATCH
Update workspace details

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required
Example:

"8c3a5b6f-1d2e-4f7a-9b8c-d1e2f3a4b5c6"

Body

application/json
name
string

Human-readable workspace name. 1–80 chars; trimmed server-side.

Example:

"Acme Visuals"

availabilityState
enum<string>

Supplier flips between ONLINE (dispatcher will pick) and OFFLINE (invisible). BUSY is API-owned and not settable here.

Available options:
ONLINE,
OFFLINE
Example:

"ONLINE"

coverageLat
number
Example:

4.711

coverageLng
number
Example:

-74.07

coverageRadiusMeters
number
Example:

500

deviceKind
enum<string>
Available options:
PHONE,
LAPTOP,
DRONE,
PTZ,
FIXED,
OTHER
Example:

"PHONE"

Response

Request successful

statusCode
number
required
Example:

200

message
string
required
Example:

"Request successful"

data
object
required

Endpoint-specific payload. See the per-endpoint schema.

timestamp
string
required
Example:

"2026-05-13T12:00:00.000Z"