Organizations

Update an organization

Changed on

Updates an existing organization

patch/organizations/{organization_id}

Request

  • Base URL: https://api.clerk.com/v1
  • URL: https://api.clerk.com/v1/organizations/{organization_id}
  • Auth: HTTP bearer

Path parameters

organization_idstring required

The ID of the organization to update

Request body

public_metadataobject nullable

Metadata saved on the organization, that is visible to both your frontend and backend. Deprecated: As of API version 2026-05-12, this field is rejected on PATCH /v1/organizations/{organization_id}. Use PATCH /v1/organizations/{organization_id}/metadata to merge updates into existing metadata, or PUT /v1/organizations/{organization_id}/metadata to replace a metadata field entirely.

private_metadataobject nullable

Metadata saved on the organization that is only visible to your backend. Deprecated: As of API version 2026-05-12, this field is rejected on PATCH /v1/organizations/{organization_id}. Use PATCH /v1/organizations/{organization_id}/metadata to merge updates into existing metadata, or PUT /v1/organizations/{organization_id}/metadata to replace a metadata field entirely.

namestring nullable

The new name of the organization. May not contain URLs or HTML. Max length: 256

slugstring nullable

The new slug of the organization, which needs to be unique in the instance

max_allowed_membershipsinteger nullable

The maximum number of memberships allowed for this organization

admin_delete_enabledboolean nullable

If true, an admin can delete this organization with the Frontend API.

self_serve_sso_enabledboolean nullable

Whether this organization can configure self-serve enterprise SSO.

created_atstring nullable

A custom date/time denoting when the organization was created, specified in RFC3339 format (e.g. 2012-10-20T07:15:20.902Z).

role_set_keystring nullable

The key of the role set to assign to this organization.

reassignment_mappingsReassignmentMappings

Mappings from source role keys to destination role keys for role reassignment

Response

An organization

object'organization' required
idstring required
namestring required
slugstring required
image_urlstring
has_imageboolean required
members_countinteger
missing_member_with_elevated_permissionsboolean
pending_invitations_countinteger
max_allowed_membershipsinteger required
admin_delete_enabledboolean required
self_serve_sso_enabledboolean

Whether this organization can configure self-serve enterprise SSO.

public_metadataobject required
private_metadataobject
created_bystring
created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.

last_active_atinteger

Unix timestamp of last activity.

role_set_keystring nullable

The key of the role set assigned to this organization.

Changes

  • 2025-11-10a490313abffaRevision changes
    • warning

      removed the request property

    • warning

      removed the optional property from the response with the status

  • 2025-11-107db12d6a9b2aRevision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status