Initialize Chat Group

Initializes a new XChat group conversation and returns a unique conversation ID.

This endpoint is the first step in creating a group chat. The returned conversation_id should be used in subsequent calls to POST /chat/conversations/group to fully create and configure the group with members, admins, encryption keys, and other settings.

Workflow:

Call this endpoint to get a conversation_id
Use that conversation_id when calling POST /chat/conversations/group to create the group

Authentication:

Requires OAuth 1.0a User Context or OAuth 2.0 User Context
Required scope: dm.write

POST

chat

conversations

group

initialize

Initialize Chat Group

curl --request POST \
  --url https://api.x.com/2/chat/conversations/group/initialize \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "conversation_id": "<string>"
  },
  "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.

Response

The request has succeeded.

data

object

Show child attributes

errors

object[]

Minimum array length: 1

An HTTP Problem Details object, as defined in IETF RFC 7807 (https://tools.ietf.org/html/rfc7807).

Show child attributes

Initialize Chat Group

curl --request POST \
  --url https://api.x.com/2/chat/conversations/group/initialize \
  --header 'Authorization: Bearer <token>'

{
  "data": {
    "conversation_id": "<string>"
  },
  "errors": [
    {
      "title": "<string>",
      "type": "<string>",
      "detail": "<string>",
      "status": 123
    }
  ]
}