The account reminders and other messages waiting to be shown to you in the dashboard.
GET/v1/me/lifecycle/messagesTry it
Session token
Returns the messages queued for you as in-app messages — the card at the top of dashboard pages. Syntext queues a message here instead of emailing it when you've used the dashboard in the last day, or when your address can't receive mail. See In-app messages.
Only your own messages are returned, oldest first, at most five. A message stays in the list until you mark it seen with Mark In-App Message Seen. The dashboard shows the newest one.
Note
Requires a session JWT — a dashboard session or an stx login token. API keys are rejected with 401. Any plan.
What the message is about — for example unverified, never_deployed, failing_site, repo_access_lost, plan_limits, unpublished_changes or invite_pending. See Account reminders for the situations.
step:numberbody
Which reminder in that situation's schedule this is, from 1.
title:stringbody
The heading to show.
body:stringbody
One short paragraph.
cta:object | nullbody
The button: label and url. A url on app.syntext.dev opens in the dashboard; anything else is an external link.
createdAt:stringbody
When the message was queued.
Error Responses
401 Unauthorized
unauthorized for a missing, invalid or expired token (or an API key); session_revoked when the session has been signed out.