Skip to main content
PATCH
Update Organization Member Role

Authorizations

x-api-key
string
header
required

API key for authentication. You can create one here.

Path Parameters

user_id
string<uuid>
required

The unique identifier of the target user

Body

application/json

Request body for updating an organization member's role. Provide exactly one of role or role_id.

role
enum<string>

Coarse role to assign. Mutually exclusive with role_id.

Available options:
admin,
viewer
Example:

"admin"

role_id
string

Assign any role by ID — a system role or one of your organization's custom roles (see GET /api/v1/roles). Mutually exclusive with role. Returns 404 if the role does not exist or belongs to another organization. System role IDs are GUID-shaped sentinels (e.g. 00000000-0000-0000-0000-000000000001), not RFC 4122 UUIDs.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example:

"789e0123-e89b-12d3-a456-426614174000"

Response

Member role updated successfully

success
boolean
required
Example:

true

member
object
required