Receipts endpoints

Method HTTP request Description
Send message receipt POST /messages/:message_uuid/receipts Update recipient status on a message
Send announcement receipt POST /announcements/:announcement_uuid/receipts Update recipient status on a announcement

Send message receipt

Sending a delivery receipt acknowledges that the client has received the Message, and the sender will see the message as Delivered. Sending a read receipt decrements the unread_message_count property on the conversation and notifies the sender that the message has been read.

Parameters:

Name Type Description
message_uuid string ID of the message to update
type string Possible values are “read” or “delivery”

HTTP request:

POST/messages/:message_uuid/receipts

Example:

{
    "type": "read"
}
curl -X POST \
     -H 'Accept: application/vnd.layer+json; version=3.0' \
     -H 'Authorization: Layer session-token="<TOKEN>"'' \
     -H 'Content-Type: application/json' \
     https://api.layer.com/messages/<message_uuid>/receipts\
 -d '{"type":"read"}'

Possible responses:

Receipt updated successfully
Status: 204 (No Content)
(Empty body)

Send announcement receipt

Sending a delivery receipt acknowledges that the client has received the Announcement.

Parameters:

Name Type Description
announcement_uuid string ID of the announcement to update
type string Possible values are “read” or “delivery”

HTTP request:

POST/announcements/:announcement_uuid/receipts

Example:

{
    "type": "read"
}
curl -X POST \
     -H 'Accept: application/vnd.layer+json; version=3.0' \
     -H 'Authorization: Layer session-token="<TOKEN>"'' \
     -H 'Content-Type: application/json' \
     https://api.layer.com/announcements/<announcement_uuid>/receipts\
 -d '{"type":"read"}'

Possible responses:

Receipt updated successfully
Status: 204 (No Content)
(Empty body)