Get a member's next message from your server

GET/v1/members/{id}/messages/next

The same as Get the next message, for a server-to-server integration. Your server passes the message on to the app, and the same one-a-day limit applies.

Permissions: Secret key with members:read.

Guide

Push and in-app messages

Path parameters#

idstring (uuid)Required
The member id.

Response204

1(no body: nothing to show)

Response fields#

Returns 200 with Message
Returns 204 with no body.

idstring (uuid)
Same as message_id in the push that carried it.
layoutstring
full_image (the image fills the screen and carries the words) or image_and_text (image on top, then title, body and buttons).
One of full_image, image_and_text
image_urlstring (uri)
HTTPS image.
titlestringNullable
Heading. For full_image, use it as the image's accessibility label.
bodystringNullable
Text under the title.
primaryMessageButton
The main button: label, action and url. action is open_screen (a link in your scheme or on your link domain), open_url (https, open in a browser) or close (url is null).
Show attributesMessageButton
- labelstring
- actionstring
  One of open_screen, open_url, close
- urlstringNullable
secondaryMessageButtonNullable
Second button, same shape, or null.
offerobjectNullable
An offer to show with the message, or null. code is a promo code to show; wallet_item_id is an offer already in the member's wallet; text is one line to show next to it.
Show attributesHide attributes
- codestringNullable
- wallet_item_idstring (uuid)Nullable
- textstring
displayobject
never_during: screens where the message must not appear. Always includes checkout.
Show attributesHide attributes
- never_duringarray of string
created_atstring (date-time)
When unPLUG created it.
expires_atstring (date-time)Nullable
Don't show it after this.

GET/v1/members/{id}/messages/next

1
2curl https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/next \
  -H "Authorization: Bearer $UNPLUG_KEY"

1
2
3
4
5
6const response = await fetch("https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/next", {
  headers: {
    Authorization: `Bearer ${process.env.UNPLUG_KEY}`,
  },
});
const data = await response.json();

1
2
3
4
5
6
7
8
9
10import os
import requests

response = requests.get(
    "https://api.unplugdining.com/v1/members/3f2b8c1e-6d0a-4e7b-9f3c-2a1d5e8b7c40/messages/next",
    headers={
        "Authorization": f"Bearer {os.environ['UNPLUG_KEY']}",
    },
)
data = response.json()

Response JSON200

1
2
3
4
5
6
7
8
9
10
11
12
13{
  "id": "5b81d3e0-2c4f-4a96-8e17-d0f9a3b62c58",
  "layout": "image_and_text",
  "image_url": "https://cdn.unplugdining.com/demo/campaigns/fall-pastry.jpg",
  "title": "A pastry on us",
  "body": "Croissant or muffin, your pick. Add one to your next order and it's free. Good until November 12.",
  "primary": { "label": "See my wallet", "action": "open_screen", "url": "yourapp://wallet/7e3a9c51-0b8d-4f2e-a6c4-5d1b9e7f3a28" },
  "secondary": { "label": "Not now", "action": "close", "url": null },
  "offer": { "code": null, "wallet_item_id": "7e3a9c51-0b8d-4f2e-a6c4-5d1b9e7f3a28", "text": "Fall pastry on us, until November 12." },
  "display": { "never_during": ["checkout"] },
  "created_at": "2026-10-30T15:00:00Z",
  "expires_at": "2026-11-13T05:59:59Z"
}

Error descriptions#

404Not found

member_not_found

No member with this id.

410Gone

member_deleted

The member was deleted.

Any endpoint can also return the common errors.

404 Not found

1
2
3
4
5
6
7{
  "type": "https://docs.unplugdining.com/reference/errors#member_not_found",
  "title": "Not found",
  "status": 404,
  "code": "member_not_found",
  "detail": "No member with this id."
}