Update a subcommunity

Updates a subcommunity in the community associated with your API key. The response is a Subcommunity object.

How fields are updated

  • Omitted fields are left unchanged.
  • Fields set to a value are updated.
  • description set to null is cleared. It’s the only field that can be cleared.

Updating keywords

Sending keywords replaces the entire list. It doesn’t add to it. To add a keyword, send the full list with the new keyword included. To remove one, send the full list without it.

Once a keyword is removed, members can no longer text it to join.

Titles

title must stay unique within your community.

Path Params
uuid
required

The subcommunity's identifier.

Body Params
string
^#?[0-9a-fA-F]{6}$

Hex value, e.g. #414B58.

string | null

Free text shown to the client team. Null clears it.

keywords
array of strings
length ≤ 15

Keywords a member can text to join. Sending this field replaces the full set.

keywords
string
length ≤ 60

The subcommunity's name, unique per client.

Responses

Callback
Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json