Archive or Unarchive Chat

PATCH 
/api/v2/instance/:instanceId/chat/:id/archive

This endpoint allows you to archive or unarchive a WhatsApp chat. Archiving a chat is a way to organize and hide old conversations, while unarchiveing a chat makes the conversation visible again in the chat list.

Request

Path Parameters

instanceId stringrequired

ID of the instance.

Query Parameters

id stringrequired

The id [keyRemoteJid] of the chat to be archived.

application/json

Body

required

archive Archiverequired

Default value: false

Responses

200

Operation success.

application/json

Schema

Schema

archiveChat boolean

Default value: true

Example (from schema)

{
  "archiveChat": true
}

400

BadRequestException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

401

UnauthorizedException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

500

InternalServerErrorException

application/json

Schema

Schema

message string[]required

Default value: string,[object Object]

error stringrequired
statusCode numberrequired

Example (from schema)

{
  "message": [
    "string"
  ],
  "error": "string",
  "statusCode": 0
}

Loading...