Organizations

Update organization by ID

Updates an existing organization. Requires admin permissions.

post/v2/organization/{id}

Request

Base URL: https://api.zephyr-cloud.io
URL: https://api.zephyr-cloud.io/v2/organization/{id}
Auth: HTTP bearer

Path parameters

idstring uuid required

Valid UUID v4 identifier

Example:550e8400-e29b-41d4-a716-446655440000

Request body

namestring

New URL-safe organization name

displayNamestring

New display name

openMembershipboolean

Whether the organization allows open membership

Example request

{
  "name": "new-org-name",
  "displayName": "New Organization Name",
  "openMembership": true
}

Response

Organization updated successfully

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "zephyr-cloud",
    "displayName": "Zephyr Cloud",
    "createdAt": "2025-01-01T00:00:00.000Z",
    "updatedAt": "2025-06-15T12:30:00.000Z",
    "domains": [
      "@zephyr-cloud.io",
      "@zephyrcloud.com"
    ],
    "defaultRole": "viewer",
    "subscriptionTier": "PERSONAL",
    "subscriptionOwner": true,
    "subscriptionId": "sub_1234567890"
  }
}

Changes

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