Skip to content
Reference/Contacts/Archive / Unarchive Chat

Archive / Unarchive Chat

PATCHhttps://public.leadpattern.com/customer/:waId/archive
application/json60 req/min

Archive or unarchive a chat. Independent of open/closed status — an archived chat is hidden from the default inbox view until unarchived.

Headers

1 field
Authorizationstring
required
Your API key. Sent raw (e.g. 'lp_...'). No Bearer prefix required.

Path Parameters

1 field
waIdstring
required
Contact WhatsApp ID.

Body Parameters

1 field
isArchivedboolean
required
true to archive, false to unarchive.

Responses

JSON Response
{
  "type": "success",
  "message": "Chat archived."
}

Sample Request Body

{
  "isArchived": true
}