Sign in

v13

latestOpenAPI 3.0.3MITraw.githubusercontent.com2026-08-04237161688.6 KB
Organization Memberships

Merge and update organization membership metadata

Update an organization membership's metadata attributes by merging existing values with the provided parameters. Metadata values will be updated via a deep merge. Deep means that any nested JSON objects will be merged as well. You can remove metadata keys at any level by setting their value to null.

patch/organizations/{organization_id}/memberships/{user_id}/metadata

Path parameters

organization_idstring required

The ID of the organization to which this membership belongs

user_idstring required

The ID of the user to which this membership belongs

Request body

public_metadataobject

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

private_metadataobject

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

Response

Success

idstring required
object'organization_membership' required

String representing the object's type. Objects of the same type share the same value.

rolestring required
role_namestring
permissionsstring[] required
public_metadataobject required

Metadata saved on the organization membership, accessible from both Frontend and Backend APIs

private_metadataobject

Metadata saved on the organization membership, accessible only from the Backend API

created_atinteger required

Unix timestamp of creation.

updated_atinteger required

Unix timestamp of last update.