Update a community

PATCH

/communities/{key}

Owner and leaders. Plan fields (membership, prices, perks, leaders_join_free) are owner only and follow the paid-membership rules. publish: true turns a draft live. Attribute CRUD: audit-logged, no event.

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

{

"publish": true,

"additionalProperties": "string"

}

Responses

OK

Content-Type

application/json

{

"data": "string",

"additionalProperties": "string"

}

PATCH

/communities/{key}

Playground

Server

Authorization

BearerAuth

Variables

Key

Value

key*

Body

Samples

Powered by VitePress OpenAPI