Skip to content

Add people​

POST
/communities/{key}/members

Adds where the person's setting allows it, otherwise sends an invite. Up to 50 adds and invites a day per person. Added people get one notification with a Leave action.

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

Request Body​

application/json
JSON
{
"user_ids": [
"string"
],
"additionalProperties": "string"
}

Responses​

OK

application/json
JSON
{
"data": {
"added": [
"string"
],
"invited": [
"string"
],
"skipped": [
"string"
],
"skipped_reasons": {
"additionalProperties": "string"
},
"additionalProperties": "string"
},
"remaining_today": 0,
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value
Body

Samples​

Powered by VitePress OpenAPI

Built with VitePress