Reviews

Create a review reply template

Changed on

This endpoint lets you create a review reply template.

post/reviews/template

Request

Request body

language'fr' | 'en' | 'es' | 'it' | 'pt-br' | 'de' | 'ar' | 'nl' | 'pl' | 'cs' | 'ca' | 'sk' | 'pt' | 'lv' | 'ro' | 'bg' | 'hu' required

Available language in the application

negativeboolean required

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

neutralboolean required

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

positiveboolean required

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

textstring 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.

titlestring required

Template title

Example request

{
  "language": "fr",
  "text": "hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)"
}

Response

OK

idinteger

Template id

org_idinteger

Unique identifier of an organization in Partoo.

update_datestring datetime

Template update date

creation_datestring datetime

Template creation date

language'fr' | 'en' | 'es' | 'it' | 'pt-br' | 'de' | 'ar' | 'nl' | 'pl' | 'cs' | 'ca' | 'sk' | 'pt' | 'lv' | 'ro' | 'bg' | 'hu'

Available language in the application

titlestring

Template title

textstring

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.

negativeboolean

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

neutralboolean

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

positiveboolean

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

Example response

{
  "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",
  "text": "hello @[](client_full_name),\nThanks from the team at @[](business_name).\n@[](my_first_name)"
}

Changes

    • breaking

      removed the enum value ar of the request property

    • breaking

      removed the enum value bg of the request property

    • breaking

      removed the enum value ca of the request property

    • breaking

      removed the enum value cs of the request property

    • breaking

      removed the enum value de of the request property

    • breaking

      removed the enum value en of the request property

    • breaking

      removed the enum value es of the request property

    • breaking

      removed the enum value fr of the request property

    • breaking

      removed the enum value hu of the request property

    • breaking

      removed the enum value it of the request property

    • breaking

      removed the enum value lv of the request property

    • breaking

      removed the enum value nl of the request property

    • breaking

      removed the enum value pl of the request property

    • breaking

      removed the enum value pt of the request property

    • breaking

      removed the enum value pt-br of the request property

    • breaking

      removed the enum value ro of the request property

    • breaking

      removed the enum value sk of the request property

    • info

      removed the ar enum value from the response property for the response status

    • info

      removed the bg enum value from the response property for the response status

    • info

      removed the ca enum value from the response property for the response status

    • info

      removed the cs enum value from the response property for the response status

    • info

      removed the de enum value from the response property for the response status

    • info

      removed the en enum value from the response property for the response status

    • info

      removed the es enum value from the response property for the response status

    • info

      removed the fr enum value from the response property for the response status

    • info

      removed the hu enum value from the response property for the response status

    • info

      removed the it enum value from the response property for the response status

    • info

      removed the lv enum value from the response property for the response status

    • info

      removed the nl enum value from the response property for the response status

    • info

      removed the pl enum value from the response property for the response status

    • info

      removed the pt enum value from the response property for the response status

    • info

      removed the pt-br enum value from the response property for the response status

    • info

      removed the ro enum value from the response property for the response status

    • info

      removed the sk enum value from the response property for the response status