{{domainAddress}}/messages/acknowledge
This post simply informs the API when a customer has read and cleared a message that has been displayed in the app.
Revisions:
- On July 1, 2024, we altered the required headers for each post. Please see the updated documentation for authentication.
Headers
Header | Content |
Content Type | application/json |
Authorization | Bearer {{ID token}} |
App-Id | {{API key provided by Mosaic}} |
Device-Id | {{Advertising ID from the initial installation of this app}} |
Request-Date | {{ISO 8601 date and time format in UTC}} |
Body
Parameters
Parameter | Description |
{{clientId}} | Is provided by CWF for the app project and will be consistent throughout all API calls that require this ID. Type: String; Required |
{{messageId}} | Is provided in the messages/get function response for each message object. Type: Number; Required |
{ "clientId":"{{clientId}}", "id":"{{messageId}}" }
Example
Headers
App-Id: 5***9-d**3-4**8-b**1-b3***dac
Device-Id: a4***cb-d***5-4***f-8***c-84***75
Request-Date: 2024-07-02T19:59:20.815Z
Content-Type: application/json
Authorization: Bearer eyJraWQiO...aLxlc6PCgQ
Body
{ "clientId":"1f6w1jh6ls3mb", "messageId":7 }
Response
The response to this request will be simply an acknowledgement of receipt.
Absolutely NOTHING needs to be done with the response data, or errors.