Change a member's role

PATCH

/communities/{key}/members/{userId}

Leaders change roles below leader; only the owner makes or unmakes leaders. 409 LEADER_LIMIT past 10 leaders, the owner included.

Authorizations

BearerAuth

In the browser, authentication rides on the httpOnly session cookies set by /cognito/signin or the Google / Apple sign-in at /cognito/oauth/{provider}. For scripts and for Swagger UI testing, paste an API key (fh_live_…, created with POST /api-keys); a Cognito JWT is accepted too. Sign-in does not return a token in its body.

Type

HTTP (bearer)

Parameters

Path Parameters

key*

The community's slug or uuid.

Type

string

Required

userId*

Type

string

Required

Format

"uuid"

Request Body

application/json

{

"role": "string",

"additionalProperties": "string"

}

Responses

OK

Content-Type

application/json

{

"data": {

"user_id": "string",

"role": "string",

"additionalProperties": "string"

},

"additionalProperties": "string"

}

PATCH

/communities/{key}/members/{userId}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

key*

userId*

Body

Samples

Powered by VitePress OpenAPI