Skip to main content
POST
/
2
/
chat
/
conversations
/
group
Create Chat Group Conversation
curl --request POST \
  --url https://api.x.com/2/chat/conversations/group \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "conversation_id": "<string>",
  "conversation_key_version": "<string>",
  "conversation_participant_keys": [
    {
      "encrypted_conversation_key": "<string>",
      "public_key_version": "<string>",
      "user_id": "<string>"
    }
  ],
  "group_members": [
    "<string>"
  ],
  "action_signatures": [
    {
      "encoded_message_event_detail": "<string>",
      "message_event_signature": {
        "message_signing_key_info_list": [
          {
            "member_id": "<string>",
            "public_key_version": "<string>",
            "signing_public_key": "<string>"
          }
        ],
        "public_key_version": "<string>",
        "signature": "<string>",
        "signature_version": "<string>",
        "signing_public_key": "<string>"
      },
      "message_id": "<string>",
      "signature_payload": "<string>"
    }
  ],
  "base64_encoded_key_rotation": "<string>",
  "group_admins": [
    "<string>"
  ],
  "group_avatar_url": "<string>",
  "group_description": "<string>",
  "group_name": "<string>",
  "ttl_msec": "<string>"
}
'
{
  "data": {
    "conversation_id": "<string>",
    "conversation_key_change_sequence_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.

Body

application/json
conversation_id
string
required

Client-generated conversation ID.

conversation_key_version
string
required

Version of the conversation encryption key.

conversation_participant_keys
object[]
required

Encrypted conversation keys for each participant.

group_members
string[]
required

User IDs of group members to include in the conversation.

User ID.

action_signatures
object[]

Cryptographic signatures for the create action.

base64_encoded_key_rotation
string

Base64-encoded key rotation payload.

group_admins
string[]

User IDs of group admins. Defaults to the creator if omitted.

User ID.

group_avatar_url
string

URL of the avatar image for the group conversation.

group_description
string

Description for the group conversation.

group_name
string

Display name for the group conversation.

ttl_msec
string

Message time-to-live in milliseconds. Messages expire after this duration.

Response

The request has succeeded.

data
object
errors
object[]
Minimum array length: 1

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