latestOpenAPI 3.1.02026-08-211061591.1 MB

69a962f1578f

Workspace

Update Workspace

Updates an existing workspace and returns it.

post/api/v1/workspaces/{workspace_id}

Path parameters

workspace_idinteger required

ID of the workspace

Example:123456

Request body

namestring nullable

Updated workspace name. Passing null or omitting this field will leave it unchanged.

descriptionstring nullable

Updated workspace description. Passing null or omitting this field will leave it unchanged.

is_link_sharing_enabledboolean nullable

Updated link sharing status. Passing null or omitting this field will leave it unchanged.

is_guest_allowedboolean nullable

Updated guest access status. Passing null or omitting this field will leave it unchanged.

domain_namestring nullable

Updated workspace email domain. Passing null or omitting this field will leave it unchanged.

domain_discoveryboolean nullable

Updated domain discovery setting. Passing null or omitting this field will leave it unchanged.

restrict_email_domainsboolean nullable

Updated email domain restriction setting. Passing null or omitting this field will leave it unchanged.

is_trial_pendingboolean nullable

Updated trial pending state. Passing null or omitting this field will leave it unchanged.

invite_codestring nullable

Regenerate workspace invite code when set. Passing null or omitting this field will leave it unchanged.

is_collapsedboolean nullable

Updated collapse state for current user. Passing null or omitting this field will leave it unchanged.

Example request

{
  "name": "Design Team",
  "description": "Workspace for design projects.",
  "is_link_sharing_enabled": true,
  "is_guest_allowed": true,
  "domain_name": "example.com",
  "properties": {
    "region": "EU",
    "country": "ES",
    "acquisition_loop_last_show": "2025-02-12",
    "onboarding_filter_id": 1234
  },
  "invite_code": "regenerate"
}

Response

Successful Response

object required