Update Community

The update community method works by providing moderators or a creator of the community with a way to modify various aspects of their community settings. For example, moderators can update the community name, description, or avatar to reflect changes in the community. They can also update the post settings to control who can create posts in the community.

  • displayName - allows users to set the public display name of the community, which will be visible to other users who can access the community.

  • description - allows users to provide a description of the community, which can help other users understand the purpose and focus of the community.

  • isPublic - is used to specify the type of the community. Setting it to false will create a private community, while setting it to true will create a public community.

  • postSettings - allows users to customize the community post settings. This parameter can be used to configure how posts are moderated within the community, depending on the specific needs and preferences of the community creator.

  • storySettings - allows users to customize the community story settings. This parameter can be used to configure whether to enable comment interaction on stories.

  • metaData - allows users to include additional properties to support custom fields within the community. This can be useful for creating communities with specific requirements or features that are not available by default in our platform.

By default, only the original creator of the community or the system administrators can update the community.

Last updated