Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Dm members

Create dm member

Add a new user to an existing DM channel. Only an admin of the channel can add members.

Required permissions:

  • dms:channel:manage
post/dm_members

Request body

channel_idstring required

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

user_idstring required

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

Example request

{
  "user_id": "user_xxxxxxxxxxxxx"
}

Response

A successful response

channel_idstring required

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

idstring required

The unique identifier for the entity

last_viewed_atstring nullable 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.

notification_preference'all' | 'mentions' | 'none' required

The notification preferences for a DMs feed member

status'requested' | 'accepted' | 'hidden' | 'closed' | 'archived' required

The statuses of a DMs feed member

user_idstring required

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

Example response

{
  "last_viewed_at": "123.45"
}