Skip to main content
PATCH
/
v1
/
workspaces
/
{id}
Update workspace
curl --request PATCH \
  --url https://{defaultHost}/v1/workspaces/{id} \
  --header 'X-Authorization: <api-key>'
{
  "workspace": {
    "id": "ws_123",
    "name": "Acme Corp",
    "personal": false,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "is_pro": false,
    "public_signup": false,
    "user_info_requirement": "email",
    "slug": "acme-corp",
    "membership": {
      "role": "owner",
      "created_at": "2023-11-07T05:31:56Z"
    },
    "settings": {
      "onboarding": {
        "fullName": true,
        "companyName": false
      }
    },
    "logo_url": "https://example.com/logo.png"
  }
}

Authorizations

X-Authorization
string
header
required

User Access token

Path Parameters

id
string
required

Workspace ID or slug

Response

successful

workspace
object