Skip to main content
PATCH
/
forums
/
{id}
JavaScript
import Whop from '@whop/sdk';

const client = new Whop({
  apiKey: process.env['WHOP_API_KEY'], // This is the default and can be omitted
});

const forum = await client.forums.update('id');

console.log(forum.id);
{
  "id": "<string>",
  "experience": {
    "id": "exp_xxxxxxxxxxxxxx",
    "name": "Trading Signals Chat"
  },
  "who_can_post": "everyone",
  "who_can_comment": "everyone",
  "email_notification_preference": "all_admin_posts"
}

Authorizations

​
Authorization
string
header
required

A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************

Path Parameters

​
id
string
required

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

​
banner_image
FileInputWithId · object

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.

Available options:
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.

Available options:
everyone,
admins
​
who_can_post
enum<string> | null

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

Available options:
everyone,
admins

Response

A successful response

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

​
id
string
required

The unique identifier for the entity

​
experience
object
required

The parent experience that this forum belongs to.

​
who_can_post
enum<string>
required

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

Available options:
everyone,
admins
​
who_can_comment
enum<string>
required

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

Available options:
everyone,
admins
​
email_notification_preference
enum<string>
required

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

Available options:
all_admin_posts,
only_weekly_summary,
none