Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.opigno.com/llms.txt

Use this file to discover all available pages before exploring further.

Opigno Enterprise API provides the editCommunity mutation to update the community data. The community can be edited only by the owner or a user associated wit the ADMINISTRATOR scope.
Community editing is implemented with a “patch” method. This means that only values that need to be updated should be sent.
Mutation accepts the following arguments:
ArgumentTypeDescription
communityIdIDRequired. ID of the community that should be updated.
dataEditCommunityInputRequired. Contains the object with the community data that should be updated.

​
EditCommunityInput object

ParameterTypeDescriptionDefault
titleStringThe community title. Leave empty to keep it unchanged.—
descriptionStringThe community description. Available HTML tags are: <br>, <p>, <h2>, <h3>, <h4>, <h5>, <h6>, <strong>, <em>, <u>, <s>, <sub>, <sup>, <a href>, <ul>, <ol start>, <li>. Any other tag will trimmed. Leave empty to keep it unchanged.—
visibilityCommunityVisibilityThe community visibility. Leave empty to keep it unchanged.—
postNotificationEnabledBooleanA flag that indicates that a notification about a new post is enabled. Leave empty to keep it unchanged.—
imageBase64UploadedFileInputThe community image formatted as base64 string. Leave empty to keep it unchanged.—
removeImageBooleanSince image is the only optional property in Community object, it can be removed. To remove the image, set the value to true.false
  mutation editCommunity {
    editCommuntiy(
      communityId: 2,
      data: {
        title: "The updated community title",
        description: "<p>The updated community description.</p>",
        visibility: PRIVATE
      }
    ) {
      errors
      response {
        id
        title
        visibility
        description
        created
        image {
          url
        }
        lastPostTime
        membersNumber
        postNotificationEnabled
      }
    }
  }
The mutation returns a Community object. Detailed description and the full list of available properties can be found here.