Preview Email Settings
curl --request POST \
--url https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_name": "<string>",
"sender_email": "<string>",
"reply_to": "<string>",
"invitation_message": "<string>",
"salutation": "<string>",
"senders": [
{
"name": "<string>",
"email": "<string>",
"domain_verified": true,
"oauth_connection_id": "<string>"
}
],
"logo_url": "<string>",
"privacy_note_enabled": true,
"primary_color": "<string>",
"default_sender": "<string>",
"active_sender_usable": true,
"effective_sender": "<string>",
"language": "<string>",
"campaign_title": "<string>",
"duration_minutes": 120
}
'import requests
url = "https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview"
payload = {
"sender_name": "<string>",
"sender_email": "<string>",
"reply_to": "<string>",
"invitation_message": "<string>",
"salutation": "<string>",
"senders": [
{
"name": "<string>",
"email": "<string>",
"domain_verified": True,
"oauth_connection_id": "<string>"
}
],
"logo_url": "<string>",
"privacy_note_enabled": True,
"primary_color": "<string>",
"default_sender": "<string>",
"active_sender_usable": True,
"effective_sender": "<string>",
"language": "<string>",
"campaign_title": "<string>",
"duration_minutes": 120
}
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({
sender_name: '<string>',
sender_email: '<string>',
reply_to: '<string>',
invitation_message: '<string>',
salutation: '<string>',
senders: [
{
name: '<string>',
email: '<string>',
domain_verified: true,
oauth_connection_id: '<string>'
}
],
logo_url: '<string>',
privacy_note_enabled: true,
primary_color: '<string>',
default_sender: '<string>',
active_sender_usable: true,
effective_sender: '<string>',
language: '<string>',
campaign_title: '<string>',
duration_minutes: 120
})
};
fetch('https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview', 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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview",
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([
'sender_name' => '<string>',
'sender_email' => '<string>',
'reply_to' => '<string>',
'invitation_message' => '<string>',
'salutation' => '<string>',
'senders' => [
[
'name' => '<string>',
'email' => '<string>',
'domain_verified' => true,
'oauth_connection_id' => '<string>'
]
],
'logo_url' => '<string>',
'privacy_note_enabled' => true,
'primary_color' => '<string>',
'default_sender' => '<string>',
'active_sender_usable' => true,
'effective_sender' => '<string>',
'language' => '<string>',
'campaign_title' => '<string>',
'duration_minutes' => 120
]),
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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview"
payload := strings.NewReader("{\n \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview")
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 \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}workspaces
Preview Email Settings
Render the invitation email with the given (possibly unsaved) settings.
Returns the exact HTML participants would receive, with sample campaign values, so the settings page can show a live preview.
POST
/
v1
/
workspaces
/
{workspace_id}
/
email-settings
/
preview
Preview Email Settings
curl --request POST \
--url https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sender_name": "<string>",
"sender_email": "<string>",
"reply_to": "<string>",
"invitation_message": "<string>",
"salutation": "<string>",
"senders": [
{
"name": "<string>",
"email": "<string>",
"domain_verified": true,
"oauth_connection_id": "<string>"
}
],
"logo_url": "<string>",
"privacy_note_enabled": true,
"primary_color": "<string>",
"default_sender": "<string>",
"active_sender_usable": true,
"effective_sender": "<string>",
"language": "<string>",
"campaign_title": "<string>",
"duration_minutes": 120
}
'import requests
url = "https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview"
payload = {
"sender_name": "<string>",
"sender_email": "<string>",
"reply_to": "<string>",
"invitation_message": "<string>",
"salutation": "<string>",
"senders": [
{
"name": "<string>",
"email": "<string>",
"domain_verified": True,
"oauth_connection_id": "<string>"
}
],
"logo_url": "<string>",
"privacy_note_enabled": True,
"primary_color": "<string>",
"default_sender": "<string>",
"active_sender_usable": True,
"effective_sender": "<string>",
"language": "<string>",
"campaign_title": "<string>",
"duration_minutes": 120
}
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({
sender_name: '<string>',
sender_email: '<string>',
reply_to: '<string>',
invitation_message: '<string>',
salutation: '<string>',
senders: [
{
name: '<string>',
email: '<string>',
domain_verified: true,
oauth_connection_id: '<string>'
}
],
logo_url: '<string>',
privacy_note_enabled: true,
primary_color: '<string>',
default_sender: '<string>',
active_sender_usable: true,
effective_sender: '<string>',
language: '<string>',
campaign_title: '<string>',
duration_minutes: 120
})
};
fetch('https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview', 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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview",
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([
'sender_name' => '<string>',
'sender_email' => '<string>',
'reply_to' => '<string>',
'invitation_message' => '<string>',
'salutation' => '<string>',
'senders' => [
[
'name' => '<string>',
'email' => '<string>',
'domain_verified' => true,
'oauth_connection_id' => '<string>'
]
],
'logo_url' => '<string>',
'privacy_note_enabled' => true,
'primary_color' => '<string>',
'default_sender' => '<string>',
'active_sender_usable' => true,
'effective_sender' => '<string>',
'language' => '<string>',
'campaign_title' => '<string>',
'duration_minutes' => 120
]),
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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview"
payload := strings.NewReader("{\n \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\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.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.ontora.com/v1/workspaces/{workspace_id}/email-settings/preview")
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 \"sender_name\": \"<string>\",\n \"sender_email\": \"<string>\",\n \"reply_to\": \"<string>\",\n \"invitation_message\": \"<string>\",\n \"salutation\": \"<string>\",\n \"senders\": [\n {\n \"name\": \"<string>\",\n \"email\": \"<string>\",\n \"domain_verified\": true,\n \"oauth_connection_id\": \"<string>\"\n }\n ],\n \"logo_url\": \"<string>\",\n \"privacy_note_enabled\": true,\n \"primary_color\": \"<string>\",\n \"default_sender\": \"<string>\",\n \"active_sender_usable\": true,\n \"effective_sender\": \"<string>\",\n \"language\": \"<string>\",\n \"campaign_title\": \"<string>\",\n \"duration_minutes\": 120\n}"
response = http.request(request)
puts response.read_body{
"html": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Body
application/json
Current (possibly unsaved) form values plus the preview language.
campaign_title/duration_minutes let the campaign builder preview
the email with the real campaign values instead of the generic sample —
otherwise a {title} placeholder renders as "Sample campaign" and the user
concludes their title is broken.
Maximum string length:
120Maximum string length:
4000Maximum array length:
20Show child attributes
Show child attributes
Maximum string length:
1000Maximum string length:
9Pattern:
^#?[0-9a-fA-F]{3,8}$Maximum string length:
300Required range:
1 <= x <= 240Response
Successful Response
Was this page helpful?
⌘I