https://demo.notifuse.com/api/transactional.send Sends a transactional notification to a contact through specified channels. Requires authentication.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your API key.
Body application/json
The ID of the workspace
Show 7 child attributes Hide 7 child attributes
ID of the notification to send
External ID for idempotency checks
Show 42 child attributes Hide 42 child attributes
Email address of the contact. This is the contact's unique identifier.
Identifier for the contact in your own system. Not unique — several contacts may share the same external_id.
Timezone of the contact
Preferred language of the contact
First name of the contact
Last name of the contact
Full name of the contact (for systems that don't have separate first/last names)
Phone number of the contact
First line of address
Second line of address
Country of the contact
Postal code
State or province
Job title of the contact
The contact's own choice about open tracking; null means unknown.
The contact's own choice about click tracking; null means unknown.
When a tracking choice last changed.
Where the last tracking choice came from (api, console, import, notification_center, email_link, subscribe_form).
Custom string field 1
Custom string field 2
Custom string field 3
Custom string field 4
Custom string field 5
Custom number field 1
Custom number field 2
Custom number field 3
Custom number field 4
Custom number field 5
Custom datetime field 1
Custom datetime field 2
Custom datetime field 3
Custom datetime field 4
Custom datetime field 5
Custom JSON field 1. Any JSON value, or null.
Custom JSON field 2. Any JSON value, or null.
Custom JSON field 3. Any JSON value, or null.
Custom JSON field 4. Any JSON value, or null.
Custom JSON field 5. Any JSON value, or null.
When the contact was created (read-only, set by server)
When the contact was last updated (read-only, set by server)
Lists the contact is subscribed to (read-only, included in GET responses only)
Show 7 child attributes Hide 7 child attributes
Email address of the contact
ID of the list
Name of the list
Subscription status
When the contact was subscribed to this list
When the subscription was last updated
When the subscription was deleted (null if active)
Segments the contact belongs to (read-only, included in GET responses only)
Show 5 child attributes Hide 5 child attributes
Email address of the contact
ID of the segment
Version of the segment computation
When the contact was matched to this segment
When the segment was last computed
Channels to send through (at least one required)
Data to populate the template with
Additional metadata for tracking
Email-specific options
Show 8 child attributes Hide 8 child attributes
ID of one of the transactional email integration's senders. The email leaves from
this sender instead of the template's. An ID that is not one of the integration's
senders is refused with a 400 before the contact is created or updated. from_name
still applies on top of it.
Override default sender from name
Override template subject line. Supports Liquid templating variables.
Override template preheader/preview text. Supports Liquid templating variables.
CC email addresses
BCC email addresses
Reply-To email address. Takes the place of the template's reply-to for this message.
Email attachments (max 20 files, 3MB per file, 10MB total)
Show 5 child attributes Hide 5 child attributes
Name of the file (max 255 characters, no path separators)
Base64-encoded file content (max 3MB per file)
MIME type of the file (auto-detected if not provided)
How the attachment should be displayed (defaults to 'attachment')
Content-ID for inline attachments, referenced from the HTML body as . Only allowed when disposition is 'inline'. May only contain letters, digits, and the characters . _ - @ (max 255 characters). Defaults to the filename when omitted.
Response
200 Notification sent successfully object
Unique identifier for the sent message
Whether the notification was sent successfully
400 Bad request - validation failed object
Error message
401 Unauthorized - invalid or missing authentication token object
Error message
403 The API key lacks a permission the send requires. `transactional:write` is always required; `contacts:read` is required in addition when the request sets `cc` or `bcc`, because the subject is rendered against the contact. object
Error message
422 The email cannot be built from the template and the data of the send: a Liquid error, such as a filter that fails or a comparison of a text with a number, or an MJML error. Nothing is sent. The template or the data has to change; sending again fails the same way. object
Error message
500 Internal server error object
Error message