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
- Example: ws_1234567890
Show child attributes
ID of the notification to send
- Example: welcome_email
External ID for idempotency checks
- Example: txn_12345
Show child attributes
Email address of the contact. This is the contact's unique identifier.
- Example: user@example.com
Identifier for the contact in your own system. Not unique — several contacts may share the same external_id.
- Example: user_12345
Timezone of the contact
- Example: America/New_York
Preferred language of the contact
- Example: en-US
First name of the contact
- Example: John
Last name of the contact
- Example: Doe
Full name of the contact (for systems that don't have separate first/last names)
- Example: John Doe
Phone number of the contact
- Example: +15551234567
First line of address
- Example: 123 Main St
Second line of address
- Example: Apt 4B
Country of the contact
- Example: US
Postal code
- Example: 10001
State or province
- Example: NY
Job title of the contact
- Example: Software Engineer
The contact's own choice about open tracking; null means unknown.
- Available options: granted, denied, null
The contact's own choice about click tracking; null means unknown.
- Available options: granted, denied, null
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
- Example: Premium tier
Custom string field 2
Custom string field 3
Custom string field 4
Custom string field 5
Custom number field 1
- Example: 42
Custom number field 2
Custom number field 3
Custom number field 4
Custom number field 5
Custom datetime field 1
- Example: 2023-06-01T09:00:00Z
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)
- Example: 2023-01-15T10:30:00Z
When the contact was last updated (read-only, set by server)
- Example: 2023-04-22T15:45:00Z
Lists the contact is subscribed to (read-only, included in GET responses only)
Show child attributes
Email address of the contact
- Example: user@example.com
ID of the list
- Example: newsletter
Name of the list
- Example: Newsletter
Subscription status
- Available options: active, pending, unsubscribed, bounced, complained
- Example: active
When the contact was subscribed to this list
- Example: 2023-01-15T10:30:00Z
When the subscription was last updated
- Example: 2023-01-15T10:30:00Z
When the subscription was deleted (null if active)
Segments the contact belongs to (read-only, included in GET responses only)
Show child attributes
Email address of the contact
- Example: user@example.com
ID of the segment
- Example: premium_users
Version of the segment computation
- Example: 1
When the contact was matched to this segment
- Example: 2023-01-15T10:30:00Z
When the segment was last computed
- Example: 2023-01-15T10:30:00Z
Channels to send through (at least one required)
- Available options: email
Data to populate the template with
Additional metadata for tracking
Email-specific options
Show 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.
- Example: 3f1c2a9e-7b4d-4e1a-9c2f-5d8e6a0b1c3d
Override default sender from name
- Example: Support Team
Override template subject line. Supports Liquid templating variables.
- Maximum length: 255
- Example: Welcome, {{ name }}!
Override template preheader/preview text. Supports Liquid templating variables.
- Maximum length: 255
- Example: Your order has been confirmed
CC email addresses
BCC email addresses
Reply-To email address. Takes the place of the template's reply-to for this message.
- Example: support@example.com
Email attachments (max 20 files, 3MB per file, 10MB total)
- Maximum items: 20
Show child attributes
Name of the file (max 255 characters, no path separators)
- Maximum length: 255
- Example: invoice.pdf
Base64-encoded file content (max 3MB per file)
- Example: JVBERi0xLjQKJeLjz9MKMy4uLg==
MIME type of the file (auto-detected if not provided)
- Example: application/pdf
How the attachment should be displayed (defaults to 'attachment')
- Default: attachment
- Available options: attachment, inline
- Example: 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.
- Maximum length: 255
- Example: checkInQr
Response
200 Notification sent successfully object
Unique identifier for the sent message
- Example: msg_1234567890abcdef
Whether the notification was sent successfully
- Example: true
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