Community management

Update the community identified by the provided authorisation API key.

Changed on
post/community

Request

  • Base URL: ${apiUrl} (relative, and the document was published on a file host, not at the API’s origin)
  • URL: ${apiUrl}/community
  • Auth: API key in header ITB_API_KEY

Request body

shortNamestring

The community's short name. Skip this if no update should be made.

fullNamestring

The community's full name. Skip this if no update should be made.

descriptionstring

The community's description. Skip this if no update should be made or set to an empty string to remove the current value.

supportEmailstring

A support email address to receive community-specific notifications at. Skip this if no update should be made or set to an empty string to remove the current value.

interactionNotificationsboolean

Whether to receive notifications for pending interactions by email at the support mailbox (see supportEmail). Skip this if no update should be made.

domainstring

The API key identifying a domain that should be linked to the community. Skip this if no update should be made or set to an empty string to unlink the community from its existing domain (without deleting the domain).

Response

Community updated.

Changes

  • 26fb91f21fa6Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

  • 433b3c0ae6d4Revision changes
    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status

    • info

      removed the non-success response with the status