Update an email template

curl --request PUT \
  --url https://api.partoo.co/v2/feedback/email-templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data @- <<EOF
{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_text": "Leave a review",
  "cta_type": "BUTTON",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png",
  "color": "#3B82F6",
  "font_family": "Arial"
}
EOF

import requests

url = "https://api.partoo.co/v2/feedback/email-templates/{template_id}"

payload = {
    "name": "Default Template",
    "subject": "We'd love your feedback",
    "title": "How did we do?",
    "body": "Thank you for visiting us. Please take a moment to share your experience.",
    "cta_text": "Leave a review",
    "cta_type": "BUTTON",
    "post_cta_text": "Your feedback helps us improve.",
    "closing_text": "Thank you for your time!",
    "signature_name": "The Partoo Team",
    "logo_url": "https://example.com/logo.png",
    "banner_url": "https://example.com/banner.png",
    "color": "#3B82F6",
    "font_family": "Arial"
}
headers = {
    "x-APIKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Default Template',
    subject: 'We\'d love your feedback',
    title: 'How did we do?',
    body: JSON.stringify('Thank you for visiting us. Please take a moment to share your experience.'),
    cta_text: 'Leave a review',
    cta_type: 'BUTTON',
    post_cta_text: 'Your feedback helps us improve.',
    closing_text: 'Thank you for your time!',
    signature_name: 'The Partoo Team',
    logo_url: 'https://example.com/logo.png',
    banner_url: 'https://example.com/banner.png',
    color: '#3B82F6',
    font_family: 'Arial'
  })
};

fetch('https://api.partoo.co/v2/feedback/email-templates/{template_id}', 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/feedback/email-templates/{template_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Default Template',
    'subject' => 'We\'d love your feedback',
    'title' => 'How did we do?',
    'body' => 'Thank you for visiting us. Please take a moment to share your experience.',
    'cta_text' => 'Leave a review',
    'cta_type' => 'BUTTON',
    'post_cta_text' => 'Your feedback helps us improve.',
    'closing_text' => 'Thank you for your time!',
    'signature_name' => 'The Partoo Team',
    'logo_url' => 'https://example.com/logo.png',
    'banner_url' => 'https://example.com/banner.png',
    'color' => '#3B82F6',
    'font_family' => 'Arial'
  ]),
  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/feedback/email-templates/{template_id}"

	payload := strings.NewReader("{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.partoo.co/v2/feedback/email-templates/{template_id}")
  .header("x-APIKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/feedback/email-templates/{template_id}")

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

request = Net::HTTP::Put.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}"

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

{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_type": "BUTTON",
  "color": "#3B82F6",
  "font_family": "Arial",
  "id": 1,
  "org_id": 42,
  "created_at": "2024-01-15T10:30:00+00:00",
  "updated_at": "2024-06-01T08:00:00+00:00",
  "cta_text": "Leave a review",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png"
}

{
  "errors": {
    "authentication": "User not authenticated"
  }
}

{
  "errors": {
    "authorization": "Operation not allowed"
  }
}

{
  "errors": {
    "json": "Resource not found"
  }
}

{
  "detail": "cta_text is required when cta_type is BUTTON"
}

Feedback Management

Update an email template

The Feedback Management API is currently in BETA, therefore the following endpoints are subject to modification, given a 2 week notice.

If you are planning to use any of them, please notify us so we will be able to keep you informed about upcoming changes.

Updates an existing feedback email template belonging to the authenticated user’s organization.

All fields are optional — only the fields present in the request body are updated.

When the resulting cta_type is BUTTON (either newly set or already stored), cta_text must be non-null.

PUT

feedback

email-templates

{template_id}

Update an email template

curl --request PUT \
  --url https://api.partoo.co/v2/feedback/email-templates/{template_id} \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data @- <<EOF
{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_text": "Leave a review",
  "cta_type": "BUTTON",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png",
  "color": "#3B82F6",
  "font_family": "Arial"
}
EOF

import requests

url = "https://api.partoo.co/v2/feedback/email-templates/{template_id}"

payload = {
    "name": "Default Template",
    "subject": "We'd love your feedback",
    "title": "How did we do?",
    "body": "Thank you for visiting us. Please take a moment to share your experience.",
    "cta_text": "Leave a review",
    "cta_type": "BUTTON",
    "post_cta_text": "Your feedback helps us improve.",
    "closing_text": "Thank you for your time!",
    "signature_name": "The Partoo Team",
    "logo_url": "https://example.com/logo.png",
    "banner_url": "https://example.com/banner.png",
    "color": "#3B82F6",
    "font_family": "Arial"
}
headers = {
    "x-APIKey": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'x-APIKey': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Default Template',
    subject: 'We\'d love your feedback',
    title: 'How did we do?',
    body: JSON.stringify('Thank you for visiting us. Please take a moment to share your experience.'),
    cta_text: 'Leave a review',
    cta_type: 'BUTTON',
    post_cta_text: 'Your feedback helps us improve.',
    closing_text: 'Thank you for your time!',
    signature_name: 'The Partoo Team',
    logo_url: 'https://example.com/logo.png',
    banner_url: 'https://example.com/banner.png',
    color: '#3B82F6',
    font_family: 'Arial'
  })
};

fetch('https://api.partoo.co/v2/feedback/email-templates/{template_id}', 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/feedback/email-templates/{template_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Default Template',
    'subject' => 'We\'d love your feedback',
    'title' => 'How did we do?',
    'body' => 'Thank you for visiting us. Please take a moment to share your experience.',
    'cta_text' => 'Leave a review',
    'cta_type' => 'BUTTON',
    'post_cta_text' => 'Your feedback helps us improve.',
    'closing_text' => 'Thank you for your time!',
    'signature_name' => 'The Partoo Team',
    'logo_url' => 'https://example.com/logo.png',
    'banner_url' => 'https://example.com/banner.png',
    'color' => '#3B82F6',
    'font_family' => 'Arial'
  ]),
  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/feedback/email-templates/{template_id}"

	payload := strings.NewReader("{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.partoo.co/v2/feedback/email-templates/{template_id}")
  .header("x-APIKey", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/feedback/email-templates/{template_id}")

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

request = Net::HTTP::Put.new(url)
request["x-APIKey"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Default Template\",\n  \"subject\": \"We'd love your feedback\",\n  \"title\": \"How did we do?\",\n  \"body\": \"Thank you for visiting us. Please take a moment to share your experience.\",\n  \"cta_text\": \"Leave a review\",\n  \"cta_type\": \"BUTTON\",\n  \"post_cta_text\": \"Your feedback helps us improve.\",\n  \"closing_text\": \"Thank you for your time!\",\n  \"signature_name\": \"The Partoo Team\",\n  \"logo_url\": \"https://example.com/logo.png\",\n  \"banner_url\": \"https://example.com/banner.png\",\n  \"color\": \"#3B82F6\",\n  \"font_family\": \"Arial\"\n}"

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

{
  "name": "Default Template",
  "subject": "We'd love your feedback",
  "title": "How did we do?",
  "body": "Thank you for visiting us. Please take a moment to share your experience.",
  "cta_type": "BUTTON",
  "color": "#3B82F6",
  "font_family": "Arial",
  "id": 1,
  "org_id": 42,
  "created_at": "2024-01-15T10:30:00+00:00",
  "updated_at": "2024-06-01T08:00:00+00:00",
  "cta_text": "Leave a review",
  "post_cta_text": "Your feedback helps us improve.",
  "closing_text": "Thank you for your time!",
  "signature_name": "The Partoo Team",
  "logo_url": "https://example.com/logo.png",
  "banner_url": "https://example.com/banner.png"
}

{
  "errors": {
    "authentication": "User not authenticated"
  }
}

{
  "errors": {
    "authorization": "Operation not allowed"
  }
}

{
  "errors": {
    "json": "Resource not found"
  }
}

{
  "detail": "cta_text is required when cta_type is BUTTON"
}

Authorizations

x-APIKey

string

header

required

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.

Path Parameters

template_id

number

required

Template id

Body

application/json

name

string

Internal name for the template

Example:

"Default Template"

subject

string

Email subject line

Example:

"We'd love your feedback"

title

string

Title displayed in the email body

Example:

"How did we do?"

body

string

Main body text of the email

Example:

"Thank you for visiting us. Please take a moment to share your experience."

cta_text

string | null

Call-to-action label. Required when cta_type is BUTTON.

Example:

"Leave a review"

cta_type

enum<string>

Type of call-to-action rendered in the email.

BUTTON: a clickable button; cta_text must be non-null.
EMBEDDED_NPS: an NPS score row embedded in the email.

Available options:

BUTTON,

EMBEDDED_NPS

Example:

"BUTTON"

post_cta_text

string | null

Text displayed below the call-to-action

Example:

"Your feedback helps us improve."

closing_text

string | null

Closing paragraph of the email

Example:

"Thank you for your time!"

signature_name

string | null

Name displayed in the email signature

Example:

"The Partoo Team"

logo_url

string<uri> | null

URL of the organization logo displayed in the email header

Example:

"https://example.com/logo.png"

banner_url

string<uri> | null

URL of the banner image displayed in the email

Example:

"https://example.com/banner.png"

color

string

Primary accent color for the email template (hex code)

Example:

"#3B82F6"

font_family

enum<string>

Font family used in the email

Available options:

Arial,

Helvetica,

Verdana,

Georgia,

Trebuchet

Example:

"Arial"

Response

name

string

required

Internal name for the template

Example:

"Default Template"

subject

string

required

Email subject line

Example:

"We'd love your feedback"

title

string

required

Title displayed in the email body

Example:

"How did we do?"

body

string

required

Main body text of the email

Example:

"Thank you for visiting us. Please take a moment to share your experience."

cta_type

enum<string>

required

Type of call-to-action rendered in the email.

BUTTON: a clickable button; cta_text must be non-null.
EMBEDDED_NPS: an NPS score row embedded in the email.

Available options:

BUTTON,

EMBEDDED_NPS

Example:

"BUTTON"

color

string

required

Primary accent color for the email template (hex code)

Example:

"#3B82F6"

font_family

enum<string>

required

Font family used in the email

Available options:

Arial,

Helvetica,

Verdana,

Georgia,

Trebuchet

Example:

"Arial"

integer

required

Unique identifier of the email template

Example:

1

org_id

integer

required

The organization ID that owns this template

Example:

42

created_at

string<date-time>

required

Date and time the template was created

Example:

"2024-01-15T10:30:00+00:00"

updated_at

string<date-time>

required

Date and time the template was last updated

Example:

"2024-06-01T08:00:00+00:00"

cta_text

string | null

Call-to-action label. Required when cta_type is BUTTON.

Example:

"Leave a review"

post_cta_text

string | null

Text displayed below the call-to-action

Example:

"Your feedback helps us improve."

closing_text

string | null

Closing paragraph of the email

Example:

"Thank you for your time!"

signature_name

string | null

Name displayed in the email signature

Example:

"The Partoo Team"

logo_url

string<uri> | null

URL of the organization logo displayed in the email header

Example:

"https://example.com/logo.png"

banner_url

string<uri> | null

URL of the banner image displayed in the email

Example:

"https://example.com/banner.png"

Create an email template Delete an email template

⌘I

ApiKeys

Businesses

Business Fields

Categories

Connection Tokens

Messages

Custom Channels

Message Reply Templates

Messaging Settings

Custom Fields

Custom Fields Section

Custom Roles

Google

Groups and Sections

Holidays

Organizations

Posts

Place Action Links

Presence

Reviews

Presence analytics

Review analytics

Review Booster

Subscriptions

Users

Feedback Management

Feedback analytics

Webhooks

Webhooks Events

Update an email template

Authorizations

Path Parameters

Body

Response