POST
/
api
/
v3
/
video-streaming
/
{streamId}
/
viewer-bans
ban viewers from a live stream
curl --request POST \
  --url https://apix.us.amity.co/api/v3/video-streaming/{streamId}/viewer-bans \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "userIds": [
    "<string>"
  ]
}'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
streamId
string
required

Stream id to update

Maximum length: 50

Body

application/json

Response

200
application/json

Successfully banned users

The response is of type object.