Sign in
Dm channels

Create dm channel

Create a new DM channel between two or more users, optionally scoped to a specific company. Returns the existing channel if one already exists.

Required permissions:

  • dms:channel:manage
post/dm_channels

Request body

account_idstring nullable

The unique identifier of the company to scope this DM channel to. When set, the channel is visible only within that company context.

custom_namestring nullable

A custom display name for the DM channel. For example, 'Project Discussion'.

notifications_enabledboolean nullable

Whether Whop app notifications are enabled for this direct message channel. Webhooks still fire.

with_user_idsstring[] required

The list of user identifiers to include in the DM channel. Each entry can be an email, username, or user ID (e.g. 'user_xxxxx').

Example request

{
  "account_id": "biz_xxxxxxxxxxxxxx"
}

Response

A successful response

created_atstring required

The time the entity was created (in milliseconds since Unix epoch)

idstring required

The unique identifier for the entity

last_message_atstring date-time nullable required

The timestamp when the most recent message was sent in this channel. Null if no messages have been sent.

namestring nullable required

A custom display name assigned to this channel by the user. Null if no custom name has been set.

Example response

{
  "created_at": "123.45",
  "last_message_at": "2023-12-01T05:00:00.401Z",
  "name": "Project Alpha Team"
}

Changes

Changed in 3 of the 74 revisions of this API.13

  • 697924df40d111See the full diff
    • ●

      removed the request property

      request-property-removed

    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 9 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • a84d4905fdbb1See the full diff
    • ○

      the security scope dms:channel:manage was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6c970f803b461See the full diff
    • ○

      added the new optional request property

      new-optional-request-property

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 74 revisions, 1 has no diff computed.