Remove a member

DELETE

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

Owner and leaders; never the owner; a leader cannot remove a leader. A removed person rejoins only through a leader's invite.

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"

Responses

OK

Content-Type

application/json

{

"data": {

"removed": true,

"additionalProperties": "string"

},

"additionalProperties": "string"

}

DELETE

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

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

key*

userId*

Samples

Powered by VitePress OpenAPI