Scheduled Broadcasts
Create a Scheduled Broadcast
POST /2/broadcasts/scheduled schedules a broadcast on one of your sources, with automatic or manual publishing.
POST
/
2
/
broadcasts
/
scheduled
Create a Scheduled Broadcast
curl --request POST \
--url https://api.x.com/2/broadcasts/scheduled \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"available_for_replay": true,
"chat_option": "<string>",
"description": "<string>",
"is_locked": true,
"locale": "<string>",
"manual_publish": true,
"scheduled_end_ms": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/scheduled"
payload = {
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"available_for_replay": True,
"chat_option": "<string>",
"description": "<string>",
"is_locked": True,
"locale": "<string>",
"manual_publish": True,
"scheduled_end_ms": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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({
scheduled_start_ms: '<string>',
source_id: '<string>',
available_for_replay: true,
chat_option: '<string>',
description: '<string>',
is_locked: true,
locale: '<string>',
manual_publish: true,
scheduled_end_ms: '<string>',
telecast_id: '<string>',
thumbnail_media_id: '<string>',
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/scheduled', 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",
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([
'scheduled_start_ms' => '<string>',
'source_id' => '<string>',
'available_for_replay' => true,
'chat_option' => '<string>',
'description' => '<string>',
'is_locked' => true,
'locale' => '<string>',
'manual_publish' => true,
'scheduled_end_ms' => '<string>',
'telecast_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"
payload := strings.NewReader("{\n \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<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/scheduled")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_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")
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 \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_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>"
}Schedules a broadcast on one of the authenticated user’s sources. The response returns
201 Created with the new scheduled broadcast.
Required fields
source_id and scheduled_start_ms are required.
source_idis the source id of one of your stream sources: itsidfrom Get Sources. The response returnssource_idas the source id.scheduled_start_msis the scheduled start time, Unix epoch milliseconds as a decimal string. It must be in the future.
Passing a stream key as
source_id is deprecated and stops working on January 1, 2027. Pass the source id instead. See the migration guide.Schedule rules
- The start time must be in the future.
- With
scheduled_end_ms, the broadcast must last between 1 minute and 24 hours. Omitscheduled_end_msfor an open-ended broadcast. - Scheduled broadcasts on the same source can’t overlap. For this check, an open-ended broadcast occupies the minute after its start, so open-ended broadcasts on one source must start at least 1 minute apart.
400. The error message starts with the reason, such as start_in_past, invalid_period or schedule_conflict.
Publishing behavior
Setmanual_publish to true when you want to publish explicitly with POST /2/broadcasts/scheduled/:id/live. Otherwise, the scheduler publishes automatically at scheduled_start_ms.
Optional fields
scheduled_end_mssets the scheduled end time as Unix epoch milliseconds. If omitted, the broadcast has no scheduled end and runs until it is stopped or ends manually.titleanddescriptionset the broadcast’s status text and description.thumbnail_media_idis a numeric media ID used as the pre-live slate image.chat_optioncontrols chat permissions and is a numeric string.available_for_replayenables replay after the broadcast ends.is_lockedlocks the broadcast.localesets the broadcast’s locale.
Recurring schedules are retired. A request that includes
recurrence returns 400; create each occurrence as its own scheduled broadcast. telecast_id is ignored.Example
{
"source_id": "9123456789012345678",
"scheduled_start_ms": "1784000000000",
"scheduled_end_ms": "1784003600000",
"title": "Product launch",
"description": "Live from our launch event",
"available_for_replay": true,
"manual_publish": true
}
Save both
broadcast_id (alphanumeric, used in endpoint paths) and scheduled_broadcast_id (numeric, required in the body of update requests).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
Create a Scheduled Broadcast
curl --request POST \
--url https://api.x.com/2/broadcasts/scheduled \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"available_for_replay": true,
"chat_option": "<string>",
"description": "<string>",
"is_locked": true,
"locale": "<string>",
"manual_publish": true,
"scheduled_end_ms": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<string>"
}
'import requests
url = "https://api.x.com/2/broadcasts/scheduled"
payload = {
"scheduled_start_ms": "<string>",
"source_id": "<string>",
"available_for_replay": True,
"chat_option": "<string>",
"description": "<string>",
"is_locked": True,
"locale": "<string>",
"manual_publish": True,
"scheduled_end_ms": "<string>",
"telecast_id": "<string>",
"thumbnail_media_id": "<string>",
"title": "<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({
scheduled_start_ms: '<string>',
source_id: '<string>',
available_for_replay: true,
chat_option: '<string>',
description: '<string>',
is_locked: true,
locale: '<string>',
manual_publish: true,
scheduled_end_ms: '<string>',
telecast_id: '<string>',
thumbnail_media_id: '<string>',
title: '<string>'
})
};
fetch('https://api.x.com/2/broadcasts/scheduled', 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",
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([
'scheduled_start_ms' => '<string>',
'source_id' => '<string>',
'available_for_replay' => true,
'chat_option' => '<string>',
'description' => '<string>',
'is_locked' => true,
'locale' => '<string>',
'manual_publish' => true,
'scheduled_end_ms' => '<string>',
'telecast_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"
payload := strings.NewReader("{\n \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_id\": \"<string>\",\n \"thumbnail_media_id\": \"<string>\",\n \"title\": \"<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/scheduled")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_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")
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 \"scheduled_start_ms\": \"<string>\",\n \"source_id\": \"<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 \"scheduled_end_ms\": \"<string>\",\n \"telecast_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>"
}