Skip to content
GitHub

Change a member's role.

PATCH
/api/v1/members/{member}
curl --request PATCH \
--url https://example.com/api/v1/members/example \
--header 'Content-Type: application/json' \
--data '{ "role": "example" }'
member
required
string

User id

Media typeapplication/json
object
role
required
string
Examplegenerated
{
"role": "example"
}
Media typeapplication/json
object
id
required
string
email
required
string
display_name
string | null
role
required
string
must_change_password
required

Invited and has not replaced the temporary password yet.

boolean
active
required
boolean
Examplegenerated
{
"id": "example",
"email": "example",
"display_name": "example",
"role": "example",
"must_change_password": true,
"active": true
}
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}
Media typeapplication/json

Problem Details body.

object
code
required

Stable machine-readable code, e.g. forbidden.

string
title
required

Short human readable title.

string
status
required

HTTP status.

integer format: int32
detail

Details, if safe to expose.

string | null
Example
{
"code": "forbidden"
}