Super Admin Orgs

Rename an organization

Changed on

Update an organization display name. Only accessible to users with the super admin system role.

patch/super-admin/orgs/{id}

Request

  • The document declares no server URL.
  • Auth: none declared

Path parameters

idstring required

The ID of the organization to update.

Request body

namestring required

Organization display name

Example request

{
  "name": "Acme Corporation"
}

Response

Successfully updated organization for the super admin.

idstring uuid required

Organization unique identifier

namestring required

Organization display name

archivedboolean required

Whether the organisation is archived

hideIndividualUsageboolean required

Whether individual usage is hidden from organisation admins

createdAtstring date-time required

Date when the organization was created

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "Acme Corporation",
  "createdAt": "2024-01-15T10:30:00Z"
}

Changes

  • 366e2075c239Revision changes
    • info

      added the required property to the response with the status

  • 06cf3af07f8aRevision changes
    • info

      added the media type application/json for the response with the status

    • info

      added the non-success response with the status

    • info

      added the required property to the response with the status