Skip to main content
POST
/
api
/
v1
/
bavimail
/
emails
Send Email
curl --request POST \
  --url https://api.example.com/api/v1/bavimail/emails \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "alias_id": "<string>",
  "to_email": "<string>",
  "subject": "<string>",
  "body": "<string>",
  "track_opens": true,
  "track_clicks": false,
  "click_tracking_patterns": [
    "<string>"
  ],
  "send_at": "<string>",
  "send_at_timezone": "<string>",
  "conversation_id": "<string>",
  "in_reply_to": "<string>",
  "attachments": [
    {}
  ]
}
'
import requests

url = "https://api.example.com/api/v1/bavimail/emails"

payload = {
"alias_id": "<string>",
"to_email": "<string>",
"subject": "<string>",
"body": "<string>",
"track_opens": True,
"track_clicks": False,
"click_tracking_patterns": ["<string>"],
"send_at": "<string>",
"send_at_timezone": "<string>",
"conversation_id": "<string>",
"in_reply_to": "<string>",
"attachments": [{}]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
alias_id: '<string>',
to_email: '<string>',
subject: '<string>',
body: JSON.stringify('<string>'),
track_opens: true,
track_clicks: false,
click_tracking_patterns: ['<string>'],
send_at: '<string>',
send_at_timezone: '<string>',
conversation_id: '<string>',
in_reply_to: '<string>',
attachments: [{}]
})
};

fetch('https://api.example.com/api/v1/bavimail/emails', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/api/v1/bavimail/emails",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'alias_id' => '<string>',
'to_email' => '<string>',
'subject' => '<string>',
'body' => '<string>',
'track_opens' => true,
'track_clicks' => false,
'click_tracking_patterns' => [
'<string>'
],
'send_at' => '<string>',
'send_at_timezone' => '<string>',
'conversation_id' => '<string>',
'in_reply_to' => '<string>',
'attachments' => [
[

]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.example.com/api/v1/bavimail/emails"

payload := strings.NewReader("{\n \"alias_id\": \"<string>\",\n \"to_email\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": false,\n \"click_tracking_patterns\": [\n \"<string>\"\n ],\n \"send_at\": \"<string>\",\n \"send_at_timezone\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"in_reply_to\": \"<string>\",\n \"attachments\": [\n {}\n ]\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/bavimail/emails")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"alias_id\": \"<string>\",\n \"to_email\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": false,\n \"click_tracking_patterns\": [\n \"<string>\"\n ],\n \"send_at\": \"<string>\",\n \"send_at_timezone\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"in_reply_to\": \"<string>\",\n \"attachments\": [\n {}\n ]\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/bavimail/emails")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"alias_id\": \"<string>\",\n \"to_email\": \"<string>\",\n \"subject\": \"<string>\",\n \"body\": \"<string>\",\n \"track_opens\": true,\n \"track_clicks\": false,\n \"click_tracking_patterns\": [\n \"<string>\"\n ],\n \"send_at\": \"<string>\",\n \"send_at_timezone\": \"<string>\",\n \"conversation_id\": \"<string>\",\n \"in_reply_to\": \"<string>\",\n \"attachments\": [\n {}\n ]\n}"

response = http.request(request)
puts response.read_body
{}
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}

Authorizations

Authorization
string
header
required

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

Headers

X-Idempotency-Key
string | null

Body

application/json
alias_id
string
required
to_email
string
required
subject
string
required
body
string
required
track_opens
boolean
default:true
track_clicks
boolean
default:false
click_tracking_patterns
string[] | null
send_at
string | null
send_at_timezone
string | null
conversation_id
string | null
in_reply_to
string | null
attachments
Attachments · object[] | null

Response

Successful Response

The response is of type Response Send Email Api V1 Bavimail Emails Post · object.