Skip to main content
PATCH
Change a member's role

Authorizations

X-API-Key
string
header
required

API key

Path Parameters

membership_id
string
required
Pattern: ^[A-Za-z0-9_]{1,64}$

Body

application/json
role
enum<string>
required
Available options:
owner,
admin,
underwriter,
viewer

Response

Successful Response

id
string
required

The WorkOS organization membership id: PATCH / DELETE /v1/members/{id}

user_id
string
required
email
string
required
first_name
string | null
required
last_name
string | null
required
role
string | null
required
status
string
required
created_at
string<date-time>
required