chat

archive chat

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

Request

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

Path parameters

idinteger required

Instance ID

Request body

chatIdstring required

Chat ID: <number>@c.us or <lid>@lid for a contact (both address the same chat), <id>@g.us for a group.

Example request

{
  "chatId": "<xxxxx>@c.us"
}

Response

Request reached the instance. data.status reports whether the action was carried out; on error data carries message and explanation.

status'success' | 'error'

Whether the request reached the instance. success here does not mean the action was carried out — that is reported by data.status, which is the authoritative one. A malformed input arrives as status: success with data.status: error.

Example response

{
  "data": {
    "status": "success",
    "data": {
      "data": {
        "chatArchived": true
      }
    }
  },
  "links": {
    "self": "https://waapi.app/api/v1/instances/1/client/action/archive-chat"
  },
  "status": "success"
}

Changes

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