cURL
curl --request POST \
--url http://localhost:3001/api/admin/content/templates/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"templateId": "<string>",
"userProperties": {},
"channel": "Email",
"tags": {},
"provider": "SendGrid"
}
'import requests
url = "http://localhost:3001/api/admin/content/templates/test"
payload = {
"workspaceId": "<string>",
"templateId": "<string>",
"userProperties": {},
"channel": "Email",
"tags": {},
"provider": "SendGrid"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
templateId: '<string>',
userProperties: {},
channel: 'Email',
tags: {},
provider: 'SendGrid'
})
};
fetch('http://localhost:3001/api/admin/content/templates/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/content/templates/test",
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([
'workspaceId' => '<string>',
'templateId' => '<string>',
'userProperties' => [
],
'channel' => 'Email',
'tags' => [
],
'provider' => 'SendGrid'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "http://localhost:3001/api/admin/content/templates/test"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("http://localhost:3001/api/admin/content/templates/test")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/admin/content/templates/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}"
response = http.request(request)
puts response.read_body{
"type": "Ok",
"value": {
"type": "DFInternalMessageSent",
"variant": {
"type": "Email",
"provider": {
"type": "MailChimp"
},
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"body": "<string>",
"headers": {},
"attachments": [
{
"mimeType": "<string>",
"name": "<string>"
}
],
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"name": "<string>",
"attachmentUserProperties": [
"<string>"
],
"emailContentsType": "Code"
}
}
}API Reference
POST /api/admin/content/templates/test
Send a test message for a message template.
POST
/
api
/
admin
/
content
/
templates
/
test
cURL
curl --request POST \
--url http://localhost:3001/api/admin/content/templates/test \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"workspaceId": "<string>",
"templateId": "<string>",
"userProperties": {},
"channel": "Email",
"tags": {},
"provider": "SendGrid"
}
'import requests
url = "http://localhost:3001/api/admin/content/templates/test"
payload = {
"workspaceId": "<string>",
"templateId": "<string>",
"userProperties": {},
"channel": "Email",
"tags": {},
"provider": "SendGrid"
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
workspaceId: '<string>',
templateId: '<string>',
userProperties: {},
channel: 'Email',
tags: {},
provider: 'SendGrid'
})
};
fetch('http://localhost:3001/api/admin/content/templates/test', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_PORT => "3001",
CURLOPT_URL => "http://localhost:3001/api/admin/content/templates/test",
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([
'workspaceId' => '<string>',
'templateId' => '<string>',
'userProperties' => [
],
'channel' => 'Email',
'tags' => [
],
'provider' => 'SendGrid'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"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 := "http://localhost:3001/api/admin/content/templates/test"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<api-key>")
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("http://localhost:3001/api/admin/content/templates/test")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://localhost:3001/api/admin/content/templates/test")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"workspaceId\": \"<string>\",\n \"templateId\": \"<string>\",\n \"userProperties\": {},\n \"channel\": \"Email\",\n \"tags\": {},\n \"provider\": \"SendGrid\"\n}"
response = http.request(request)
puts response.read_body{
"type": "Ok",
"value": {
"type": "DFInternalMessageSent",
"variant": {
"type": "Email",
"provider": {
"type": "MailChimp"
},
"to": "<string>",
"from": "<string>",
"subject": "<string>",
"body": "<string>",
"headers": {},
"attachments": [
{
"mimeType": "<string>",
"name": "<string>"
}
],
"replyTo": "<string>",
"cc": "<string>",
"bcc": "<string>",
"name": "<string>",
"attachmentUserProperties": [
"<string>"
],
"emailContentsType": "Code"
}
}
}Authorizations
Body
application/json
- Option 1
- Option 2
- Option 3
- Option 4
Show child attributes
Show child attributes
Available options:
Email Show child attributes
Show child attributes
provider
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>Option 7 · enum<string>Option 8 · enum<string>
Available options:
SendGrid ⌘I

