Skip to main content
POST
/
email
/
v1
/
messages
Send an email
curl --request POST \
  --url https://api.voyant.travel/email/v1/messages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "from": "noreply@updates.example.com",
  "to": [
    "jsmith@example.com"
  ],
  "subject": "<string>",
  "cc": [
    "jsmith@example.com"
  ],
  "bcc": [
    "jsmith@example.com"
  ],
  "replyTo": [
    "jsmith@example.com"
  ],
  "html": "<string>",
  "text": "<string>",
  "attachments": [
    {
      "filename": "<string>",
      "content": "<string>",
      "path": "<string>",
      "contentType": "<string>",
      "contentId": "<string>"
    }
  ]
}
'
{
  "data": {
    "id": "<string>",
    "organizationId": "<string>",
    "fromAddress": "<string>",
    "toAddresses": [
      "<string>"
    ],
    "subject": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "ccAddresses": [
      "<string>"
    ],
    "bccAddresses": [
      "<string>"
    ],
    "replyTo": [
      "<string>"
    ],
    "openCount": 123,
    "clickCount": 123,
    "providerEmailId": "<string>",
    "providerStatus": "<string>",
    "errorMessage": "<string>",
    "sentAt": "2023-11-07T05:31:56Z",
    "deliveredAt": "2023-11-07T05:31:56Z",
    "lastEventAt": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

Voyant Cloud API token, passed as Authorization: Bearer <token>. Each token carries a fixed set of scopes; an operation rejects tokens missing its required scope.

Body

application/json
from
string
required
Required string length: 3 - 320
Example:

"noreply@updates.example.com"

to
string<email>[]
required
Required array length: 1 - 50 elements
subject
string
required
Required string length: 1 - 998
cc
string<email>[] | null
Maximum array length: 50
bcc
string<email>[] | null
Maximum array length: 50
replyTo
string<email>[] | null
Maximum array length: 5
html
string | null
Maximum string length: 1000000
text
string | null
Maximum string length: 1000000
attachments
object[] | null
Maximum array length: 20

Response

Email queued

data
object
required