v1

latestOpenAPI 3.1.02026-07-1413113265.9 KB
chat

[BETA] set disappearing messages

Set the disappearing-messages timer on a chat. 0 disables; 86400 = 24h, 604800 = 7d, 7776000 = 90d. Groups require admin. Note: This endpoint is currently in beta and may change without notice.

post/instances/{id}/client/action/set-disappearing-messages

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

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

durationinteger required

Timer in seconds. 0 disables.

Example request

{
  "chatId": "50664083362@c.us",
  "duration": 604800
}

Response

Disappearing messages timer set successfully

instanceIdstring

ID of the instance

status'success' | 'error'

Example response

{
  "instanceId": "1",
  "data": {
    "disappearingMessages": {
      "duration": 604800
    }
  },
  "status": "success"
}