Community management

Create a community.

Changed on
put/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 required

The community's short name.

fullNamestring required

The community's full name.

descriptionstring

The community's description.

supportEmailstring

A support email address to receive community-specific notifications at.

interactionNotificationsboolean

Whether to receive notifications for pending interactions by email at the support mailbox (see supportEmail).

apiKeystring

The API key to set for the community. If this key is already assigned, a new one will be generated.

domainstring

The API key identifying a domain that should be linked to the community.

Response

Community created.

apiKeystring required

The API key value.

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

    • 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