Skip to main content
POST
/
dm_members
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 dmMember = await client.dmMembers.create({
  channel_id: 'channel_id',
  user_id: 'user_xxxxxxxxxxxxx',
});

console.log(dmMember.id);
{
  "id": "<string>",
  "user_id": "<string>",
  "channel_id": "<string>",
  "status": "requested",
  "last_viewed_at": "123.45",
  "notification_preference": "all"
}

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 ***************************

Body

application/json

Parameters for CreateDmMember

​
channel_id
string
required

The unique identifier of the DM channel to add the new member to.

​
user_id
string
required

The unique identifier of the user to add to the DM channel. For example, 'user_xxxxx'.

Example:

"user_xxxxxxxxxxxxx"

Response

A successful response

A user's membership record in a messaging channel, including notification preferences and read state.

​
id
string
required

The unique identifier for the entity

​
user_id
string
required

The unique identifier of the user who holds this channel membership.

​
channel_id
string
required

The unique identifier of the messaging channel this membership belongs to.

​
status
enum<string>
required

The current state of this membership: requested, accepted, hidden, closed, or archived.

Available options:
requested,
accepted,
hidden,
closed,
archived
​
last_viewed_at
string | null
required

The timestamp when this member last viewed the channel, as a Unix timestamp in milliseconds. Null if the member has never viewed the channel.

Example:

"123.45"

​
notification_preference
enum<string>
required

The notification level for this channel: all, mentions, or none.

Available options:
all,
mentions,
none