Dm channels

Update dm channel

Changed on

Updates a DM channel's settings, such as its display name. Only a channel admin can update it.

Required permissions (one of):

  • dms:channel:manage
  • support_chat:create
patch/dm_channels/{id}

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/dm_channels/{id}
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

The unique identifier of the DM channel to update.

Request body

custom_namestring nullable

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

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

  • 507636677fe9Revision changes
    • info

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

    • info

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth

  • c3b5561c6176Revision changes
    • info

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

    • info

      the security scope support_chat:create was removed from the endpoint's security scheme bearerAuth