chat

mute chat

Mute notifications for a specific chat either indefinitely or until a specified date

post/instances/{id}/client/action/mute-chat

Request

  • Base URL: https://waapi.app/api/v1
  • URL: https://waapi.app/api/v1/instances/{id}/client/action/mute-chat
  • Auth: HTTP bearer

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

Chat ID <countrycode_short><usernumber>@c.us or @g.us for groups

unmuteDatestring date-time

Optional. ISO 8601 formatted date-time when the chat should be automatically unmuted. If not provided, chat will be muted indefinitely

Example request

{
  "chatId": "50664083362@c.us",
  "unmuteDate": "2024-12-31T23:59:59.999Z"
}

Response

Chat muted successfully

instanceIdstring

ID of the instance

status'success' | 'error'

Example response

{
  "instanceId": "1",
  "data": {
    "chatMuted": true,
    "unmuteDate": "never"
  },
  "status": "success"
}

Changes

No recorded changes to this operation across all 1 revision of this API.