Replace Clerk organization metadata

Replace one metadata object for a Clerk organization.

← All Clerk endpoints · Capability overview

PUT/v1/clerk/organizations/{organization_id}/metadata/{metadata_type}

https://api.vee3.io/v1/clerk/organizations/{organization_id}/metadata/{metadata_type}

8 tokens

Replace one metadata object for a Clerk organization.

Authorization

Send your API key in the Authorization header:

Authorization: Bearer YOUR_API_KEY

MCP

The same capability is available as an MCP tool on Vee3 hosted MCP.

Tool name

clerk.replace_organization_metadata

Parameters4 fields

clerk_instance_idstringOptional

Clerk instance id (ins_...) from clerk.get_connected_accounts. Omit to use the default connected account.

organization_idstringRequired

Clerk organization id (org_...) to operate on.

metadata_type"public" | "private"Required

Metadata type to replace: "public" or "private".

metadataobjectRequired

New metadata object to set (replaces all existing keys).

Response6 fields

organizationobject

5 fields

Updated Clerk organization summary.

idstring

Clerk organization id (org_...).

namestring

Organization display name.

slugstring

URL-friendly organization slug, if set.

members_countinteger

Current number of members in the organization.

created_atinteger

Unix timestamp in milliseconds when the organization was created.

HTTP errors: clerk_connection_required, clerk_connection_not_found, clerk_connection_invalid, validation_error, unauthorized, payment_required

Example request

Python

import requests

url = "https://api.vee3.io/v1/clerk/organizations/{organization_id}/metadata/{metadata_type}"
headers = {
    "Authorization": "Bearer YOUR_API_KEY",
}
payload = {
    "organization_id": "org_2xyz789",
    "metadata_type": "public",
    "metadata": {"plan":"enterprise"}
}

response = requests.post(url, headers=headers, json=payload)
response.raise_for_status()
data = response.json()
print(data)

Example responses1 example

200Organization after a metadata replacement.

replaced_metadata.json

{
  "organization": {
    "id": "org_2abc123",
    "name": "Acme Corp",
    "slug": "acme-corp",
    "members_count": 12,
    "created_at": 1710000000000
  }
}