Create a dynamic template

curl --request POST \
  --url https://api.paubox.com/v1/email/dynamic_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'data[name]=welcome_template' \
  --form data[body]='@example-file'

import requests

url = "https://api.paubox.com/v1/email/dynamic_templates"

files = { "data[body]": ("example-file", open("example-file", "rb")) }
payload = { "data[name]": "welcome_template" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('data[name]', 'welcome_template');
form.append('data[body]', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.paubox.com/v1/email/dynamic_templates', 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.paubox.com/v1/email/dynamic_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.paubox.com/v1/email/dynamic_templates"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.paubox.com/v1/email/dynamic_templates")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/email/dynamic_templates")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "template_123",
  "name": "welcome_template",
  "body": "Hello {{name}}, welcome to our service!",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "errors": [
    {
      "code": 123,
      "title": "<string>",
      "details": "<string>"
    }
  ]
}

POST

dynamic_templates

Create a dynamic template

curl --request POST \
  --url https://api.paubox.com/v1/email/dynamic_templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: multipart/form-data' \
  --form 'data[name]=welcome_template' \
  --form data[body]='@example-file'

import requests

url = "https://api.paubox.com/v1/email/dynamic_templates"

files = { "data[body]": ("example-file", open("example-file", "rb")) }
payload = { "data[name]": "welcome_template" }
headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, data=payload, files=files, headers=headers)

print(response.text)

const form = new FormData();
form.append('data[name]', 'welcome_template');
form.append('data[body]', '<string>');

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

options.body = form;

fetch('https://api.paubox.com/v1/email/dynamic_templates', 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.paubox.com/v1/email/dynamic_templates",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: multipart/form-data"
  ],
]);

$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.paubox.com/v1/email/dynamic_templates"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "Bearer <token>")

	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.paubox.com/v1/email/dynamic_templates")
  .header("Authorization", "Bearer <token>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.paubox.com/v1/email/dynamic_templates")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data%5Bname%5D\"\r\n\r\nwelcome_template\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"data[body]\"; filename=\"example-file\"\r\nContent-Type: application/octet-stream\r\n\r\n<string>\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "id": "template_123",
  "name": "welcome_template",
  "body": "Hello {{name}}, welcome to our service!",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "errors": [
    {
      "code": 123,
      "title": "<string>",
      "details": "<string>"
    }
  ]
}

Authorizations

Authorization

string

header

required

Paubox API uses Bearer token authentication in the Authorization header.

Format: Authorization: Bearer YOUR_API_KEY_HERE

Example: Authorization: Bearer 9e5b092b632445b8f570c62ae54f30fda1044305

The legacy format Authorization: Token token=YOUR_API_KEY_HERE is also supported.

Body

multipart/form-data

data[name]

string

required

Name for the template

Example:

"welcome_template"

data[body]

file

required

Handlebars template file (.hbs)

Response

Template created successfully

string

Template ID

Example:

"template_123"

name

string

Template name

Example:

"welcome_template"

body

string

Template content (Handlebars)

Example:

"Hello {{name}}, welcome to our service!"

created_at

string<date-time>

Template creation timestamp

updated_at

string<date-time>

Template last update timestamp

⌘I

Email API · Messages

Email API · Dynamic templates

Marketing · Campaigns

Marketing · Drip campaigns

Marketing · Subscribers

Marketing · Subscription lists

Marketing · Tracking links

Marketing · Analytics

Forms API

Create a dynamic template

Authorizations

Body

Response