Review created

POST

reviewCreated

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

type

enum<string>

Available options:

review_created

payload

object

Show child attributes

payload.review

object

Business Review on partner

Show child attributes

payload.review.key

string

payload.review.org_id

integer

Organization id

Example:

42

payload.review.id

integer

Review id

Example:

34

payload.review.business_id

string

Business id

Example:

"5409c35a97bbc544d8e26737"

payload.review.partner

enum<string>

Publisher label

Available options:

google_my_business,

facebook,

tripadvisor

payload.review.partner_id

string

Review id on publisher

Example:

"accounts/114063712393225091258/locations/74805271119400652054"

payload.review.author_name

string

The author name of the review.

Note: Replies don't have an author.

Example:

"Castorche"

payload.review.date

string<datetime>

Review creation date

Example:

"2017-07-01T16:10:23.156000+02:00"

payload.review.update_date

string<datetime>

Review update date

Example:

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

payload.review.delete_date

string<datetime>

Review deletion date (only specified if the review has been deleted)

payload.review.rating

integer

Review rating (can be null)

Required range: 0 <= x <= 5

Example:

3

payload.review.recommended

boolean

Review recommended (can be null)

payload.review.title

string

Review title

payload.review.content

string

Review body content

Example:

"Magasin un peu vieillot , mais personnel très sympathique, nombreuses références en rayons , un très bon choix côté vin..."

payload.review.state

enum<string>

Reply state

Available options:

treated,

not_treated,

deleted

payload.review.link

string<uri>

Link to review on publisher platform

payload.review.comments

object

Reply to a review

Show child attributes

payload.review.comments.id

integer

Comment id

Example:

82938

payload.review.comments.partner_id

string

Review id on publisher

Example:

"accounts/114063712393225091258/locations/74805271119400652054"

payload.review.comments.created

string<datetime>

Creation date on Partoo

Example:

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

payload.review.comments.author_name

string

The author name of the review.

Note: Replies don't have an author.

Example:

"Castorche"

payload.review.comments.content

string

Reply content

Example:

"Merci ❤️"

payload.review.comments.date

string<datetime>

Comment date

Example:

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

payload.review.comments.update_date

string<datetime>

Comment update date. Only specified if the comment was updated

Example:

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

payload.review.comments.can_edit

boolean

If the current user can or cannot edit a reply

Note: This applies on Facebook replies only. A reply left by an external user on Facebook cannot be edited.

Example:

true

payload.review.comments.review_id

integer

Review id

Example:

34

payload.review.comments.parent_id

integer

id of the parent comment. Is only specified if the comment is a reply to another comment

Note: This applies on Facebook replies only.

payload.review.comments.user_id

string

User id of the comment author

Example:

"123456789abcdef2f60c42ff"

payload.review.comments.is_reply_suggestion

boolean

If AI reply suggestion was used to generate this comment

payload.review.comments.replies

array

List of replies to this comment

payload.review.tags

object[]

Tags associated to the review

Show child attributes

payload.review.tags.id

integer

Tag id

Example:

25

payload.review.tags.label

string

The label of the tag

Example:

"food"

payload.review.tags.color

enum<string>

The color of the tag, in hexadecimal representation

Available options:

#808080,

#9B7CDB,

#F47FBE,

#4D4D4D,

#9E6957,

#2F8DE4,

#37CED0,

#53C944,

#B1DA34,

#F78234,

#F4BD38,

#992842

Example:

"#808080"

payload.review.media_links

string<uri>[]

Array of Google photo URLs associated with the review.

Populated when with_media_links=true query parameter is used. Empty array if no associated media found or if with_media_links=false.

Example:

[
  "https://lh3.googleusercontent.com/gpms...",
  "https://lh3.googleusercontent.com/gpms-cs-s/AB8u6HYwO..."
]

Response

Return a 200 status to indicate that the event was properly received

Lead received Review updated

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

Webhooks

Webhooks Events

Authorizations

Body

Response