Configuration APISeat Assignments

Delete a seat assignment

Requires the SEAT_ASSIGNMENT.DELETE permission.

Authentication

X-API-KEYstring
API Key authentication via header
OR
AuthorizationBearer

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

Path parameters

versionstringRequiredDefaults to 1
version
resourceIdstringRequiredDefaults to
The ID of the resource to be requested.

Headers

x-platform-idstringOptional
Platform ID.

Response

OK
object_typestring or nullOptionalRead-only
idstring or nullOptionalRead-only
statusenum or nullOptionalRead-only

Derived from start_at/end_at at read time: SCHEDULED before start_at, ACTIVE while occupied, ENDED after end_at.

parent_customer_idstringOptional
The ID of the parent customer the seat is held under.
customer_idstringOptional

The ID of the processing-only child customer occupying the seat.

product_item_idstringOptional

The ID of the PER_SEAT product item, i.e. the seat type.

start_atdatetimeOptional
end_atdatetime or nullOptional

Must be strictly after start_at; a seat occupied for zero time is not an occupancy. Clearing it re-opens the seat.

created_atstring or nullOptionalRead-only
updated_atstring or nullOptionalRead-only

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error