Skip to main content
PUT
Replace the workspace access policy

Authorizations

Authorization
string
header
required

Headers

X-Workspace-Id
string<uuid>
required

UUID of the workspace to act in. Take it from GET /me (workspaces[].id). A key scoped to specific workspaces is rejected with 403 WORKSPACE_NOT_ALLOWED for any other id; a missing header is 400 WORKSPACE_REQUIRED.

Body

application/json
mode
enum<string>
required
Available options:
invite_only,
domain_restricted,
open
allowedDomains
string[]
required
Maximum array length: 50
Pattern: ^[a-zA-Z0-9][a-zA-Z0-9-]*(\.[a-zA-Z0-9-]+)*\.[a-zA-Z]{2,}$
defaultRole
enum<string>
required
Available options:
viewer,
reviewer

Response

The access policy after the change

data
object
required