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

const client = new Whop({
  appID: 'app_xxxxxxxxxxxxxx',
  apiKey: 'My API Key',
});

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

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

Authorizations

​
Authorization
string
header
required

The app API key from an app from the /dashboard/developer page

Path Parameters

​
id
string
required

Experience ID (exp_*) or Forum external ID

Body

application/json

Parameters for UpdateForum

​
email_notification_preference
enum<string> | null

The email notification preference for this forum Email notification preference option for a forum feed

Available options:
all_admin_posts,
only_weekly_summary,
none
​
who_can_comment
enum<string> | null

Who can comment on this forum Who can comment on a forum feed

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

Who can post on this forum Who can post on a forum feed

Available options:
everyone,
admins

Response

A successful response

Represents a forum feed

​
id
string
required

The unique identifier for the entity

​
experience
object
required

The experience for this forum

​
who_can_post
enum<string>
required

Who can post on this forum

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

Who can comment on this forum

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

The email notification preference for this forum

Available options:
all_admin_posts,
only_weekly_summary,
none