Scheduled Broadcasts
Update a Scheduled Broadcast
PUT /2/broadcasts/scheduled/:id updates a scheduled broadcast that hasn’t started. Fields you don’t send keep their current values.
PUT
/
2
/
broadcasts
/
scheduled
/
{id}
Update a Scheduled Broadcast
curl --request PUT \
--url https://api.x.com/2/broadcasts/scheduled/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"available_for_replay": true,
"chat_option": "<string>",
"description": "<string>",
"is_locked": true,
"locale": "<string>",
"manual_publish": true,
"roll_forward": true,
"source_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/scheduled/{id}"
payload = {
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"available_for_replay": True,
"chat_option": "<string>",
"description": "<string>",
"is_locked": True,
"locale": "<string>",
"manual_publish": True,
"roll_forward": True,
"source_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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({
scheduled_broadcast_id: '<string>',
scheduled_end_ms: '<string>',
scheduled_start_ms: '<string>',
available_for_replay: true,
chat_option: '<string>',
description: '<string>',
is_locked: true,
locale: '<string>',
manual_publish: true,
roll_forward: true,
source_id: '<string>',
thumbnail_media_id: '<string>',
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/scheduled/{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/broadcasts/scheduled/{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([
'scheduled_broadcast_id' => '<string>',
'scheduled_end_ms' => '<string>',
'scheduled_start_ms' => '<string>',
'available_for_replay' => true,
'chat_option' => '<string>',
'description' => '<string>',
'is_locked' => true,
'locale' => '<string>',
'manual_publish' => true,
'roll_forward' => true,
'source_id' => '<string>',
'thumbnail_media_id' => '<string>',
'title' => '<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/scheduled/{id}"
payload := strings.NewReader("{\n \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\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/broadcasts/scheduled/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts/scheduled/{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 \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"available_for_replay": true,
"broadcast_id": "<string>",
"chat_option": "<string>",
"description": "<string>",
"locale": "<string>",
"manual_publish": true,
"recurring_schedule_id": "<string>",
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"state": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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>"
}Updates a scheduled broadcast that hasn’t started yet.
:id is the alphanumeric broadcast_id, while the body’s required scheduled_broadcast_id is the numeric scheduler ID (from create, list, or get).
Required fields
scheduled_broadcast_id, scheduled_start_ms and scheduled_end_ms are required in every request. To keep the current times, resend them unchanged. Send scheduled_end_ms as "0" for an open-ended broadcast.
Every other field is optional. Fields you don’t send keep their current values.
Schedule rules
The create rules apply: the start must be in the future, a broadcast with an end lasts 1 minute to 24 hours, and broadcasts on the same source can’t overlap. Updating a broadcast that has already started returns400.
Source
source_id is the source id of one of your stream sources, from Get Sources. Passing a stream key as source_id is deprecated and stops working on January 1, 2027; see the migration guide. The response returns source_id as the source id.
Recurring schedules are retired. A request with
roll_forward set to true returns 400.Authorizations
OAuth2UserTokenUserToken
Scopes
Body
application/json
Response
The request has succeeded.
- 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
- Option 56
- Option 57
- Option 58
- Option 59
- Option 60
- Option 61
Show child attributes
Show child attributes
⌘I
Update a Scheduled Broadcast
curl --request PUT \
--url https://api.x.com/2/broadcasts/scheduled/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"available_for_replay": true,
"chat_option": "<string>",
"description": "<string>",
"is_locked": true,
"locale": "<string>",
"manual_publish": true,
"roll_forward": true,
"source_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/scheduled/{id}"
payload = {
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"available_for_replay": True,
"chat_option": "<string>",
"description": "<string>",
"is_locked": True,
"locale": "<string>",
"manual_publish": True,
"roll_forward": True,
"source_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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({
scheduled_broadcast_id: '<string>',
scheduled_end_ms: '<string>',
scheduled_start_ms: '<string>',
available_for_replay: true,
chat_option: '<string>',
description: '<string>',
is_locked: true,
locale: '<string>',
manual_publish: true,
roll_forward: true,
source_id: '<string>',
thumbnail_media_id: '<string>',
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/scheduled/{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/broadcasts/scheduled/{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([
'scheduled_broadcast_id' => '<string>',
'scheduled_end_ms' => '<string>',
'scheduled_start_ms' => '<string>',
'available_for_replay' => true,
'chat_option' => '<string>',
'description' => '<string>',
'is_locked' => true,
'locale' => '<string>',
'manual_publish' => true,
'roll_forward' => true,
'source_id' => '<string>',
'thumbnail_media_id' => '<string>',
'title' => '<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/scheduled/{id}"
payload := strings.NewReader("{\n \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\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/broadcasts/scheduled/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.x.com/2/broadcasts/scheduled/{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 \"scheduled_broadcast_id\": \"<string>\",\n \"scheduled_end_ms\": \"<string>\",\n \"scheduled_start_ms\": \"<string>\",\n \"available_for_replay\": true,\n \"chat_option\": \"<string>\",\n \"description\": \"<string>\",\n \"is_locked\": true,\n \"locale\": \"<string>\",\n \"manual_publish\": true,\n \"roll_forward\": true,\n \"source_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"data": {
"available_for_replay": true,
"broadcast_id": "<string>",
"chat_option": "<string>",
"description": "<string>",
"locale": "<string>",
"manual_publish": true,
"recurring_schedule_id": "<string>",
"scheduled_broadcast_id": "<string>",
"scheduled_end_ms": "<string>",
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"state": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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>"
}