Skip to main content
POST
/
{instance}
/
read-chat
cURL
curl --request POST \
  --url https://app.hypersender.com/api/whatsapp/v2/{instance}/read-chat \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "chatId": "[email protected]"
}
'
{
  "ids": [
    "<string>"
  ]
}
V2 Queued Response: All API requests in V2 are queued for improved reliability. You’ll receive an immediate response with a queued_request_uuid that you can use to check the actual message status.

Response Format

All requests return a queued response:
{
    "queued": true,
    "message": "Processing your request...",
    "queued_request_uuid": "a0816120-7e37-4e8b-8cf3-92deb2cdc133",
    "queued_request_link": "https://app.hypersender.com/api/whatsapp/v2/{instance}/queued-requests/a0816120-7e37-4e8b-8cf3-92deb2cdc133"
}
Use the queued_request_link or the Get Queued Request endpoint to check the actual message response once it’s processed. More details on queued requests can be found in the Queued Requests Documentation.
You can mark all unread messages in the chat as read (double blue checkmark) using one query: It’ll find all unread messages in the chat and mark them as read.
Read Chat

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

Accept
string

application/json

Example:

"application/json"

Content-Type
string

application/json

Example:

"application/json"

Path Parameters

instance
string
required

Instance UUID copied from hypersender dashboard

Example:

"{{ instance_id }}"

Query Parameters

messages
string

How much messages to read (latest first)

Example:

"30"

days
string

How much days to read (latest first)

Example:

"7"

Body

application/json
chatId
string
required

Response

Successful response

ids
string[]