Update an organization within an organization

For platform, the plan must be ‘SCALE’ or higher to access this endpoint. Required membership role: org admin. PBAC permission: organization.update. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control

PATCH /v2/organizations/{orgId}/organizations/{managedOrganizationId}

Update an organization within an organization

cURL

curl --request PATCH \
  --url https://api.cal.com/v2/organizations/{orgId}/organizations/{managedOrganizationId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "CalTeam",
  "metadata": {
    "key": "value"
  }
}
'

200

{
  "status": "success",
  "data": {
    "id": 123,
    "name": "<string>",
    "slug": "<string>",
    "metadata": {
      "key": "value"
    }
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-cal-secret-key · string

For platform customers - OAuth client secret key

x-cal-client-id · string

For platform customers - OAuth client ID

Path Parameters

orgId · number · required

managedOrganizationId · number · required

Body

application/json

name · string

Name of the organization

Minimum string length: 1

Example:

"CalTeam"

metadata · object

You can store any additional data you want here. Metadata must have at most 50 keys, each key up to 40 characters. Values can be strings (up to 500 characters), numbers, or booleans.

Example:

{ "key": "value" }

Response

200 - application/json

status · enum<string> · required

Available options: success, error

Example:

"success"

data · object · required

Show child attributes