Skip to main content
POST
/
api
/
v1
/
rooms
/
{roomId}
/
viewer-bans
ban viewers from a room
curl --request POST \
  --url https://apix.us.amity.co/api/v1/rooms/{roomId}/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

​
roomId
string
required

Room ID

Maximum string length: 50

Body

application/json

Information of viewers to be banned from the room

​
userIds
string[]
required

List of user IDs to ban from the room

Required array length: 1 - 100 elements
Maximum string length: 50

Response

Successfully banned users

​
success
boolean