Live Chat
Mute a Chat User
POST /2/broadcasts/chat/mutes prevents a user from posting in a broadcaster’s chat across all of their broadcasts, optionally for a bounded time out and with a message removed in the same call.
POST
/
2
/
broadcasts
/
chat
/
mutes
Mute or time out a user in chat
curl --request POST \
--url https://api.x.com/2/broadcasts/chat/mutes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "<string>",
"broadcast_id": "<string>",
"end_at_ms": "<string>",
"message_id": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/chat/mutes"
payload = {
"user_id": "<string>",
"broadcast_id": "<string>",
"end_at_ms": "<string>",
"message_id": "<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({
user_id: '<string>',
broadcast_id: '<string>',
end_at_ms: '<string>',
message_id: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/chat/mutes', 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/broadcasts/chat/mutes",
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([
'user_id' => '<string>',
'broadcast_id' => '<string>',
'end_at_ms' => '<string>',
'message_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/broadcasts/chat/mutes"
payload := strings.NewReader("{\n \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<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/broadcasts/chat/mutes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts/chat/mutes")
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 \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"muted": 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>"
}Prevents a user from posting chat messages in a broadcaster’s chat. Mutes belong to the broadcaster and apply to every broadcast they host.
Pass the numeric id of the user to mute as
user_id in the request body. user_id is the only required field.
Without broadcast_id, you mute the user in your own chats. You don’t need a live broadcast to do this.
Chat moderators pass broadcast_id to mute the user in that broadcast host’s chats. The broadcast must be live. See List Broadcast Moderators for how moderators are managed.
Pass an optional message_id to remove that chat message at the same time. This is useful when muting is in response to a particular message. message_id requires broadcast_id.
Pass an optional end_at_ms to time the mute out at a specific Unix timestamp in milliseconds. Omit end_at_ms to mute the user indefinitely.
You can’t mute the broadcast owner.
To reverse this, use Unmute a Chat User. To see who you have muted, use List Muted Chat Users. To remove an individual message without muting its author, use Delete a Chat Message.
Authorizations
OAuth2UserTokenUserToken
The access token received from the authorization server in the OAuth 2.0 flow.
Body
application/json
The user to mute.
Pattern:
^[1-9][0-9]{0,18}$A broadcast whose host's chats the user is muted in. Required with message_id.
Pattern:
^[a-zA-Z0-9]{1,24}$The Unix timestamp in milliseconds when the mute expires. Omit this field to mute indefinitely.
Pattern:
^[1-9][0-9]{0,18}$A chat message in broadcast_id to remove while muting the user.
Pattern:
^[1-9][0-9]{0,18}$Response
The request has succeeded.
Show child attributes
Show child attributes
- 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
- Option 19
- Option 20
- Option 21
- Option 22
- Option 23
- Option 24
- Option 25
- Option 26
- Option 27
- Option 28
- Option 29
- Option 30
- Option 31
- Option 32
- Option 33
- Option 34
- Option 35
- Option 36
- Option 37
- Option 38
- Option 39
- Option 40
- Option 41
- Option 42
- Option 43
- Option 44
- Option 45
- Option 46
- Option 47
- Option 48
- Option 49
- Option 50
- Option 51
- Option 52
- Option 53
- Option 54
- Option 55
Show child attributes
Show child attributes
⌘I
Mute or time out a user in chat
curl --request POST \
--url https://api.x.com/2/broadcasts/chat/mutes \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"user_id": "<string>",
"broadcast_id": "<string>",
"end_at_ms": "<string>",
"message_id": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/chat/mutes"
payload = {
"user_id": "<string>",
"broadcast_id": "<string>",
"end_at_ms": "<string>",
"message_id": "<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({
user_id: '<string>',
broadcast_id: '<string>',
end_at_ms: '<string>',
message_id: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/chat/mutes', 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/broadcasts/chat/mutes",
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([
'user_id' => '<string>',
'broadcast_id' => '<string>',
'end_at_ms' => '<string>',
'message_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/broadcasts/chat/mutes"
payload := strings.NewReader("{\n \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<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/broadcasts/chat/mutes")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts/chat/mutes")
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 \"user_id\": \"<string>\",\n \"broadcast_id\": \"<string>\",\n \"end_at_ms\": \"<string>\",\n \"message_id\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"muted": 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>"
}