curl --request POST \
--url https://api.partoo.co/v2/messaging/templates \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"title": "Quote request",
"content": "{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝"
}
'import requests
url = "https://api.partoo.co/v2/messaging/templates"
payload = {
"title": "Quote request",
"content": "{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝"
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Quote request',
content: '{"text": "Hello, thank you for your request. For a quote, please contact us at 0123456789." "_version": "0.1"}',
icon: '📝'
})
};
fetch('https://api.partoo.co/v2/messaging/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.partoo.co/v2/messaging/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([
'title' => 'Quote request',
'content' => '{"text": "Hello, thank you for your request. For a quote, please contact us at 0123456789." "_version": "0.1"}',
'icon' => '📝'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$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.partoo.co/v2/messaging/templates"
payload := strings.NewReader("{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<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("https://api.partoo.co/v2/messaging/templates")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}"
response = http.request(request)
puts response.read_body{
"id": "642bca3d2830e15c6806cc33",
"title": "Quote request",
"content": "{\"text\": \"Hello {{client_full_name}}, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝",
"org_id": 123,
"created_at": "2023-01-31T16:22:17.327878+00:00",
"updated_at": "2023-02-15T10:00:00.000000+00:00",
"usage_count": 50
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Create message template
This endpoint lets you create a new message template.
⚠️ The content should be a valid stringified JSON object. It has to include both the "text" key with the message content
and the pair "_version": "0.1".
curl --request POST \
--url https://api.partoo.co/v2/messaging/templates \
--header 'Content-Type: application/json' \
--header 'x-APIKey: <api-key>' \
--data '
{
"title": "Quote request",
"content": "{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝"
}
'import requests
url = "https://api.partoo.co/v2/messaging/templates"
payload = {
"title": "Quote request",
"content": "{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝"
}
headers = {
"x-APIKey": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
title: 'Quote request',
content: '{"text": "Hello, thank you for your request. For a quote, please contact us at 0123456789." "_version": "0.1"}',
icon: '📝'
})
};
fetch('https://api.partoo.co/v2/messaging/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.partoo.co/v2/messaging/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([
'title' => 'Quote request',
'content' => '{"text": "Hello, thank you for your request. For a quote, please contact us at 0123456789." "_version": "0.1"}',
'icon' => '📝'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-APIKey: <api-key>"
],
]);
$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.partoo.co/v2/messaging/templates"
payload := strings.NewReader("{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-APIKey", "<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("https://api.partoo.co/v2/messaging/templates")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.partoo.co/v2/messaging/templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"title\": \"Quote request\",\n \"content\": \"{\\\"text\\\": \\\"Hello, thank you for your request. For a quote, please contact us at 0123456789.\\\" \\\"_version\\\": \\\"0.1\\\"}\",\n \"icon\": \"📝\"\n}"
response = http.request(request)
puts response.read_body{
"id": "642bca3d2830e15c6806cc33",
"title": "Quote request",
"content": "{\"text\": \"Hello {{client_full_name}}, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}",
"icon": "📝",
"org_id": 123,
"created_at": "2023-01-31T16:22:17.327878+00:00",
"updated_at": "2023-02-15T10:00:00.000000+00:00",
"usage_count": 50
}{
"errors": {
"authentication": "User not authenticated"
}
}{
"errors": {
"authorization": "Operation not allowed"
}
}Authorizations
The authentication system on Partoo API is using API Key that should be put in the header of the request (the name of the header is x-APIKey). An api_key is linked to a user. This user's role will give you different access level to the API features.
Body
The title of the template
"Quote request"
The template content as a stringified JSON object with "_version": "0.1" inside
"{\"text\": \"Hello, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}"
The icon linked to the template
"📝"
Response
The message template created
"642bca3d2830e15c6806cc33"
The title of the message template.
"Quote request"
The content of the message template should be a stringified JSON object. This includes both the message content ("text") and the pair "_version": "0.1".
The "text" can contain placeholders (values from the enum above within double curly braces {{}}) that will be replaced with the actual values when the message is sent.
client_full_name, client_first_name, business_name, my_first_name, rb_link, address, website_url, phone_number "{\"text\": \"Hello {{client_full_name}}, thank you for your request. For a quote, please contact us at 0123456789.\" \"_version\": \"0.1\"}"
The icon associated with the message template.
"📝"
The organization ID that the message template belongs to.
123
The date and time when the message template was created, in ISO 8601 format.
"2023-01-31T16:22:17.327878+00:00"
The date and time when the message template was last updated, in ISO 8601 format.
"2023-02-15T10:00:00.000000+00:00"
The number of times the message template has been used.
50
Was this page helpful?