Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Forums

Update forum

Update moderation and notification settings for a forum, such as who can post, who can comment, and email notification preferences.

Required permissions:

  • forum:moderate
patch/forums/{id}

Path parameters

idstring required

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

Request body

banned_wordsstring[] nullable

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

email_notification_preference'all_admin_posts' | 'only_weekly_summary' | 'none'

Email notification preference option for a forum feed

who_can_comment'everyone' | 'admins'

Who can comment on a forum feed

who_can_post'everyone' | 'admins'

Who can post on a forum feed

Response

A successful response

email_notification_preference'all_admin_posts' | 'only_weekly_summary' | 'none' required

Email notification preference option for a forum feed

idstring required

The unique identifier for the entity

who_can_comment'everyone' | 'admins' required

Who can comment on a forum feed

who_can_post'everyone' | 'admins' required

Who can post on a forum feed

Example response

{
  "experience": {
    "id": "exp_xxxxxxxxxxxxxx",
    "name": "Trading Signals Chat"
  }
}