Change a member's role
PATCH
/api/v1/users/{id}Requires the admin role. The account owner’s role cannot be changed. Omitting the role leaves the member unchanged — it is never defaulted.
Authorizations
Section titled “Authorizations”Path Parameters
Section titled “Path Parameters”NameType
id
required
string
The record’s prefixed ID
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
user
object
role
string
Responses
Section titled “Responses”200
The updated member
The updated member
Response body
Media typeapplication/json
object
id
string
email
string format: email
name
string
first_name
string
last_name
string
role
string
roles
Array<string>
owner
boolean
True for the account owner
created_at
string format: date-time
When the membership was created
updated_at
string format: date-time
403
Insufficient scope, role, or credits
Insufficient scope, role, or credits
Response body
Media typeapplication/json
object
error
object
code
string
A stable machine-readable code
message
string
details
Array<string>
Present on validation errors; one entry per failed validation
422
The record could not be saved
The record could not be saved
Response body
Media typeapplication/json
object
error
object
code
string
A stable machine-readable code
message
string
details
Array<string>
Present on validation errors; one entry per failed validation