Send a transactional notification

curl --request POST \
  --url https://{notifuseDomain}/api/transactional.send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "notification": {
    "id": "welcome_email",
    "contact": {
      "email": "[email protected]",
      "external_id": "user_12345",
      "timezone": "America/New_York",
      "language": "en-US",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "phone": "+15551234567",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "postcode": "10001",
      "state": "NY",
      "job_title": "Software Engineer",
      "custom_string_1": "Premium tier",
      "custom_string_2": "<string>",
      "custom_string_3": "<string>",
      "custom_string_4": "<string>",
      "custom_string_5": "<string>",
      "custom_number_1": 42,
      "custom_number_2": 123,
      "custom_number_3": 123,
      "custom_number_4": 123,
      "custom_number_5": 123,
      "custom_datetime_1": "2023-06-01T09:00:00Z",
      "custom_datetime_2": "2023-11-07T05:31:56Z",
      "custom_datetime_3": "2023-11-07T05:31:56Z",
      "custom_datetime_4": "2023-11-07T05:31:56Z",
      "custom_datetime_5": "2023-11-07T05:31:56Z",
      "custom_json_1": {
        "preferences": {
          "theme": "dark",
          "notifications": true
        }
      },
      "custom_json_2": {},
      "custom_json_3": {},
      "custom_json_4": {},
      "custom_json_5": {}
    },
    "external_id": "txn_12345",
    "channels": [
      "email"
    ],
    "data": {
      "user_name": "John Doe",
      "activation_link": "https://example.com/activate/abc123"
    },
    "metadata": {
      "campaign_id": "spring_promo_2023",
      "source": "user_signup"
    },
    "email_options": {
      "from_name": "Support Team",
      "cc": [
        "[email protected]"
      ],
      "bcc": [
        "[email protected]"
      ],
      "reply_to": "[email protected]",
      "attachments": [
        {
          "filename": "invoice.pdf",
          "content": "JVBERi0xLjQKJeLjz9MKMy4uLg==",
          "content_type": "application/pdf",
          "disposition": "attachment"
        }
      ]
    }
  }
}
'

{
  "message_id": "msg_1234567890abcdef",
  "success": true
}

POST

api

transactional.send

Send a transactional notification

curl --request POST \
  --url https://{notifuseDomain}/api/transactional.send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "workspace_id": "ws_1234567890",
  "notification": {
    "id": "welcome_email",
    "contact": {
      "email": "[email protected]",
      "external_id": "user_12345",
      "timezone": "America/New_York",
      "language": "en-US",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "phone": "+15551234567",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "postcode": "10001",
      "state": "NY",
      "job_title": "Software Engineer",
      "custom_string_1": "Premium tier",
      "custom_string_2": "<string>",
      "custom_string_3": "<string>",
      "custom_string_4": "<string>",
      "custom_string_5": "<string>",
      "custom_number_1": 42,
      "custom_number_2": 123,
      "custom_number_3": 123,
      "custom_number_4": 123,
      "custom_number_5": 123,
      "custom_datetime_1": "2023-06-01T09:00:00Z",
      "custom_datetime_2": "2023-11-07T05:31:56Z",
      "custom_datetime_3": "2023-11-07T05:31:56Z",
      "custom_datetime_4": "2023-11-07T05:31:56Z",
      "custom_datetime_5": "2023-11-07T05:31:56Z",
      "custom_json_1": {
        "preferences": {
          "theme": "dark",
          "notifications": true
        }
      },
      "custom_json_2": {},
      "custom_json_3": {},
      "custom_json_4": {},
      "custom_json_5": {}
    },
    "external_id": "txn_12345",
    "channels": [
      "email"
    ],
    "data": {
      "user_name": "John Doe",
      "activation_link": "https://example.com/activate/abc123"
    },
    "metadata": {
      "campaign_id": "spring_promo_2023",
      "source": "user_signup"
    },
    "email_options": {
      "from_name": "Support Team",
      "cc": [
        "[email protected]"
      ],
      "bcc": [
        "[email protected]"
      ],
      "reply_to": "[email protected]",
      "attachments": [
        {
          "filename": "invoice.pdf",
          "content": "JVBERi0xLjQKJeLjz9MKMy4uLg==",
          "content_type": "application/pdf",
          "disposition": "attachment"
        }
      ]
    }
  }
}
'

{
  "message_id": "msg_1234567890abcdef",
  "success": true
}

Authorizations

Authorization

string

header

required

API token for authentication

Body

application/json

workspace_id

string

required

The ID of the workspace

Example:

"ws_1234567890"

notification

object

required

Show child attributes

notification.id

string

required

ID of the notification to send

Example:

"welcome_email"

notification.contact

object

required

Show child attributes

notification.contact.email

string<email>

required

Email address of the contact

Example:

"[email protected]"

notification.contact.external_id

string | null

External identifier for the contact

Example:

"user_12345"

notification.contact.timezone

string | null

Timezone of the contact

Example:

"America/New_York"

notification.contact.language

string | null

Preferred language of the contact

Example:

"en-US"

notification.contact.first_name

string | null

First name of the contact

Example:

"John"

notification.contact.last_name

string | null

Last name of the contact

Example:

"Doe"

notification.contact.full_name

string | null

Full name of the contact (for systems that don't have separate first/last names)

Example:

"John Doe"

notification.contact.phone

string | null

Phone number of the contact

Example:

"+15551234567"

notification.contact.address_line_1

string | null

First line of address

Example:

"123 Main St"

notification.contact.address_line_2

string | null

Second line of address

Example:

"Apt 4B"

notification.contact.country

string | null

Country of the contact

Example:

"US"

notification.contact.postcode

string | null

Postal code

Example:

"10001"

notification.contact.state

string | null

State or province

Example:

"NY"

notification.contact.job_title

string | null

Job title of the contact

Example:

"Software Engineer"

notification.contact.custom_string_1

string | null

Custom string field 1

Example:

"Premium tier"

notification.contact.custom_string_2

string | null

Custom string field 2

notification.contact.custom_string_3

string | null

Custom string field 3

notification.contact.custom_string_4

string | null

Custom string field 4

notification.contact.custom_string_5

string | null

Custom string field 5

notification.contact.custom_number_1

number<float> | null

Custom number field 1

Example:

42

notification.contact.custom_number_2

number<float> | null

Custom number field 2

notification.contact.custom_number_3

number<float> | null

Custom number field 3

notification.contact.custom_number_4

number<float> | null

Custom number field 4

notification.contact.custom_number_5

number<float> | null

Custom number field 5

notification.contact.custom_datetime_1

string<date-time> | null

Custom datetime field 1

Example:

"2023-06-01T09:00:00Z"

notification.contact.custom_datetime_2

string<date-time> | null

Custom datetime field 2

notification.contact.custom_datetime_3

string<date-time> | null

Custom datetime field 3

notification.contact.custom_datetime_4

string<date-time> | null

Custom datetime field 4

notification.contact.custom_datetime_5

string<date-time> | null

Custom datetime field 5

notification.contact.custom_json_1

object

Custom JSON field 1

Example:

{
  "preferences": { "theme": "dark", "notifications": true }
}

notification.contact.custom_json_2

object

Custom JSON field 2

notification.contact.custom_json_3

object

Custom JSON field 3

notification.contact.custom_json_4

object

Custom JSON field 4

notification.contact.custom_json_5

object

Custom JSON field 5

notification.external_id

string | null

External ID for idempotency checks

Example:

"txn_12345"

notification.channels

enum<string>[]

Specific channels to send through (if empty, use all configured channels)

Available options:

email

Example:

["email"]

notification.data

object

Data to populate the template with

Example:

{
  "user_name": "John Doe",
  "activation_link": "https://example.com/activate/abc123"
}

notification.metadata

object

Additional metadata for tracking

Example:

{
  "campaign_id": "spring_promo_2023",
  "source": "user_signup"
}

notification.email_options

object

Email-specific options

Show child attributes

notification.email_options.from_name

string | null

Override default sender from name

Example:

"Support Team"

notification.email_options.cc

string<email>[]

CC email addresses

Example:

["[email protected]"]

notification.email_options.bcc

string<email>[]

BCC email addresses

Example:

["[email protected]"]

notification.email_options.reply_to

string<email>

Reply-To email address

Example:

"[email protected]"

notification.email_options.attachments

object[]

Email attachments (max 20 files, 3MB per file, 10MB total)

Maximum array length: 20

Show child attributes

notification.email_options.attachments.filename

string

required

Name of the file (max 255 characters, no path separators)

Maximum string length: 255

Example:

"invoice.pdf"

notification.email_options.attachments.content

string<byte>

required

Base64-encoded file content (max 3MB per file)

Example:

"JVBERi0xLjQKJeLjz9MKMy4uLg=="

notification.email_options.attachments.content_type

string

MIME type of the file (auto-detected if not provided)

Example:

"application/pdf"

notification.email_options.attachments.disposition

enum<string>

default:attachment

How the attachment should be displayed (defaults to 'attachment')

Available options:

attachment,

inline

Example:

"attachment"

Example:

[
  {
    "filename": "invoice.pdf",
    "content": "JVBERi0xLjQKJeLjz9MKMy4uLg==",
    "content_type": "application/pdf",
    "disposition": "attachment"
  }
]

Response

Notification sent successfully

message_id

string

Unique identifier for the sent message

Example:

"msg_1234567890abcdef"

success

boolean

Whether the notification was sent successfully

Example:

true

List contacts with filtering and pagination

⌘I

Transactional

Contacts

Lists

Custom Events

Broadcasts

Templates

Webhooks

Send a transactional notification

Authorizations

Body

Response