Clerk API (unofficial showcase)
PATCH/organizations/{organization_id}/memberships/{user_id}

Update an organization membership

Updates the properties of an existing organization membership

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 parameters · 1 body field
organization_idstringrequired
The ID of the organization to which this membership belongs
user_idstringrequired
The ID of the user to which this membership belongs
rolestringrequired
The new role of the given membership.

3 status codes
200Success
idstringrequired
objectstringrequired
String representing the object's type. Objects of the same type share the same value.
Allowed:organization_membership
rolestringrequired
role_namestringoptional
permissionsarray<string>required
public_metadataobjectrequired
Metadata saved on the organization membership, accessible from both Frontend and Backend APIs
private_metadataobjectoptional
Metadata saved on the organization membership, accessible only from the Backend API
organizationobjectrequired
public_user_dataobjectoptional
An organization membership with public user data populated
created_atintegerrequired
Unix timestamp of creation.
updated_atintegerrequired
Unix timestamp of last update.
404Resource not found
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional
422Invalid request parameters
errorsarray<object>required
metaobjectoptional
clerk_trace_idstringoptional

Error handling

A 404 is returned: Resource not found. A 422 is returned: Invalid request parameters.