Sign in
workspaces

Update Workspace

Update a workspace's name and/or contact details (admin only).

patch/v1/workspaces/{workspace_id}

Path parameters

workspace_idstring uuid required

Request body

namestring nullable
contact_emailstring nullable
contact_phonestring nullable

Response

Successful Response

idstring uuid required
namestring required
parent_workspace_idstring uuid nullable
rolestring nullable
clerk_org_idstring nullable
organization_image_urlstring nullable
company_domainstring nullable
contact_emailstring nullable
contact_phonestring nullable
setup_completed_atstring date-time nullable
setup_skipped_atstring date-time nullable
setup_statusstring
created_atstring date-time nullable

Changes

No recorded changes to this endpoint across all 1 revision of this API.