Organizations

Update organization settings

Updates the public-facing settings of an organization. Requires admin permissions.

patch/v2/organization/{organization}/settings

Request

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

Path parameters

organizationstring required

Organization unique name (URL-safe slug)

Example:zephyr-cloud

Request body

displayNamestring

Display name

descriptionstring

Organization description

Example request

{
  "displayName": "Zephyr Cloud",
  "email": "user@example.com",
  "description": "A modern cloud deployment platform",
  "socialAccounts": []
}

Response

Updated organization settings

Example response

{
  "value": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "zephyr-cloud",
    "displayName": "Zephyr Cloud",
    "contactInfo": {
      "email": "contact@zephyr-cloud.io"
    },
    "description": "A modern cloud deployment platform",
    "socialAccounts": [
      {
        "link": "https://github.com/zephyr-cloud",
        "label": "GitHub"
      }
    ],
    "countInfo": {
      "projectAmount": 5,
      "applicationAmount": 12
    }
  }
}

Changes

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