Skip to main content
PUT
Publish or end a user's broadcast

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Unique identifier of a User

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

"2244994945"

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

Body

application/json
state
string
required

PUBLISH or END.

chat_option
integer

Who can chat: 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. PUBLISH only.

locale
string

Broadcast language. PUBLISH only.

should_not_tweet
boolean

Skip the announcing Post. Unset keeps the broadcast's setting, which defaults to posting. PUBLISH only.

title
string

Broadcast title. PUBLISH only.

Response

The request has succeeded.

data
object
errors
object[]