Mark Message As Read
PUT {{URL}}/v1/messages/<Message ID from Webhook>
You can use the
/v1/messages/
endpoint to change the status of incoming messages to read.
You must set
pass_through
to
false
in the application settings.
When
pass_through
is set to
true
, messages are removed from the local database after they are delivered to, or read, by the recipient. But, when it is set to
false
, incoming messages are saved in local database for 7 days, after which they are deleted if
db_garbagecollector_enable
is set to
true
.
We recommend marking incoming messages as read within 7 days of receipt.
The
message_id
used in this API call is the
id
provided in the inbound notification.
Response
A successful response returns
null
or
{}
Request Body
{"status"=>"read"}
HEADERS
| Key | Datatype | Required | Description |
| Content-Type | string | | |
| Authorization | string | | |
RESPONSES
status: OK
{"meta":{"api_status":"stable","version":"v2.45.1"}}