Skip to main content
PATCH
Update forum
Required permissions:
  • forum:moderate

Autorisaties

Authorization
string
header
vereist

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Scopes

forum:moderate

Padparameters

id
string
vereist

The unique identifier of the forum to update. Accepts either an experience ID (e.g. 'exp_xxxxx') or a forum ID.

Body

application/json

Parameters for UpdateForum

banned_words
string[] | null

A list of words that are automatically blocked from posts in this forum. For example, ['spam', 'scam'].

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

banner_image
FileInputWithId · object | null

The banner image displayed at the top of the forum page. Pass null to remove the existing banner.

email_notification_preference
enum<string> | null

Controls how email notifications are sent to members when new posts are created in this forum.

Beschikbare opties:
all_admin_posts,
only_weekly_summary,
none
who_can_comment
enum<string> | null

Controls which roles are allowed to comment on posts in this forum.

Beschikbare opties:
everyone,
admins
who_can_post
enum<string> | null

Controls which roles are allowed to create new posts in this forum.

Beschikbare opties:
everyone,
admins

Respons

A successful response

A discussion forum where members can create posts, comment, and react, belonging to an experience.

banned_words
string[]
vereist

A list of words that are automatically filtered from posts in this forum.

Represents textual data as UTF-8 character sequences. This type is most often used by GraphQL to represent free-form human-readable text.

banner_image
object | null
vereist

The banner image displayed at the top of the forum page. Null if no banner has been uploaded.

email_notification_preference
enum<string>
vereist

The email notification setting that controls which posts trigger email alerts. One of: all_admin_posts, only_weekly_summary, none.

Beschikbare opties:
all_admin_posts,
only_weekly_summary,
none
experience
object
vereist

The parent experience that this forum belongs to.

id
string
vereist

The unique identifier for the entity

who_can_comment
enum<string>
vereist

The permission level controlling who can comment on posts. One of: everyone, admins.

Beschikbare opties:
everyone,
admins
who_can_post
enum<string>
vereist

The permission level controlling who can create new posts. One of: everyone, admins.

Beschikbare opties:
everyone,
admins