Update a Chat group conversation
Renames an encrypted Chat group conversation, changes its avatar, or sets its description. The client encrypts each value with the conversation key and lists the values it changed in modified_fields.
curl --request PUT \
--url https://api.x.com/2/chat/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_key_version": "<string>",
"modified_fields": [],
"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>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"group_avatar_url": "<string>",
"group_description": "<string>",
"group_name": "<string>",
"rotated_pmk_bundle": [
{
"base64_encoded_encrypted_pmk": "<string>",
"message_sequence_id": "<string>",
"pme_sequence_id": "<string>"
}
]
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}"
payload = {
"conversation_key_version": "<string>",
"modified_fields": [],
"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>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"group_avatar_url": "<string>",
"group_description": "<string>",
"group_name": "<string>",
"rotated_pmk_bundle": [
{
"base64_encoded_encrypted_pmk": "<string>",
"message_sequence_id": "<string>",
"pme_sequence_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_key_version: '<string>',
modified_fields: [],
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>',
conversation_participant_keys: [
{
encrypted_conversation_key: '<string>',
public_key_version: '<string>',
user_id: '<string>'
}
],
group_avatar_url: '<string>',
group_description: '<string>',
group_name: '<string>',
rotated_pmk_bundle: [
{
base64_encoded_encrypted_pmk: '<string>',
message_sequence_id: '<string>',
pme_sequence_id: '<string>'
}
]
})
};
fetch('https://api.x.com/2/chat/conversations/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'conversation_key_version' => '<string>',
'modified_fields' => [
],
'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>',
'conversation_participant_keys' => [
[
'encrypted_conversation_key' => '<string>',
'public_key_version' => '<string>',
'user_id' => '<string>'
]
],
'group_avatar_url' => '<string>',
'group_description' => '<string>',
'group_name' => '<string>',
'rotated_pmk_bundle' => [
[
'base64_encoded_encrypted_pmk' => '<string>',
'message_sequence_id' => '<string>',
'pme_sequence_id' => '<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/{id}"
payload := strings.NewReader("{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.x.com/2/chat/conversations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"conversation_key_change_sequence_id": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The ID of the group conversation, starting with g.
^g[0-9]{1,19}$Body
Version of the conversation key the values are encrypted with.
^[0-9]{1,19}$The group values this request changes.
1group_name, group_avatar_url, group_description Cryptographic signatures for the action.
Show child attributes
Show child attributes
Base64-encoded key rotation payload.
Encrypted conversation keys for each participant.
Show child attributes
Show child attributes
Encrypted group avatar URL.
Encrypted group description.
Encrypted group name.
Message keys re-encrypted with the rotated conversation key.
Show child attributes
Show child attributes
curl --request PUT \
--url https://api.x.com/2/chat/conversations/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"conversation_key_version": "<string>",
"modified_fields": [],
"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>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"group_avatar_url": "<string>",
"group_description": "<string>",
"group_name": "<string>",
"rotated_pmk_bundle": [
{
"base64_encoded_encrypted_pmk": "<string>",
"message_sequence_id": "<string>",
"pme_sequence_id": "<string>"
}
]
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}"
payload = {
"conversation_key_version": "<string>",
"modified_fields": [],
"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>",
"conversation_participant_keys": [
{
"encrypted_conversation_key": "<string>",
"public_key_version": "<string>",
"user_id": "<string>"
}
],
"group_avatar_url": "<string>",
"group_description": "<string>",
"group_name": "<string>",
"rotated_pmk_bundle": [
{
"base64_encoded_encrypted_pmk": "<string>",
"message_sequence_id": "<string>",
"pme_sequence_id": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
conversation_key_version: '<string>',
modified_fields: [],
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>',
conversation_participant_keys: [
{
encrypted_conversation_key: '<string>',
public_key_version: '<string>',
user_id: '<string>'
}
],
group_avatar_url: '<string>',
group_description: '<string>',
group_name: '<string>',
rotated_pmk_bundle: [
{
base64_encoded_encrypted_pmk: '<string>',
message_sequence_id: '<string>',
pme_sequence_id: '<string>'
}
]
})
};
fetch('https://api.x.com/2/chat/conversations/{id}', 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/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'conversation_key_version' => '<string>',
'modified_fields' => [
],
'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>',
'conversation_participant_keys' => [
[
'encrypted_conversation_key' => '<string>',
'public_key_version' => '<string>',
'user_id' => '<string>'
]
],
'group_avatar_url' => '<string>',
'group_description' => '<string>',
'group_name' => '<string>',
'rotated_pmk_bundle' => [
[
'base64_encoded_encrypted_pmk' => '<string>',
'message_sequence_id' => '<string>',
'pme_sequence_id' => '<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/{id}"
payload := strings.NewReader("{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("PUT", 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.put("https://api.x.com/2/chat/conversations/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"conversation_key_version\": \"<string>\",\n \"modified_fields\": [],\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 \"conversation_participant_keys\": [\n {\n \"encrypted_conversation_key\": \"<string>\",\n \"public_key_version\": \"<string>\",\n \"user_id\": \"<string>\"\n }\n ],\n \"group_avatar_url\": \"<string>\",\n \"group_description\": \"<string>\",\n \"group_name\": \"<string>\",\n \"rotated_pmk_bundle\": [\n {\n \"base64_encoded_encrypted_pmk\": \"<string>\",\n \"message_sequence_id\": \"<string>\",\n \"pme_sequence_id\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true,
"conversation_key_change_sequence_id": "<string>"
},
"errors": [
{
"detail": "<string>",
"resource_type": "<string>",
"title": "<string>",
"type": "https://api.x.com/2/problems/resource-not-found",
"parameter": "<string>",
"resource_id": "<string>",
"status": 123,
"value": "<string>"
}
]
}{
"code": 123,
"message": "<string>"
}