Send notifications for a notification template

Enqueues a SendNotificationsJob that delivers notifications using
the given template. When test is true the job is restricted to a
provided recipient list scoped to the authenticated app installation;
otherwise the template's configured recipients segment is used.

Manual delivery is required for non-test sends — templates with any
other deliveryMethod will return 400.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

The notification template ID.

Body Params
boolean

When true, send only to the provided recipients list (requires authenticated customer context).

recipients
array of strings

Email addresses to send the test notification to. Only used when test is true.

recipients
Headers
string
required

The App Id when you create an API key in your Mantle dashboard.

string
required

The App API Key.

Responses

400

Feature disabled, template not configured for manual delivery, or invalid app installation.

403

Test send requested without an authenticated customer.

404

Template not found.

500

Internal server error.

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json