Invite people
POST
/communities/{key}/invites
By email or account. Invites expire after 14 days. A volunteer role needs a leader; a leader role needs the owner.
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
Requiredstring
Request Body
application/json
JSON
{
"emails": [
"string"
],
"user_ids": [
"string"
],
"role": "string",
"additionalProperties": "string"
}
Responses
OK
application/json
JSON
{
"data": {
"invited": 0,
"invites": [
{
"additionalProperties": "string"
}
],
"skipped": [
{
"additionalProperties": "string"
}
],
"additionalProperties": "string"
},
"remaining_today": 0,
"additionalProperties": "string"
}