Notifications API
The emails Manifold sends to your customers and suppliers, the domain they come from, and the log of each one.
Every message Manifold sends for a organization, and the record of it, by email or text message: who the organization's mail goes out as, the domain it may verify to send from its own address — with the DNS records that takes — the SMS sender ID its texts arrive from in each country, the organization's own email templates for each kind of message, push to the organization's own people on their phones and in their browsers, and a log of each notification: what, why, to whom, from where, when, and what became of it.
- Base URL
https://notifications.getmanifold.io- Auth
- A bearer token on every call. See the quickstart.
- OpenAPI
- notifications-manager.openapi.json
settings
Who the organization's mail and text messages go out as, the domain its mail sends from, its brand, and the host its customer pages are served on.
- GET
/settingsThe organization's notifications setup - PUT
/settings/senderSet who the organization's mail goes out as - POST
/settings/domainStart sending from the organization's own domain - DELETE
/settings/domainStop sending from the organization's own domain - POST
/settings/domain/checkLook the sending domain's records up now - PUT
/settings/smsSet who the organization's text messages come from - DELETE
/settings/smsStop sending text messages - POST
/settings/sms/checkAsk the SMS provider where the sender ID stands in each country it is still requested in - PUT
/settings/trackingSwitch tracking of opens and clicks on or off for the organization's mail to its… - GET
/settings/brandThe organization's brand - PUT
/settings/brandSet the organization's brand - PUT
/settings/brand/logoSet the brand's logo - DELETE
/settings/brand/logoTake the logo off the brand: pages, PDFs and emails show the business name in its place - GET
/settings/pages-domainThe organization's own host for its customer pages - POST
/settings/pages-domainServe the organization's customer pages on a subdomain it owns - DELETE
/settings/pages-domainStop serving the customer pages on the organization's own host - POST
/settings/pages-domain/checkAsk the edge where the pages host stands now, and the records it still needs
notifications
The record of every message sent for the organization.
- GET
/notificationsThe notification log - GET
/notifications/{notificationId}One notification as the log holds it - POST
/notifications/testSend a test message on channel to to from the organization's sender as it stands - POST
/notifications/quotesSend an issued quote to the customer on channel
suppressions
The addresses the organization no longer sends to, because they bounced, complained or opted out.
- GET
/suppressionsThe addresses and numbers the organization no longer sends to - DELETE
/suppressions/{suppressionId}Lift a suppression, so the address or number may be sent to again
templates
The organization's own designs for the emails Manifold sends, written in react-email's dialect and rendered in a sandbox.
- GET
/email-templates/catalogEverything a template author needs - GET
/email-templatesThe organization's own email templates - GET
/email-templates/{templateId}One of the organization's email templates at its latest version, with its whole source - PUT
/email-templates/{templateId}Create or change one of the organization's email templates under a caller-minted etp_ id - POST
/email-templates/{templateId}/archiveArchive one of the organization's email templates - PUT
/email-templates/kinds/{kind}/activeChoose what a kind of email renders from now - PUT
/email-templates/styleChoose the organization's email style - POST
/email-templates/renderRender a template's source for a kind without keeping it - POST
/email-templates/{templateId}/testSend one of the organization's templates
brands
The brand a organization's customer pages wear, and the host they are served on.
- GET
/brands/{tenantId}The brand a organization's customer pages wear - GET
/pages-hosts/{hostname}The organization whose customer pages a host serves - GET
/brands/{tenantId}/pages-hostThe host a organization's customer links name
push
Push to the organization's own people, on their phones and in their browsers: their devices, what reaches them, and raising one.
- GET
/me/push/configHow a browser registers for push on this deployment - GET
/me/push/devicesThe caller's own devices push goes to in this organization - PUT
/me/push/devicesRegister this browser - DELETE
/me/push/devices/{deviceId}Stop pushing to one of the caller's devices, and answer the devices that remain - POST
/me/push/devices/{deviceId}/testPush a test to one of the caller's own devices - GET
/me/push/preferencesWhich kinds of push reach the caller's devices - PUT
/me/push/preferencesReplace the caller's push preferences - POST
/pushPush to the organization's own people
alerts
A person's own choice of which operational emails about the organization reach them.
- GET
/me/alert-preferencesWhich operational emails reach the caller as one of the organization's owners or admins - PUT
/me/alert-preferencesReplace the operational-email categories the caller switched off
events
The notifications service's append-only event log.