--- title: "Update the current organization" canonical: "https://admiral.io/docs/api/organization/OrganizationAPI_UpdateOrganization" --- # Update the current organization `PATCH https://api.admiral.io/v1/organization` Only `display_name` is mutable. `slug` is part of the account's identity and `status` is set by lifecycle operations, neither of which an organization performs on itself. The logo is set in the console. Scope: `organization:write` ### Request body - `organization` (Organization, required): The organization with updated fields. Only fields named in `update_mask` are applied. - `id` (string): Unique identifier. Pattern `^org-[0-9a-z]+$`. Read-only. - `slug` (string): URL-safe identifier, unique across Admiral. Fixed at creation. Read-only. - `display_name` (string): Human-readable name. Length at most 256. - `status` (Status): Lifecycle state. One of `STATUS_UNSPECIFIED`, `STATUS_ACTIVE`, `STATUS_SUSPENDED`. Read-only. - `avatar_url` (string): The organization's logo, shown on its sign-in page and in the console. Absent when none is set. Read-only. - `created_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only. - `updated_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only. - `update_mask` (FieldMask): The set of fields to update. Optional; if omitted, all populated fields are updated. Supported fields: `display_name`. ### Response 200 Success - `organization` (Organization): Organization is the account as its own members see it: its identity, its lifecycle state, and the settings they control. Operational detail about how the account is run is not part of this view. - `id` (string): Unique identifier. Pattern `^org-[0-9a-z]+$`. Read-only. - `slug` (string): URL-safe identifier, unique across Admiral. Fixed at creation. Read-only. - `display_name` (string): Human-readable name. Length at most 256. - `status` (Status): Lifecycle state. One of `STATUS_UNSPECIFIED`, `STATUS_ACTIVE`, `STATUS_SUSPENDED`. Read-only. - `avatar_url` (string): The organization's logo, shown on its sign-in page and in the console. Absent when none is set. Read-only. - `created_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only. - `updated_at` (Timestamp): A point in time in RFC 3339 format, with up to nanosecond precision. Output uses UTC (`Z`); input may use an offset from UTC. Read-only.