curl --request POST \
--url https://api.gleap.io/v3/engagement/emails/render-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"emailStyle": "<string>",
"subject": "<unknown>",
"preheader": "<unknown>",
"message": "<unknown>",
"sender": "<string>",
"lang": "<string>",
"brand": "<unknown>"
}
'import requests
url = "https://api.gleap.io/v3/engagement/emails/render-preview"
payload = {
"emailStyle": "<string>",
"subject": "<unknown>",
"preheader": "<unknown>",
"message": "<unknown>",
"sender": "<string>",
"lang": "<string>",
"brand": "<unknown>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
emailStyle: '<string>',
subject: '<unknown>',
preheader: '<unknown>',
message: '<unknown>',
sender: '<string>',
lang: '<string>',
brand: '<unknown>'
})
};
fetch('https://api.gleap.io/v3/engagement/emails/render-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.gleap.io/v3/engagement/emails/render-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([
'emailStyle' => '<string>',
'subject' => '<unknown>',
'preheader' => '<unknown>',
'message' => '<unknown>',
'sender' => '<string>',
'lang' => '<string>',
'brand' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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.gleap.io/v3/engagement/emails/render-preview"
payload := strings.NewReader("{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.gleap.io/v3/engagement/emails/render-preview")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/engagement/emails/render-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"sizeBytes": 123,
"text": "<string>",
"html": "<string>"
}Render an email preview
Render an email the way a recipient gets it, from unsaved editor values: emailStyle
(plain, personal or company), subject, preheader, message (TipTap JSON, or
{ localized: { <lang>: doc } }), optional sender (a teammate id, or
{ customSenderName }), lang and brand (unsaved emailBrand values). The current
user is the sample recipient and variables resolve with their values. Nothing is
stored or sent.
curl --request POST \
--url https://api.gleap.io/v3/engagement/emails/render-preview \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--header 'project: <project>' \
--data '
{
"emailStyle": "<string>",
"subject": "<unknown>",
"preheader": "<unknown>",
"message": "<unknown>",
"sender": "<string>",
"lang": "<string>",
"brand": "<unknown>"
}
'import requests
url = "https://api.gleap.io/v3/engagement/emails/render-preview"
payload = {
"emailStyle": "<string>",
"subject": "<unknown>",
"preheader": "<unknown>",
"message": "<unknown>",
"sender": "<string>",
"lang": "<string>",
"brand": "<unknown>"
}
headers = {
"project": "<project>",
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
project: '<project>',
Authorization: 'Bearer <token>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
emailStyle: '<string>',
subject: '<unknown>',
preheader: '<unknown>',
message: '<unknown>',
sender: '<string>',
lang: '<string>',
brand: '<unknown>'
})
};
fetch('https://api.gleap.io/v3/engagement/emails/render-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.gleap.io/v3/engagement/emails/render-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([
'emailStyle' => '<string>',
'subject' => '<unknown>',
'preheader' => '<unknown>',
'message' => '<unknown>',
'sender' => '<string>',
'lang' => '<string>',
'brand' => '<unknown>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json",
"project: <project>"
],
]);
$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.gleap.io/v3/engagement/emails/render-preview"
payload := strings.NewReader("{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("project", "<project>")
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.gleap.io/v3/engagement/emails/render-preview")
.header("project", "<project>")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gleap.io/v3/engagement/emails/render-preview")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["project"] = '<project>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"emailStyle\": \"<string>\",\n \"subject\": \"<unknown>\",\n \"preheader\": \"<unknown>\",\n \"message\": \"<unknown>\",\n \"sender\": \"<string>\",\n \"lang\": \"<string>\",\n \"brand\": \"<unknown>\"\n}"
response = http.request(request)
puts response.read_body{
"sizeBytes": 123,
"text": "<string>",
"html": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
TipTap document, or { localized: { <lang>: document } }.
A teammate id, or { id?, customSenderName? }. Defaults to the current user.
Unsaved emailBrand values from the brand settings page.
Conversational emails show no unsubscribe line. Defaults to marketing (a newsletter).
conversational, marketing