Skip to content

Notifications

Push notifications go to the iOS and Android apps (coming soon to the stores), with generic text only: never a sender, subject or address.

EndpointWhat it does
GET /notifications/preferencesWhich kinds the account receives, as preferences, and the addresses muted, as mutedInboxIds.
PATCH /notifications/preferencesTurn kinds on or off: newMail, devicePaired, deviceOffline, newSignIn, billing, support (a reply to a support request), webhooks (a failing webhook switched off), each true or false. Session only.
PATCH /notifications/inboxes/:idMute or unmute new-mail notifications for one address with { "muted": true }. Session only.
POST /notifications/devicesRegister a phone’s Expo push token, with token and platform (ios or android). An account keeps its 20 newest tokens. Session only.
DELETE /notifications/devices/:tokenRemove a push token. Session only.

“Session only” endpoints answer 403 session_required to an API key.

© Northlab Studios Ltd, trading as Mailcycle. Registered in England and Wales, company no. 17462734. Registered office: 167-169 Great Portland Street, London W1W 5PF.