Skip to main content
POST
/
reviews
/
template
Create a review reply template
curl --request POST \
  --url https://api.partoo.co/v2/reviews/template \
  --header 'Content-Type: application/json' \
  --header 'x-APIKey: <api-key>' \
  --data '
{
  "language": "fr",
  "negative": true,
  "neutral": true,
  "positive": true,
  "text": "hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)",
  "title": "<string>"
}
'
import requests

url = "https://api.partoo.co/v2/reviews/template"

payload = {
"language": "fr",
"negative": True,
"neutral": True,
"positive": True,
"text": "hello @[](client_full_name),
Thanks from the team at @[](business_name).
@[](my_first_name)",
"title": "<string>"
}
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({
language: 'fr',
negative: true,
neutral: true,
positive: true,
text: 'hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)',
title: '<string>'
})
};

fetch('https://api.partoo.co/v2/reviews/template', 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/reviews/template",
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([
'language' => 'fr',
'negative' => true,
'neutral' => true,
'positive' => true,
'text' => 'hello @[](client_full_name),
Thanks from the team at @[](business_name).
@[](my_first_name)',
'title' => '<string>'
]),
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/reviews/template"

payload := strings.NewReader("{\n \"language\": \"fr\",\n \"negative\": true,\n \"neutral\": true,\n \"positive\": true,\n \"text\": \"hello @[](client_full_name),\\nThanks from the team at @[](business_name).\\n@[](my_first_name)\",\n \"title\": \"<string>\"\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/reviews/template")
.header("x-APIKey", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"language\": \"fr\",\n \"negative\": true,\n \"neutral\": true,\n \"positive\": true,\n \"text\": \"hello @[](client_full_name),\\nThanks from the team at @[](business_name).\\n@[](my_first_name)\",\n \"title\": \"<string>\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.partoo.co/v2/reviews/template")

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 \"language\": \"fr\",\n \"negative\": true,\n \"neutral\": true,\n \"positive\": true,\n \"text\": \"hello @[](client_full_name),\\nThanks from the team at @[](business_name).\\n@[](my_first_name)\",\n \"title\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "id": 34,
  "org_id": 42,
  "update_date": "2017-08-01T19:15:54.256000+02:00",
  "creation_date": "2017-08-01T19:15:54.256000+02:00",
  "language": "fr",
  "title": "<string>",
  "text": "hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)",
  "negative": true,
  "neutral": true,
  "positive": true
}
{
"errors": {
"authentication": "User not authenticated"
}
}
{
"errors": {
"authorization": "Operation not allowed"
}
}
{
"errors": {
"json": "Resource not found"
}
}

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.

Body

application/json

Request body to post/edit a reply

language
enum<string>
required

Available language in the application

Available options:
fr,
en,
es,
it,
pt-br,
de,
ar,
nl,
pl,
cs,
ca,
sk,
pt,
lv,
ro,
bg,
hu
Example:

"fr"

negative
boolean
required

Template is made for negative reviews (ex from 1 to 2 stars on gmb)

neutral
boolean
required

Template is made for neutral reviews (ex 3 stars on gmb)

positive
boolean
required

Template is made for positive reviews (ex from 4 to 5 stars on gmb)

text
string
required

The content of the reply template.

Placeholders are recognisable within the text by this exact markup @[](name_of_the_placeholder). Where name_of_the_placeholder is the value field taken from the GET placeholders operation.

Example of usable placeholder values: client_full_name, client_first_name, business_name, my_first_name.

Example:

"hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)"

title
string
required

Template title

Response

OK

Review's reply template

id
integer

Template id

Example:

34

org_id
integer

Unique identifier of an organization in Partoo.

Example:

42

update_date
string<datetime>

Template update date

Example:

"2017-08-01T19:15:54.256000+02:00"

creation_date
string<datetime>

Template creation date

Example:

"2017-08-01T19:15:54.256000+02:00"

language
enum<string>

Available language in the application

Available options:
fr,
en,
es,
it,
pt-br,
de,
ar,
nl,
pl,
cs,
ca,
sk,
pt,
lv,
ro,
bg,
hu
Example:

"fr"

title
string

Template title

text
string

The content of the reply template.

Placeholders are recognisable within the text by this exact markup @[](name_of_the_placeholder). Where name_of_the_placeholder is the value field taken from the GET placeholders operation.

Example of usable placeholder values: client_full_name, client_first_name, business_name, my_first_name.

Example:

"hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)"

negative
boolean

Template is made for negative reviews (ex from 1 to 2 stars on gmb)

neutral
boolean

Template is made for neutral reviews (ex 3 stars on gmb)

positive
boolean

Template is made for positive reviews (ex from 4 to 5 stars on gmb)