Send an email

curl --request POST \
  --url https://api.vambe.me/api/public/email/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "to": "jsmith@example.com"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to: 'jsmith@example.com'})
};

fetch('https://api.vambe.me/api/public/email/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/email/send"

payload = { "to": "jsmith@example.com" }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Email

Send an email

Sends an email to one or more contacts identified by their email address (“to” accepts a single email or an array of up to 20), from one of the account verified email channels. Use a saved template (“template_id” or “template_name”, plus “variables”) or free-form content (“subject” and “html_body”). If no contact exists for a recipient address, one is created. When the account has more than one verified channel, “from” is required to pick the sender address. Single-recipient sends also accept “cc” and “bcc” (up to 10 each): one message is sent where cc recipients are visible to everyone. Multi-recipient “to” arrays instead send an individual private copy per recipient. The response contains a per-recipient result list; “success” is true only when every recipient succeeded.

POST

/

api

/

public

/

email

/

send

Send an email

curl --request POST \
  --url https://api.vambe.me/api/public/email/send \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <x-api-key>' \
  --data '
{
  "to": "jsmith@example.com"
}
'

const options = {
  method: 'POST',
  headers: {'x-api-key': '<x-api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({to: 'jsmith@example.com'})
};

fetch('https://api.vambe.me/api/public/email/send', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.vambe.me/api/public/email/send"

payload = { "to": "jsmith@example.com" }
headers = {
    "x-api-key": "<x-api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Headers

x-api-key

string

required

API key needed to authorize the request

Body

application/json

The email payload

to

required

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

cc

string<email>[]

Required array length: 1 - 10 elements

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

bcc

string<email>[]

Required array length: 1 - 10 elements

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

contact_name

string

Required string length: 1 - 255

from

string<email>

Pattern: ^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$

template_id

string<uuid>

Pattern:

^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$

template_name

string

Required string length: 1 - 255

variables

object

Show child attributes

subject

string

Minimum string length: 1

html_body

string

Minimum string length: 1

attachments

object[]

Maximum array length: 10

Show child attributes

Response

Send processed. Returns { success, results: [{ to, success, error? }] } with one entry per recipient.