Skip to main content
PUT
End a Broadcast
Ends one of the authenticated user’s broadcasts. :id is the alphanumeric broadcast ID. The broadcast moves to ENDED; this is irreversible, and a broadcast can’t be restarted. This route replaces END on the deprecated Publish or End a Broadcast route; see the migration guide.
Only END is supported. PUBLISH is rejected with 400: to go live, use Go Live (POST /2/broadcasts), which creates and publishes a broadcast in one call.
Send exactly {"state": "END"}. Don’t include title, locale, chat_option or should_not_tweet: if any of them is set, the request is rejected with 400 (for example, "title must not be set"). On success, the response is 200 with the broadcast ID and its new state, ENDED. After ending, stop your encoder. Read the final broadcast, including end_ms, with GET /2/broadcasts/:id.

Errors

Errors use the standard X API problem format.

Authorizations

Authorization
string
header
required

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

Path Parameters

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

Body

application/json
state
string
required

END. PUBLISH is not supported.

chat_option
integer

Not allowed with END.

locale
string

Not allowed with END.

should_not_tweet
boolean

Not allowed with END.

title
string

Not allowed with END.

Response

The request has succeeded.

data
object
errors
object[]