Skip to main content
POST
/
email
Send emails
curl --request POST \
  --url https://api.open.cx/email \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from_email": "[email protected]",
  "recipients": [
    {
      "to_email": "[email protected]",
      "email_body": "<string>",
      "email_subject": "<string>",
      "email_sender_name": "<string>",
      "email_is_transactional": true
    }
  ],
  "delay_in_minutes": 1,
  "fallback_email_subject": "<string>",
  "fallback_email_sender_name": "<string>",
  "fallback_email_body": "<string>"
}
'
{
  "statusCode": 123,
  "message": "<string>",
  "error": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
from_email
string<email>
required

The email to send from. This email's domain name must be added and verified. Otherwise, the request will fail with a 400 status code.

​
recipients
object[]
required

Array of contacts to receive emails. The only required field is to_email, with the rest of the fields having fallback values that can be specified on the top level.

It's possible to repeat the same contact email in the array with different delay_in_minutes values to create a sequence of scheduled emails for that contact (e.g. for onboarding).

​
delay_in_minutes
number

How much time (in minutes) to wait before sending the emails.

Required range: x > 0
​
fallback_email_subject
string
​
fallback_email_sender_name
string
​
fallback_email_body
string

Fallback body of the email in HTML format.

Response