Organizations

Replace metadata for an organization

Changed on

Replace an organization's metadata attributes with the provided values. Unlike PATCH /v1/organizations/{organization_id}/metadata (merge semantics), this endpoint replaces the supplied metadata fields entirely — the prior contents of each supplied field are discarded. Fields omitted from the request body are left unchanged. Prefer the PATCH endpoint for partial updates. Use PUT only when you explicitly intend to overwrite a metadata field wholesale.

put/organizations/{organization_id}/metadata

Request

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

Path parameters

organization_idstring required

The ID of the organization whose metadata will be replaced

Request body

public_metadataobject

Metadata saved on the organization, that is visible to both your frontend and backend. The existing value will be replaced entirely with the new object.

private_metadataobject

Metadata saved on the organization that is only visible to your backend. The existing value will be replaced entirely with the new object.

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 optional property from the response with the status

  • 2025-11-107db12d6a9b2aRevision changes
    • info

      added the optional property to the response with the status