Skip to main content

Send a review invitation

POST 
/api/v2/reviews/invitations

Send a review invitation

Request​

Body

required

    target_phone stringrequired

    Customer phone number, with the country calling code.

    target_name string

    Possible values: <= 255 characters

    Customer fullname

    invite_content string

    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 boolean

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

    business_id stringrequired

    Business id

Responses​

This endpoint lets you send an SMS to a costumer to help him leave a message on Google My Business. 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. Else, the template associated with the user will be used (see /reviews/boosts/template for more info). If no template exist, a new one will be generated.

Your business needs to be connected to a Google My Business location and to be subscribed to Review Booster product. So this cannot be tested in Sandbox Env. To prevent spamming, a new SMS can be sent to a specific phone number only after 10 days since the last SMS sent.

Schema

    result string
    invitation_id stringrequired

    Invitation ID

Loading...