This feature is available only for businesses subscribed to Review Booster.
Prerequisites
Before using the Review Booster API, ensure you have:- Active subscription to Review Booster
- Valid API key
- Write access on the business for sending invitations
- Google My Business Integration: Your business must be connected to a valid Google My Business location
If you need help with any of these prerequisites, please contact your Account Manager who can guide you through the process.
The Review Booster cannot be tested in the Sandbox environment as it requires an active Google My Business connection and a valid subscription.
How Review Booster Works
The Review Booster allows you to proactively request reviews from your customers by sending them personalized SMS messages containing a direct link to leave a review on your Google Business Profile.SMS Invitation Flow
- Configure sender name: Set up a branded expeditor name that customers will see instead of a phone number
- Create or customize template: Use placeholders to personalize your message
- Send invitation: The system generates a unique review link and sends the SMS to the customer
- Track delivery: Monitor the status of each invitation (created, sent, delivered, or failed)
- Customer reviews: Customers click the link in the SMS and are directed to leave a review on Google
Anti-Spam Protection
To prevent spamming and maintain compliance with messaging regulations:- 10-day cooldown period: A new SMS can only be sent to a specific phone number after 10 days since the last SMS was sent
- Duplicate detection: Use the search endpoint to check if an invitation was already sent to a customer
- Force override: You can use the
force
parameter to bypass the cooldown period when necessary
Overriding the anti-spam protection with the
force
parameter should be used sparingly to avoid customer complaints and maintain compliance with messaging regulations.Monthly Quotas
Review Booster has monthly sending limits to ensure fair usage and cost management:- Default quota: Each business starts with 200 SMS invitations per month
- Automatic reset: Quotas reset at the beginning of each month based on the business’s timezone
- Quota tracking: The system tracks remaining invitations and prevents sending when the limit is reached
- Error handling: When the quota is exhausted, you’ll receive an error:
rb_monthly_limit_reached_for_business
- Custom quotas: Your quota can be adjusted (between 1-1000 per month) by your Account Manager through the admin panel if your business needs differ from the default
Implementing Review Booster
Follow these steps to integrate Review Booster into your application:1
Configure the Sender Name
Before sending invitations, set up a sender name for your business. The sender name must be alphanumeric only, max 11 characters, with one space allowed.
See the Configuring Your Sender Name section below for detailed rules and best practices.
2
Customize Your SMS Template (Optional)
Customize your reusable template that will be used for all future invitations. If you skip this step, a default template will be created automatically when you send your first invitation.
Template placeholders: Use
${client_name}
, ${business_name}
, and ${url}
(required). Max 250 characters excluding placeholders.See the Working with SMS Templates section below for detailed information about placeholders, constraints, and examples.
3
Check for Duplicate Invitations (Recommended)
Before sending, check if the customer was recently contacted:
You can find more about the endpoint in the Search Invitations API Reference.
4
Send the Review Invitation
You have two options for SMS content when sending invitations:
- Using your template - Uses your saved template (or default if not customized) with placeholders automatically filled
- Using custom content - Provide unique
invite_content
for this specific invitation only
- Using Template
- Using Custom Content
A successful response includes an
invitation_id
that you can use to track the delivery status.You can find more about the endpoint in the Send Invitation API Reference.
5
Track Invitation Status
Monitor the delivery status of your invitation:
Understanding Invitation States
Understanding Invitation States
Each invitation goes through one of these lifecycle states:
CREATED
: Invitation has been created in the systemSENT
: SMS has been sent to the mobile carrierDELIVERED
: SMS has been successfully delivered to the customer’s deviceFAILED_SEND
: SMS failed to be sent to the carrierFAILED_DELIVERY
: SMS was sent but could not be delivered to the customer
The status is updated in real-time via webhooks from the SMS provider. It may take a few seconds for the status to change from
SENT
to DELIVERED
.You can find more about the endpoint in the Get Invitation Status API Reference.
Configuring Your Sender Name
The expeditor name is what customers see as the sender when they receive the SMS instead of a phone number. A well-chosen sender name improves message open rates and trust.Tips for an Effective Sender Name
Tips for an Effective Sender Name
To ensure that SMS messages reach customers correctly and comply with carrier requirements, follow these rules:
- Do not use first names: Avoid personal names like “Léo”, “Laurence”, “Cédric”
- Do not use generic names: Avoid generic terms like “Info”, “SMS”, “The Mayor”
- Use only alphanumeric characters: Letters and numbers only, no special characters or emojis
- Maximum 11 characters: Keep your sender name concise
- Only one space allowed: Multiple spaces are not permitted
We recommend using your brand or business name while following these rules. For example: “CafeParisien” or “MyStore”
Managing the Sender Name
Managing the Sender Name
1
Set the expeditor name for a business
Use the POST endpoint to configure the sender name:
You can find more about the endpoint in the Set Expeditor Name API Reference.
2
Retrieve the current expeditor name
Get the configured sender name for a business:
You can find more about the endpoint in the Get Expeditor Name API Reference.
Working with SMS Templates
Templates allow you to create reusable, personalized messages for your review invitations. They support dynamic placeholders that are automatically filled when sending invitations.Available Placeholders & Constraints
Available Placeholders & Constraints
Available Placeholders
You can use the following placeholders in your templates:${client_name}
: The customer’s name (fromtarget_name
parameter)${business_name}
: Your business name from Partoo${url}
: The unique review link (required in every template)
The
${url}
placeholder is mandatory in every template. Templates without it will be rejected.Template Constraints
- Maximum 250 characters: Excluding placeholders (placeholders don’t count toward the limit)
- Must include
${url}
: The review link placeholder is required - One template per user: Each user has a single template that applies to all their businesses
Managing Templates
Managing Templates
1
Get your current template
Retrieve your existing template (a default template is created if none exists):
If no template exists, the system automatically creates a default template for you.
You can find more about the endpoint in the Get Template API Reference.
2
Update your template
Customize your template with your own message:Example template:
You can find more about the endpoint in the Update Template API Reference.