Skip to main content
PUT
/
api
/
v2
/
channel
/
{channelId}
/
users
/
mute
Mute user in channel
curl --request PUT \
  --url https://apix.us.amity.co/api/v2/channel/{channelId}/users/mute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "userIds": [
    "<string>"
  ],
  "mutePeriod": 123
}
'
{
  "success": true
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
channelId
string
required

Body

application/json

Information of channel to be muted and period

​
userIds
string[]
required
Maximum array length: 100
Maximum string length: 50
​
mutePeriod
number
required

mute period (milliseconds)

Response

Mute/unmute information

​
success
boolean