Skip to content

Delete a community​

DELETE
/communities/{key}

Owner only. A soft delete; 409 HAS_MONEY while the fund holds money or memberships are paying.

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

Responses​

OK

application/json
JSON
{
"data": {
"deleted": true,
"additionalProperties": "string"
},
"additionalProperties": "string"
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

Built with VitePress