Create Chat Group Conversation

Creates a new encrypted Chat group conversation on behalf of the authenticated user.

POST /2/chat/conversations/group

Create Chat Group Conversation

cURL

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": {
        "public_key_version": "<string>",
        "signature": "<string>",
        "signature_version": "<string>",
        "message_signing_key_info_list": [
          {
            "member_id": "<string>",
            "public_key_version": "<string>",
            "signing_public_key": "<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>"
}
'

import requests

url = "https://api.x.com/2/chat/conversations/group"

payload = {
    "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": {
                "public_key_version": "<string>",
                "signature": "<string>",
                "signature_version": "<string>",
                "message_signing_key_info_list": [
                    {
                        "member_id": "<string>",
                        "public_key_version": "<string>",
                        "signing_public_key": "<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>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    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: {
          public_key_version: '<string>',
          signature: '<string>',
          signature_version: '<string>',
          message_signing_key_info_list: [
            {
              member_id: '<string>',
              public_key_version: '<string>',
              signing_public_key: '<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>'
  })
};

fetch('https://api.x.com/2/chat/conversations/group', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.x.com/2/chat/conversations/group",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    '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' => [
                                'public_key_version' => '<string>',
                                'signature' => '<string>',
                                'signature_version' => '<string>',
                                'message_signing_key_info_list' => [
                                                                [
                                                                                                                                'member_id' => '<string>',
                                                                                                                                'public_key_version' => '<string>',
                                                                                                                                'signing_public_key' => '<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>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.x.com/2/chat/conversations/group"

	payload := strings.NewReader("{\n  \"conversation_id\": \"<string>\",\n  \"conversation_key_version\": \"<string>\",\n  \"conversation_participant_keys\": [\n    {\n      \"encrypted_conversation_key\": \"<string>\",\n      \"public_key_version\": \"<string>\",\n      \"user_id\": \"<string>\"\n    }\n  ],\n  \"group_members\": [\n    \"<string>\"\n  ],\n  \"action_signatures\": [\n    {\n      \"encoded_message_event_detail\": \"<string>\",\n      \"message_event_signature\": {\n        \"public_key_version\": \"<string>\",\n        \"signature\": \"<string>\",\n        \"signature_version\": \"<string>\",\n        \"message_signing_key_info_list\": [\n          {\n            \"member_id\": \"<string>\",\n            \"public_key_version\": \"<string>\",\n            \"signing_public_key\": \"<string>\"\n          }\n        ],\n        \"signing_public_key\": \"<string>\"\n      },\n      \"message_id\": \"<string>\",\n      \"signature_payload\": \"<string>\"\n    }\n  ],\n  \"base64_encoded_key_rotation\": \"<string>\",\n  \"group_admins\": [\n    \"<string>\"\n  ],\n  \"group_avatar_url\": \"<string>\",\n  \"group_description\": \"<string>\",\n  \"group_name\": \"<string>\",\n  \"ttl_msec\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.x.com/2/chat/conversations/group")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"conversation_id\": \"<string>\",\n  \"conversation_key_version\": \"<string>\",\n  \"conversation_participant_keys\": [\n    {\n      \"encrypted_conversation_key\": \"<string>\",\n      \"public_key_version\": \"<string>\",\n      \"user_id\": \"<string>\"\n    }\n  ],\n  \"group_members\": [\n    \"<string>\"\n  ],\n  \"action_signatures\": [\n    {\n      \"encoded_message_event_detail\": \"<string>\",\n      \"message_event_signature\": {\n        \"public_key_version\": \"<string>\",\n        \"signature\": \"<string>\",\n        \"signature_version\": \"<string>\",\n        \"message_signing_key_info_list\": [\n          {\n            \"member_id\": \"<string>\",\n            \"public_key_version\": \"<string>\",\n            \"signing_public_key\": \"<string>\"\n          }\n        ],\n        \"signing_public_key\": \"<string>\"\n      },\n      \"message_id\": \"<string>\",\n      \"signature_payload\": \"<string>\"\n    }\n  ],\n  \"base64_encoded_key_rotation\": \"<string>\",\n  \"group_admins\": [\n    \"<string>\"\n  ],\n  \"group_avatar_url\": \"<string>\",\n  \"group_description\": \"<string>\",\n  \"group_name\": \"<string>\",\n  \"ttl_msec\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.x.com/2/chat/conversations/group")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"conversation_id\": \"<string>\",\n  \"conversation_key_version\": \"<string>\",\n  \"conversation_participant_keys\": [\n    {\n      \"encrypted_conversation_key\": \"<string>\",\n      \"public_key_version\": \"<string>\",\n      \"user_id\": \"<string>\"\n    }\n  ],\n  \"group_members\": [\n    \"<string>\"\n  ],\n  \"action_signatures\": [\n    {\n      \"encoded_message_event_detail\": \"<string>\",\n      \"message_event_signature\": {\n        \"public_key_version\": \"<string>\",\n        \"signature\": \"<string>\",\n        \"signature_version\": \"<string>\",\n        \"message_signing_key_info_list\": [\n          {\n            \"member_id\": \"<string>\",\n            \"public_key_version\": \"<string>\",\n            \"signing_public_key\": \"<string>\"\n          }\n        ],\n        \"signing_public_key\": \"<string>\"\n      },\n      \"message_id\": \"<string>\",\n      \"signature_payload\": \"<string>\"\n    }\n  ],\n  \"base64_encoded_key_rotation\": \"<string>\",\n  \"group_admins\": [\n    \"<string>\"\n  ],\n  \"group_avatar_url\": \"<string>\",\n  \"group_description\": \"<string>\",\n  \"group_name\": \"<string>\",\n  \"ttl_msec\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

201

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

{
  "code": 123,
  "message": "<string>"
}

Authorizations

OAuth2UserTokenUserToken

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.

Show child attributes

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.

Show child attributes

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

201

application/json

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).

Option 1

Option 2

Option 3

Option 4

Option 5

Option 6

Option 7

Option 8

Option 9

Option 10

Option 11

Option 12

Option 13

Option 14

Option 15

Option 16

Option 17

Option 18

Show child attributes