Create a message template

POST

notify

management

templates

curl --request POST \
  --url https://api.prelude.dev/v2/notify/management/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Receipts",
  "channels": [],
  "variants": [
    {
      "locale": "en",
      "text": "Hi {{name}}, your order {{order_id}} shipped."
    }
  ],
  "default_locale": "en",
  "countries": [
    {
      "country": "ES",
      "monthly_volume": 5000
    }
  ]
}
'

import requests

url = "https://api.prelude.dev/v2/notify/management/templates"

payload = {
    "name": "Acme Receipts",
    "channels": [],
    "variants": [
        {
            "locale": "en",
            "text": "Hi {{name}}, your order {{order_id}} shipped."
        }
    ],
    "default_locale": "en",
    "countries": [
        {
            "country": "ES",
            "monthly_volume": 5000
        }
    ]
}
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({
    name: 'Acme Receipts',
    channels: [],
    variants: [{locale: 'en', text: 'Hi {{name}}, your order {{order_id}} shipped.'}],
    default_locale: 'en',
    countries: [{country: 'ES', monthly_volume: 5000}]
  })
};

fetch('https://api.prelude.dev/v2/notify/management/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.prelude.dev/v2/notify/management/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 => json_encode([
    'name' => 'Acme Receipts',
    'channels' => [
        
    ],
    'variants' => [
        [
                'locale' => 'en',
                'text' => 'Hi {{name}}, your order {{order_id}} shipped.'
        ]
    ],
    'default_locale' => 'en',
    'countries' => [
        [
                'country' => 'ES',
                'monthly_volume' => 5000
        ]
    ]
  ]),
  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.prelude.dev/v2/notify/management/templates"

	payload := strings.NewReader("{\n  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\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.prelude.dev/v2/notify/management/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/templates")

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  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\n    }\n  ]\n}"

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

{
  "id": "template_01k8ap1btqf5r9fq2c8ax5fhc9",
  "type": "transactional",
  "name": "Acme Receipts",
  "status": "draft",
  "channels": [
    "sms"
  ],
  "variables": [
    "name",
    "order_id"
  ],
  "variants": [
    {
      "locale": "en",
      "text": "Hi {{name}}, your order {{order_id}} shipped."
    }
  ],
  "default_locale": "en",
  "countries": [
    {
      "country": "ES",
      "monthly_volume": 5000
    }
  ],
  "region_statuses": {},
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Create a message template. Only name is required, and the template always lands in draft: nothing is sent with it and no registration is opened until you submit it for review. The variables of the template are read from the {{placeholder}} names in your variants, so you never set them yourself. The same goes for status and region_statuses, which follow the review and the per-country registrations. While the template is a draft, every country in region_statuses reads draft.

Authorizations

Authorization

string

header

required

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

Body

application/json

name

string

required

The name of the template.

Example:

"Acme Receipts"

type

enum<string>

What the template is used for. Defaults to transactional.

Available options:

transactional,

marketing

channels

enum<string>[]

The channels the template should be delivered over.

Available options:

sms,

rcs,

whatsapp,

viber,

zalo,

telegram

variants

object[]

The wording of the message, one entry per locale.

Show child attributes

default_locale

string

The locale used when the recipient's own locale has no variant. Defaults to en.

Example:

"en"

countries

object[]

The countries the template should work in.

Show child attributes

Response

Created

string

required

The identifier of the template, to pass as template_id when sending a message.

Example:

"template_01k8ap1btqf5r9fq2c8ax5fhc9"

type

enum<string>

required

What the template is used for. Possible values are:

transactional - A message triggered by an action of the recipient.
marketing - A promotional message, subject to marketing rules.

Available options:

transactional,

marketing

name

string

required

The name of the template.

Example:

"Acme Receipts"

status

enum<string>

required

Where the template stands in the approval flow. Possible values are:

draft - Yours to edit. Nothing is sent with it yet.
pending - Submitted, and waiting on our review and on the per-country registrations.
ready - Approved and usable in every country you asked for.
rejected - Refused. Contact support for the reason.

Available options:

draft,

pending,

ready,

rejected

channels

enum<string>[]

required

The channels the template can be delivered over.

Available options:

sms,

rcs,

whatsapp,

viber,

zalo,

telegram

variables

string[]

required

The placeholder names found in the variants, to fill in when sending.

Example:

["name", "order_id"]

variants

object[]

required

The wording of the message, one entry per locale.

Show child attributes

default_locale

string

required

The locale used when the recipient's own locale has no variant.

Example:

"en"

countries

object[]

required

The countries the template works in, with the monthly volume recorded for each.

Show child attributes

region_statuses

object

required

The readiness of the template per country, keyed by ISO 3166-1 alpha-2 country code.

Show child attributes

created_at

string<date-time>

required

The date and time when the template was created.

Example:

"2024-01-01T12:00:00Z"

Create a message template

curl --request POST \
  --url https://api.prelude.dev/v2/notify/management/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Acme Receipts",
  "channels": [],
  "variants": [
    {
      "locale": "en",
      "text": "Hi {{name}}, your order {{order_id}} shipped."
    }
  ],
  "default_locale": "en",
  "countries": [
    {
      "country": "ES",
      "monthly_volume": 5000
    }
  ]
}
'

import requests

url = "https://api.prelude.dev/v2/notify/management/templates"

payload = {
    "name": "Acme Receipts",
    "channels": [],
    "variants": [
        {
            "locale": "en",
            "text": "Hi {{name}}, your order {{order_id}} shipped."
        }
    ],
    "default_locale": "en",
    "countries": [
        {
            "country": "ES",
            "monthly_volume": 5000
        }
    ]
}
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({
    name: 'Acme Receipts',
    channels: [],
    variants: [{locale: 'en', text: 'Hi {{name}}, your order {{order_id}} shipped.'}],
    default_locale: 'en',
    countries: [{country: 'ES', monthly_volume: 5000}]
  })
};

fetch('https://api.prelude.dev/v2/notify/management/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.prelude.dev/v2/notify/management/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 => json_encode([
    'name' => 'Acme Receipts',
    'channels' => [
        
    ],
    'variants' => [
        [
                'locale' => 'en',
                'text' => 'Hi {{name}}, your order {{order_id}} shipped.'
        ]
    ],
    'default_locale' => 'en',
    'countries' => [
        [
                'country' => 'ES',
                'monthly_volume' => 5000
        ]
    ]
  ]),
  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.prelude.dev/v2/notify/management/templates"

	payload := strings.NewReader("{\n  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\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.prelude.dev/v2/notify/management/templates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.prelude.dev/v2/notify/management/templates")

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  \"name\": \"Acme Receipts\",\n  \"channels\": [],\n  \"variants\": [\n    {\n      \"locale\": \"en\",\n      \"text\": \"Hi {{name}}, your order {{order_id}} shipped.\"\n    }\n  ],\n  \"default_locale\": \"en\",\n  \"countries\": [\n    {\n      \"country\": \"ES\",\n      \"monthly_volume\": 5000\n    }\n  ]\n}"

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

{
  "id": "template_01k8ap1btqf5r9fq2c8ax5fhc9",
  "type": "transactional",
  "name": "Acme Receipts",
  "status": "draft",
  "channels": [
    "sms"
  ],
  "variables": [
    "name",
    "order_id"
  ],
  "variants": [
    {
      "locale": "en",
      "text": "Hi {{name}}, your order {{order_id}} shipped."
    }
  ],
  "default_locale": "en",
  "countries": [
    {
      "country": "ES",
      "monthly_volume": 5000
    }
  ],
  "region_statuses": {},
  "created_at": "2024-01-01T12:00:00Z"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

{
  "code": "invalid_phone_number",
  "message": "The provided phone number is invalid. Provide a valid E.164 phone number.",
  "type": "bad_request",
  "request_id": "3d19215e-2991-4a05-a41a-527314e6ff6a",
  "param": "phone_number"
}

Documentation

API Reference

Create a message template

Authorizations

Body

Response