Skip to main content
POST
Open whitelabel client workspace

Authorizations

Authorization
string
header
required

Access token issued by gs.service.id. Its access_identity claim carries team_sid, actor_sid and actor_type, and that team scope is authoritative.

Team-SID
string
header
required

Team scope for tokens that do not carry one. Ignored when the token already names a team.

Path Parameters

sid
string
required

Whitelabel (brand) sid (id_wl_...).

Required string length: 18
Pattern: ^id_wl_
teamSid
string
required

A client workspace of this brand (ts_tm_...): its owner registered on the brand's host.

Required string length: 18
Pattern: ^ts_tm_

Response

action success envelope.

success
enum<boolean>
required
Available options:
true
operation
enum<string>
required
Available options:
action
action
string
required

kebab-case verb; matches the route segment.

item
any
required
result
object
required
meta
object
required