POST/api/v1/emails

Send Email

Send a single email to one or more recipients. This is the primary endpoint for sending transactional emails from your application.

bash

curl -X POST https://notifyn.net/api/v1/emails \
  -H "Authorization: Bearer ntfn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "subject": "Hello World",
    "html": "<h1>Hello!</h1><p>This is a test email.</p>",
    "text": "Hello! This is a test email."
  }'

Request Body

Parameter	Type	Description
`to`required	string \| string[]	Recipient email address. For multiple recipients, send as an array. Max 50.
`subject`required	string	Email subject line. Maximum 998 characters.
`html`	string	HTML content of the email. Either html or text is required.
`text`	string	Plain text content of the email. Either html or text is required.
`replyTo`	string \| string[]	Reply-to email address. For multiple addresses, send as an array.
`cc`	string \| string[]	CC recipient email addresses.
`bcc`	string \| string[]	BCC recipient email addresses.
`headers`	object	Custom email headers as key-value pairs.
`tags`	array	Array of tag objects with name and value properties for tracking.

Response

Success Response (200)

json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Email sent successfully"
}

Error Response (4xx/5xx)

json

{
  "error": "Validation failed",
  "details": [
    {
      "field": "to",
      "message": "Invalid email address"
    }
  ]
}

Rate Limit Headers

All responses include rate limit information in the headers:

Header	Description
`X-RateLimit-Limit`	Maximum requests per minute
`X-RateLimit-Remaining`	Requests remaining in current window
`X-RateLimit-Reset`	Unix timestamp when the rate limit resets

Examples

Send to multiple recipients

json

{
  "to": ["user1@example.com", "user2@example.com"],
  "subject": "Team Update",
  "html": "<h1>Hello Team!</h1><p>Here's your weekly update.</p>"
}

With Reply-To and CC

json

{
  "to": "customer@example.com",
  "subject": "Order Confirmation",
  "html": "<h1>Order #12345</h1><p>Thank you for your order!</p>",
  "replyTo": "orders@yourcompany.com",
  "cc": ["sales@yourcompany.com"]
}

With tracking tags

json

{
  "to": "user@example.com",
  "subject": "Welcome to Our App",
  "html": "<h1>Welcome!</h1>",
  "tags": [
    { "name": "category", "value": "onboarding" },
    { "name": "campaign", "value": "welcome-series" }
  ]
}

Introduction Send Batch Emails

Notify'n

POST/api/v1/emails

Send Email

Send a single email to one or more recipients. This is the primary endpoint for sending transactional emails from your application.

bash

curl -X POST https://notifyn.net/api/v1/emails \
  -H "Authorization: Bearer ntfn_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "to": "user@example.com",
    "subject": "Hello World",
    "html": "<h1>Hello!</h1><p>This is a test email.</p>",
    "text": "Hello! This is a test email."
  }'

Request Body

Parameter	Type	Description
`to`required	string \| string[]	Recipient email address. For multiple recipients, send as an array. Max 50.
`subject`required	string	Email subject line. Maximum 998 characters.
`html`	string	HTML content of the email. Either html or text is required.
`text`	string	Plain text content of the email. Either html or text is required.
`replyTo`	string \| string[]	Reply-to email address. For multiple addresses, send as an array.
`cc`	string \| string[]	CC recipient email addresses.
`bcc`	string \| string[]	BCC recipient email addresses.
`headers`	object	Custom email headers as key-value pairs.
`tags`	array	Array of tag objects with name and value properties for tracking.

Response

Success Response (200)

json

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "message": "Email sent successfully"
}

Error Response (4xx/5xx)

json

{
  "error": "Validation failed",
  "details": [
    {
      "field": "to",
      "message": "Invalid email address"
    }
  ]
}

Rate Limit Headers

All responses include rate limit information in the headers:

Header	Description
`X-RateLimit-Limit`	Maximum requests per minute
`X-RateLimit-Remaining`	Requests remaining in current window
`X-RateLimit-Reset`	Unix timestamp when the rate limit resets

Examples

Send to multiple recipients

json

{
  "to": ["user1@example.com", "user2@example.com"],
  "subject": "Team Update",
  "html": "<h1>Hello Team!</h1><p>Here's your weekly update.</p>"
}

With Reply-To and CC

json

{
  "to": "customer@example.com",
  "subject": "Order Confirmation",
  "html": "<h1>Order #12345</h1><p>Thank you for your order!</p>",
  "replyTo": "orders@yourcompany.com",
  "cc": ["sales@yourcompany.com"]
}

With tracking tags

json

{
  "to": "user@example.com",
  "subject": "Welcome to Our App",
  "html": "<h1>Welcome!</h1>",
  "tags": [
    { "name": "category", "value": "onboarding" },
    { "name": "campaign", "value": "welcome-series" }
  ]
}

Introduction Send Batch Emails