v1

latestOpenAPI 3.1.0© Copyright Partoo2026-07-26163503484.0 KB

Review Booster

Send a review invitation

This endpoint lets you send an SMS to a customer to help them leave a message on Google. You need to have WRITE access on the business.
You can add invite_content in your payload to customize the SMS content that will be received by the recipient. Otherwise, the template associated with the user will be used. If no template exists, a new one will be generated.
Your business needs to be connected to a Google location and subscribed to the Review Booster product. Therefore, this cannot be tested in the Sandbox environment.
To prevent spamming, a new SMS can be sent to a specific phone number only after 10 days since the last SMS was sent.

post/review_booster/send_invitation

Request body

business_idstring required

Business id

target_phonestring required

Customer phone number, with the country calling code. Eg: +33601020304

target_namestring

Customer fullname

template_idinteger

Id of the SMS template you want to use

invite_contentstring

To customize SMS content instead of using the SMS template associated with the user. Cannot be used in combination with template_id. @link must be included in your payload (corresponds to the dynamic link that will allow the SMS recipient to leave a review on the business). Max 286 characters (unicode characters are not accepted - will be removed)

force'True' | 'False'

To force invitation sending when a SMS has already been sent to the customer

Example request

{
  "business_id": "5409c35a97bbc544d8e26737"
}

Response

invitation_idstring

invitation id

status'success'

Request status

Example response

{
  "invitation_id": "d3d8c966-0356-4ec0-baae-13ec3622ebc2"
}