Announcements
Attribute | Type | Description |
id | uuid | The unique identifier for the announcement. |
type | string | The type of announcement.
general |
title | string | The announcement title. |
message | string | The announcement message body. |
button_label | string | If a button is optional or required, this is the button label. |
button_url | string | If a button is option or required, this is the URL which the button opens. |
is_dismissible | boolean | Whether the announcement can be dismissed or not. |
is_fullscreen | boolean | Whether the announcement should be displayed full screen or not. |
webview_url | string | If a web view should be displayed within the message, this is the URL to render. |
created_at | time | The time when the announcement was created. |
updated_at | time | The time when the announcement was updated. |
{
"id": 1,
"type": "general",
"title": "Updated Terms of Use",
"message": "Lorem ipsum dolor sit amet, consectetur adipiscing elit.",
"button_label": "Open Terms of Use",
"button_url": "http://www.mementopayments.com/terms",
"is_dismissible": true,
"is_fullscreen": false,
"created_at": "2017-09-04T12:26:43.403883Z",
"updated_at": "2017-09-04T12:26:43.403883Z"
}
Get a list of all announcements relevant to the user that were sent after the time defined by the
start_at filter.Request
Response
GET /v1/announcements
200 OK
Returns a list of announcement objects.
Attribute | Type | Operators | Values |
start_at | time | lt | YYYY-MM-DD HH:MM:SS |
Acknowledge an announcement by ID on behalf of the current user.
Request
Response
POST /v1/announcements/{id}/ack
Empty body.
200 OK
Returns an announcement object.
Last modified 2yr ago