Mark a message read

POST/messaging/v1/messages/{id}/read

Marks a WhatsApp message from a customer as read and shows them "typing…". The customer sees blue ticks.

Path parameters

• #iduuidRequired
  The id of a WhatsApp message the customer sent you, from the message.received webhook.
  Example: 550e8400-e29b-41d4-a716-446655440000

There's no request body. WhatsApp shows "typing…" until your reply is delivered, for up to 25 seconds. You can't mark a message read without showing "typing…". This call isn't charged.

Example request

curl

curl -X POST "https://sandbox-api.ponitor.com/messaging/v1/messages/550e8400-e29b-41d4-a716-446655440000/read" \
  -H "apiKey: $PONITOR_API_KEY"

Node.js

const response = await fetch('https://sandbox-api.ponitor.com/messaging/v1/messages/550e8400-e29b-41d4-a716-446655440000/read', {
  method: 'POST',
  headers: { apiKey: process.env.PONITOR_API_KEY },
});

console.log(response.status, await response.json());

Python

import os

import requests

response = requests.post(
    "https://sandbox-api.ponitor.com/messaging/v1/messages/550e8400-e29b-41d4-a716-446655440000/read",
    headers={"apiKey": os.environ["PONITOR_API_KEY"]},
    timeout=30,
)
print(response.status_code, response.json())

PHP

<?php

$ch = curl_init('https://sandbox-api.ponitor.com/messaging/v1/messages/550e8400-e29b-41d4-a716-446655440000/read');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => ['apiKey: ' . getenv('PONITOR_API_KEY')],
]);

$body = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_RESPONSE_CODE);
echo $status, ' ', $body, PHP_EOL;

Responses

200

OK. The message is marked read. The body is the customer's message.

400

Bad Request. The message wasn't sent to you by a customer on WhatsApp, its WhatsApp number is no longer connected, or WhatsApp refused the request (E01002).

{
  "error": {
    "type": "bad_request_error",
    "code": "E01002",
    "name": "BadRequest",
    "message": "Only a WhatsApp message a customer sent can be marked read.",
    "doc_url": "https://docs.ponitor.com/api/errors#E01002",
    "request_id": "3c4d5e6f-7a8b-4c9d-8e0f-1a2b3c4d5e6f"
  }
}

Every error has this error object. The body also still carries fields from before codes, which are deprecated. See The error body.

401

Unauthorized. The API key is missing (E02001), wrong or revoked (E02002), or sent to the other base URL (E02003). See API keys and base URLs.

404

Not Found. Your team has no message with this id (E01005).

429

Too Many Requests. Your team went over its rate limit (E01011). Wait, then try again.