Skip to main content
POST
Send an email

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Scopes

publicAPI.v2.all

Public API v2

Body

application/json
contactId
integer
required

ID of the contact to send the email to.

Example:

12345

from
string
required

Sender email address. Must match one of the caller's own connected email accounts.

Example:

"rep@acme.com"

to
string
required

Recipient email address.

Example:

"prospect@example.com"

subject
string

Email subject line. Required unless templateId is provided.

Example:

"Quick question about your team"

body
string

Email body content (HTML or plain text). Required unless templateId is provided.

Example:

"Hi there, I wanted to reach out..."

cc
string

CC recipient email address(es).

Example:

"manager@example.com"

bcc
string

BCC recipient email address(es).

Example:

"archive@acme.com"

templateId
integer

ID of an email template to send. Its subject and body are used where subject or body are omitted.

Example:

678

Response

Email sent, or queued to send later when a send limit was reached or the provider failed temporarily. Check status to tell them apart.

success
boolean
Example:

true

data
object