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>"
}'
{
  "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
}

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

Organization id

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)