Group admins
Update the admin-only settings of a Chat group conversation
Sets which actions only admins can perform in an existing encrypted Chat group conversation. A setting set to true restricts that action to admins, and false opens it to all members. Setting send_message to true makes the group announcement-only. Omitted settings keep their stored value. When sending action_signatures, sign over the full merged settings: the stored values with this request’s changes applied, not only the settings in the request.
PUT
/
2
/
chat
/
conversations
/
{id}
/
admin_settings
Update the admin-only settings of a Chat group conversation
curl --request PUT \
--url https://api.x.com/2/chat/conversations/{id}/admin_settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"add_member": true,
"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>"
}
],
"block_screen_capture": true,
"edit_group_info": true,
"edit_message_ttl": true,
"send_message": true,
"start_call": true
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/admin_settings"
payload = {
"add_member": True,
"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>"
}
],
"block_screen_capture": True,
"edit_group_info": True,
"edit_message_ttl": True,
"send_message": True,
"start_call": True
}
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({
add_member: true,
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>'
}
],
block_screen_capture: true,
edit_group_info: true,
edit_message_ttl: true,
send_message: true,
start_call: true
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/admin_settings', 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}/admin_settings",
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([
'add_member' => true,
'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>'
]
],
'block_screen_capture' => true,
'edit_group_info' => true,
'edit_message_ttl' => true,
'send_message' => true,
'start_call' => true
]),
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}/admin_settings"
payload := strings.NewReader("{\n \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\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}/admin_settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/admin_settings")
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 \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true
},
"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
OAuth2UserTokenUserToken
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.
Pattern:
^g[0-9]{1,19}$Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
- Option 5
- Option 6
At least one of add_member, edit_group_info, send_message, start_call, edit_message_ttl, block_screen_capture is required.
When true, only admins can add members.
Cryptographic signatures for the action.
Show child attributes
Show child attributes
When true, only admins can change screen capture blocking. Through the API, only admins can change screen capture in a group, whatever this setting says.
When true, only admins can edit the group name, avatar, and description.
When true, only admins can change the disappearing-message timer.
When true, only admins can send messages.
When true, only admins can start calls.
⌘I
Update the admin-only settings of a Chat group conversation
curl --request PUT \
--url https://api.x.com/2/chat/conversations/{id}/admin_settings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"add_member": true,
"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>"
}
],
"block_screen_capture": true,
"edit_group_info": true,
"edit_message_ttl": true,
"send_message": true,
"start_call": true
}
'import requests
url = "https://api.x.com/2/chat/conversations/{id}/admin_settings"
payload = {
"add_member": True,
"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>"
}
],
"block_screen_capture": True,
"edit_group_info": True,
"edit_message_ttl": True,
"send_message": True,
"start_call": True
}
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({
add_member: true,
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>'
}
],
block_screen_capture: true,
edit_group_info: true,
edit_message_ttl: true,
send_message: true,
start_call: true
})
};
fetch('https://api.x.com/2/chat/conversations/{id}/admin_settings', 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}/admin_settings",
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([
'add_member' => true,
'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>'
]
],
'block_screen_capture' => true,
'edit_group_info' => true,
'edit_message_ttl' => true,
'send_message' => true,
'start_call' => true
]),
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}/admin_settings"
payload := strings.NewReader("{\n \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\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}/admin_settings")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/chat/conversations/{id}/admin_settings")
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 \"add_member\": true,\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 \"block_screen_capture\": true,\n \"edit_group_info\": true,\n \"edit_message_ttl\": true,\n \"send_message\": true,\n \"start_call\": true\n}"
response = http.request(request)
puts response.read_body{
"data": {
"updated": true
},
"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>"
}