Get More Reviews
On this page, we’ll dive into how you can send review request invites to contacts by using the API. Before using this endpoint make sure the specified token has the following permission: View, create, edit and delete request.
Send Invites
This endpoint allows you to send review request invites via email and/or SMS to the contact.
Campaign
Before getting started you will need to get the campaigns UUID to find this login to your account and then click the "Send Invites" button in the top navigation, within the popup click "Create Automation", then click "Send invites via API" and then copy the Campaign ID. This ID should be apart of the URL replacing campaign with the ID. Note: if you have multiple campaigns a dropdown will be shown so make sure to select the right campaign first.
Required permissions
View, create, edit and delete request
Required attributes
- Name
email- Type
- string
- Description
The email for the customer must be a valid email address. Required when phone is not present.
- Name
phone- Type
- string
- Description
The phone for the customer must be a valid phone number. Phone number in E.164 format e.g. +14275238194. Required if email is not provided.
Optional attributes
- Name
first_name- Type
- string
- Description
The first name for the customer must be a string. The first name for the customer must be a maximum of 255 characters.
- Name
last_name- Type
- string
- Description
The last name for the customer must be a string. The last name for the customer must be a maximum of 255 characters.
- Name
send_after_hours- Type
- integer
- Description
The send in field for the customer must be an integer. The send in field for the customer must be at least 0 hours. If set to zero the customer will be sent the request immediately. To use campaign defaults then leave null.
Request
curl https://your-whitelabel-domain.com/api/v1/request-reviews/campaigns/{campaign}/invite \
-H "Authorization: Bearer {token}" \
-d email="[email protected]" \
-d phone="1-800-759-3000" \
-d first_name="Bob"
Response
{
"id": "1a88e2e3-181b-4164-8054-8a532e9eb9cb",
"message": "Invites sent successfully.",
}
Get All Campaigns
This endpoint allows you to fetch all campaigns via the API.
Optional attributes
- Name
search- Type
- string
- Description
Search for campaigns by name.
- Name
organization_id- Type
- integer
- Description
Filter campaigns by the organization ID.
Request
curl https://your-whitelabel-domain.com/api/v1/request-reviews/campaigns \
-H "Authorization: Bearer {token}" \
Response
{
"data": [
{
"id": "ce399e6e-d8bf-4254-8cf5-f16d0b29997d",
"name": "My Campaign",
},
],
"links": {
"first": "https:\/\/your-whitelabel-domain.com\/api\/agency\/v1\/campaigns?page=1",
"last": null,
"prev": null,
"next": "https:\/\/your-whitelabel-domain.com\/api\/agency\/v1\/campaigns?page=2"
},
"meta": {
"current_page": 1,
"from": 1,
"path": "https:\/\/your-whitelabel-domain.com\/api\/agency\/v1\/campaigns",
"per_page": 10,
"to": 10
}
}