Skip to content
PassionPassion developers

Change a community

PATCH
/apps/{appId}/communities/{communityId}
curl --request PATCH \
  --url https://api.passion.io/v1/apps/example/communities/example \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "summary": "example", "membersCanMessageCreator": true, "membersCanMessageEachOther": true }'

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
appId
required

The id of the App, as Studio shows it.

string
/^[1-9][0-9]*$/
communityId
required

The id of a community, as the App overview lists it.

string
/^[1-9][0-9]*$/

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required

The name of the community. Give the current name to keep it.

string
>= 1 characters
summary

One or two sentences that tell members what the community is for.

string
>= 1 characters
membersCanMessageCreator

Whether members can send the creator a direct message.

boolean
membersCanMessageEachOther

Whether members can send each other direct messages.

boolean
Examplegenerated
{
  "name": "example",
  "summary": "example",
  "membersCanMessageCreator": true,
  "membersCanMessageEachOther": true
}

Responses

Section titled “Responses”

200

Section titled “200”

OK

Media typeapplication/json
object
communityId
required
string
name
required
string
summary
required
Any of:
string
membersCanMessageCreator
required
boolean
membersCanMessageEachOther
required
boolean
Examplegenerated
{
  "communityId": "example",
  "name": "example",
  "summary": "example",
  "membersCanMessageCreator": true,
  "membersCanMessageEachOther": true
}