Create DM conversation

Initiates a new direct message conversation with specified participants.

POST /2/dm_conversations

Try it

Create DM conversation

cURL

curl --request POST \
  --url https://api.x.com/2/dm_conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversation_type": "Group",
  "message": {
    "text": "<string>",
    "attachments": [
      {
        "media_id": "1146654567674912769"
      }
    ]
  },
  "participant_ids": [
    "2244994945"
  ]
}
'

201

{
  "data": {
    "dm_conversation_id": "123123123-456456456",
    "dm_event_id": "1146654567674912769"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json

conversation_type · enum<string> · required

The conversation type that is being created.

Available options: Group

message · object · required

Option 1

Show child attributes

message. text · string · required

Text of the message.

Minimum string length: 1

message. attachments · object[]

Attachments to a DM Event.

Show child attributes

message.attachments. media_id · string · required

The unique identifier of this Media.

Example:

"1146654567674912769"

participant_ids · string[] · required

Participants for the DM Conversation.

Required array length: 2 - 49 elements

Unique identifier of this User. This is returned as a string in order to avoid complications with languages and tools that cannot handle large integers.

Response

201

application/json

The request has succeeded.

data · object

Show child attributes

data. dm_conversation_id · string · required

Unique identifier of a DM conversation. This can either be a numeric string, or a pair of numeric strings separated by a '-' character in the case of one-on-one DM Conversations.

Example:

"123123123-456456456"

data. dm_event_id · string · required

Unique identifier of a DM Event.

Example:

"1146654567674912769"

errors · object[]

Minimum array length: 1

Show child attributes

errors. title · string · required

errors. type · string · required

errors. detail · string

errors. status · integer