Send an HTML email

curl --request POST \
  --url https://emails.platform.arb.inc/html/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expires": "2025-08-11T15:04:05Z",
  "from": {
    "address": "[email protected]",
    "name": "Alice Smith"
  },
  "to": [
    {
      "address": "[email protected]",
      "name": "Bob Lee"
    }
  ],
  "subject": "Welcome to our service!",
  "html": "<p>Hello, welcome to our service!</p>",
  "idempotency_key": "user-signup-12345",
  "cc": [
    {
      "address": "[email protected]",
      "name": "Carol Doe"
    }
  ],
  "bcc": [
    {
      "address": "[email protected]",
      "name": "Dan Roe"
    }
  ],
  "replyTo": {
    "address": "[email protected]",
    "name": "Support Team"
  },
  "text": "Hello, welcome to our service!"
}
'

{
  "message": "email queued for delivery"
}

POST

html

send

Send an HTML email

curl --request POST \
  --url https://emails.platform.arb.inc/html/send \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expires": "2025-08-11T15:04:05Z",
  "from": {
    "address": "[email protected]",
    "name": "Alice Smith"
  },
  "to": [
    {
      "address": "[email protected]",
      "name": "Bob Lee"
    }
  ],
  "subject": "Welcome to our service!",
  "html": "<p>Hello, welcome to our service!</p>",
  "idempotency_key": "user-signup-12345",
  "cc": [
    {
      "address": "[email protected]",
      "name": "Carol Doe"
    }
  ],
  "bcc": [
    {
      "address": "[email protected]",
      "name": "Dan Roe"
    }
  ],
  "replyTo": {
    "address": "[email protected]",
    "name": "Support Team"
  },
  "text": "Hello, welcome to our service!"
}
'

{
  "message": "email queued for delivery"
}

Authorizations

Authorization

string

header

required

access token

Body

application/json

expires

string<date-time>

required

Expiration time for the email. Must be in the future and within 7 days.

Example:

"2025-08-11T15:04:05Z"

from

object

required

Show child attributes

from.address

string

required

Required sender's email address.

Example:

"[email protected]"

from.name

string

Optional display name for the sender.

Example:

"Alice Smith"

object[]

required

At least one recipient is required.

Minimum array length: 1

Show child attributes

to.address

string

required

Required recipient's email address.

Example:

"[email protected]"

to.name

string

Optional display name for the recipient.

Example:

"Bob Lee"

subject

string

required

Required subject of the email. Must not be empty.

Example:

"Welcome to our service!"

html

string

required

Required HTML content of the email.

Example:

"<p>Hello, welcome to our service!</p>"

idempotency_key

string

required

Required unique key to ensure idempotent email sending. Combined with requestor identity (user:org or service ID) to prevent duplicate sends.

Example:

"user-signup-12345"

object[]

Optional CC recipients. Each email address will be validated.

Show child attributes

cc.address

string

required

Required CC recipient's email address.

Example:

"[email protected]"

cc.name

string

Optional display name for the CC recipient.

Example:

"Carol Doe"

bcc

object[]

Optional BCC recipients. Each email address will be validated.

Show child attributes

bcc.address

string

required

Required BCC recipient's email address.

Example:

"[email protected]"

bcc.name

string

Optional display name for the BCC recipient.

Example:

"Dan Roe"

replyTo

object

Optional reply-to email address.

Show child attributes

replyTo.address

string

required

Required reply-to email address.

Example:

"[email protected]"

replyTo.name

string

Optional display name for the reply-to address.

Example:

"Support Team"

text

string

Optional plain text version of the email.

Example:

"Hello, welcome to our service!"

Response

Email successfully queued for delivery.

message

string

Confirmation message that the email was queued.

Example:

"email queued for delivery"

Get basic service information Send a template-based email

⌘I

Documentation

Authentication

Cases

AI

Arbitrators

Alerts

Dev Tools

Emails

PDFs

Postal

Profiles

Roster

Rules

Webhooks

Zip

Send an HTML email

Authorizations

Body

Response