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

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>"
}
'

200

{
  "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>"
    }
  ]
}

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 returns 400.

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

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

broadcast.read

View your live broadcasts and their chat.

broadcast.write

Manage your live broadcasts and send chat messages on your behalf.

Path Parameters

id · string · required

Pattern: ^[a-zA-Z0-9]{1,24}$

Body

application/json

scheduled_broadcast_id · string · required

Numeric scheduler id from create/list/get.

Pattern: ^[0-9]{1,19}$

scheduled_end_ms · string · required

End time, ms since Unix epoch (decimal string).

Pattern: ^[0-9]{1,19}$

scheduled_start_ms · string · required

Start time, ms since Unix epoch (decimal string).

Pattern: ^[0-9]{1,19}$

available_for_replay · boolean

Enable replay.

chat_option · string

Who can chat (numeric string): 0 default, 1 chat off, 2 everyone, 3 verified accounts, 4 accounts the host follows, 5 the host's subscribers, 6 accounts followed by an account the host follows.

Pattern: ^[0-9]{1,19}$

description · string

Description.

is_locked · boolean

Lock the broadcast.

locale · string

Locale.

manual_publish · boolean

If true, do not auto-publish at start; call POST .../live when ready.

roll_forward · boolean

Deprecated: recurring schedules are being retired and true will be rejected.

source_id · string

Source to bind: a source's id from GET /2/sources. A stream key is also accepted but deprecated; stream keys stop being accepted when the /2/users/:id/sources and /2/users/:id/broadcasts routes reach end of life on January 1, 2027.

thumbnail_media_id · string

Pre-live slate media id (numeric string).

Pattern: ^[0-9]{1,19}$

title · string

Title / status text.

Response

200

application/json

The request has succeeded.

data · object

Show child attributes

errors · object[]

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