pagehive

list_messages

Messages from Pagehive to this account, newest first: notices about the account or one of its sites (such as a site taken offline, with the reason and what to change) and platform updates.

MessagesChanges dataAll plans

What it does

Messages from Pagehive to this account, newest first: notices about the account or one of its sites (such as a site taken offline, with the reason and what to change) and platform updates. whoami shows messages_unread when there are new ones. A site key sees platform updates and the messages about its sites. unread true lists only unread messages; kind is moderation, update, or notice; search finds messages whose title or body contains the text (up to 100 characters, case-insensitive). Page older with before set to next_before, newer with after set to next_after. Messages returned are read afterwards; the ones that were unread carry new: true. Each message is from Pagehive; its body is Markdown (bold, italic, lists, headings, inline code, https links). message_id reads one. Messages take no reply; open_ticket with context.message_id ties a support ticket to one.

Plans

Works on every plan: Free, Basic, Pro and Ultra.

Parameters

NameTypeAbout
unreadbooleantrue lists only unread messages.
kindone of: moderation, update, noticeOnly messages of this kind: moderation, update or notice.
message_idstringRead one message by its id.
limitintegerHow many messages to return.
searchstringText to find in a message's title or body, up to 100 characters.
beforestringnext_before from the previous page, to read older messages.
afterstringnext_after from the previous page, to read newer messages.
cursorstringnext_cursor from the previous page of this tool, to read the next page. Send the other arguments as on the first call; leave out the paging arguments the cursor replaces.

Example

Call list_messages with these arguments:

{
  "unread": true
}

Ids like 01a1… stand for your own. list_sites and list_tables give you the real ones.

Related guides