Skip to main content
POST
/
v1
/
emails
cURL
curl --request POST \
  --url https://api.transmit.dev/v1/emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "from": "jsmith@example.com",
  "from_name": "<string>",
  "reply_to": "jsmith@example.com",
  "to": "jsmith@example.com",
  "cc": "jsmith@example.com",
  "bcc": "jsmith@example.com",
  "subject": "<string>",
  "html": "<string>",
  "text": "<string>",
  "template_id": "<string>",
  "variables": {},
  "tags": [
    "<string>"
  ],
  "headers": {},
  "attachments": [
    {
      "filename": "<string>",
      "content": "<string>",
      "type": "<string>",
      "disposition": "attachment",
      "contentId": "<string>"
    }
  ],
  "scheduled_for": "2023-11-07T05:31:56Z",
  "batch_id": "<string>",
  "message_stream": "transactional",
  "track_opens": true,
  "track_clicks": true
}'
{
  "workflow_id": "<string>",
  "from": "jsmith@example.com",
  "to": [
    "jsmith@example.com"
  ],
  "subject": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "scheduled_for": "2023-11-07T05:31:56Z",
  "suppressed_recipients": [
    "jsmith@example.com"
  ],
  "status": "<string>"
}

Authorizations

Authorization
string
header
required

Enter your API key with 'tx_' prefix. Get your API key from the dashboard.

Body

application/json
from
string<email>
required
to
required
subject
string
required
Minimum length: 1
from_name
string
reply_to
string<email>
cc
bcc
html
string
text
string
template_id
string
variables
object
tags
string[]
headers
object
attachments
object[]
scheduled_for
string<date-time>
batch_id
string
message_stream
enum<string>
Available options:
transactional,
broadcast
track_opens
boolean
track_clicks
boolean

Response

Email workflow initiated successfully

workflow_id
string
required

Workflow ID for tracking durable execution

from
string<email>
required

Sender email address

to
string<email>[]
required

Recipient email addresses

subject
string
required

Email subject

created_at
string<date-time>
required

Creation timestamp

scheduled_for
string<date-time> | null
required

Scheduled delivery time

suppressed_recipients
string<email>[]
required

Recipients that were suppressed

status
string
required

Email processing status

⌘I