> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Update an organization

> Update an organization's display name. The organization is identified by the `org_id` path
parameter alone; the `x-hh-org-id` header does not participate.

The organization's email domains cannot be changed through the API. Set them in the
organization settings of the HoneyHive app.




## OpenAPI

````yaml https://raw.githubusercontent.com/honeyhiveai/honeyhive-openapi/main/control_plane_openapi.yaml patch /v1/orgs/{org_id}
openapi: 3.1.0
info:
  title: HoneyHive Control Plane API
  description: >
    Manage HoneyHive control-plane resources: organizations, workspaces,
    projects and alerts, and

    read org usage.


    Authentication requires a fine-grained control-plane API key (values

    start with `hh_fgcp_`), sent as `Authorization: Bearer <api-key>`.

    Project API keys used with the Data Plane API will not work here. Create

    a key in the HoneyHive app under an organization's or workspace's

    **Settings → API Keys**, or see

    [Authorization](https://docs.honeyhive.ai/v2/control-plane-sdk-reference/typescript#authorization)

    for details.
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT
  version: 1.17.0
servers:
  - url: https://api.cp.us.honeyhive.ai
security: []
tags:
  - name: Alerts
    description: >
      Define and manage alerts. Alerts evaluate event metrics on a schedule and
      trigger notifications when configured thresholds are crossed.
  - name: Orgs
    description: >
      Read an organization's display name and the email domains whose users join
      it automatically when they sign in, and update its display name.
  - name: Projects
    description: >
      Create and manage projects within a workspace. A project is the container
      for the events, datasets, evaluations, and alerts logged against it.
  - name: Usage
    description: >
      Read an organization's usage: events and computed metrics per calendar
      month, and current user, workspace and project counts.
  - name: Virtual Dataplanes
    description: >
      Create and manage virtual data planes. A virtual data plane is a logical
      tenant boundary inside an organization, hosted on a physical cluster;
      several virtual data planes commonly share one cluster. Workspaces live
      inside a virtual data plane.
  - name: Workspaces
    description: >
      Read and manage workspaces. A workspace groups the projects belonging to
      one team or environment, and owns the API keys and AI provider secrets its
      projects share.
paths:
  /v1/orgs/{org_id}:
    patch:
      tags:
        - Orgs
      summary: Update an organization
      description: >
        Update an organization's display name. The organization is identified by
        the `org_id` path

        parameter alone; the `x-hh-org-id` header does not participate.


        The organization's email domains cannot be changed through the API. Set
        them in the

        organization settings of the HoneyHive app.
      operationId: updateOrg
      parameters:
        - in: path
          name: org_id
          required: true
          schema:
            type: string
          description: The unique identifier of the organization to update
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchOrgRequest'
      responses:
        '200':
          description: Organization updated successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UpdateOrgResponse'
        '400':
          description: Invalid request body
        '404':
          description: Organization not found
      security:
        - ControlPlaneApiKey: []
components:
  schemas:
    PatchOrgRequest:
      type: object
      properties:
        name:
          type: string
          maxLength: 200
          description: >-
            Organization display name. Allowed characters are the letters A-Z
            and a-z (no accented letters), digits, space, underscore, hyphen,
            apostrophe and ampersand, and the name must not start with a space.
      additionalProperties: false
      description: Request body for updating an organization
    UpdateOrgResponse:
      type: object
      properties:
        success:
          type: boolean
        data:
          $ref: '#/components/schemas/OrgItem'
      required:
        - success
        - data
      additionalProperties: false
      description: The updated organization
    OrgItem:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
          description: Organization display name
        email_domains:
          type: array
          items:
            type: string
          description: >-
            Email domains for automatic membership. A user who signs in through
            SSO or a social login with an email at one of these domains joins
            the organization. The API cannot change them. Set them in the
            organization settings of the HoneyHive app.
        created_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
        updated_at:
          anyOf:
            - type: string
              format: date-time
            - type: string
            - type: 'null'
      required:
        - id
        - name
        - email_domains
        - created_at
      additionalProperties: false
      description: Organization object
  securitySchemes:
    ControlPlaneApiKey:
      type: http
      scheme: bearer
      description: >-
        A fine-grained control-plane API key (values begin with `hh_fgcp_`).
        Project API keys used with the Data Plane API will not work here. Create
        one in the HoneyHive app under an organization's or workspace's
        **Settings → API Keys**.

````

## Related topics

- [Role Based Access Control](https://docs.honeyhive.ai/v2/workspace/roles.md)
- [Organization Hierarchy](https://docs.honeyhive.ai/v2/workspace/organization-hierarchy.md)
- [Product](https://docs.honeyhive.ai/v2/changelog/product.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.