Review Generation via API
Learn how to automate review generation via API.
Table of Contents
This article covers both how to create templates via api and how send review requests to your customers.
Creating a Review Request Template
https://uberall.com/api/customer-engagement/swagger/review-generation-service-1.1.yml
Step 1 - Template Creation
Request
POST /api/customer-engagement/review-template
Payload
{
"name": "string",
"locationIds": [
0
],
"bodyText": "string",
"senderName": "string",
"email": {
"senderEmailId": "user@example.com",
"footerText": "string",
"subject": "string",
"actionButtonColor": "#A7a",
"privacyLink": "https://?:~Ei;cIlzZKbqn||hjX@EM",
"mediaIds": [
0
]
},
"reviewLinks": [
{
"url": "http://wG:UNbW=tSZqof.wFRxZoi;P/%VmBnhlMu:_88Z0NvyCK410Q7vm9cjOKqSPzzsibs!#L+",
"label": "string"
}
]
}
Response
{
"id": 0,
"type": "string",
"name": "string",
"locationIds": [
0
],
"bodyText": "string",
"senderName": "string",
"email": {
"senderEmailId": "string",
"footerText": "string",
"subject": "string",
"actionButtonColor": "string",
"privacyLink": "string",
"media": [
{
"mediaId": 0,
"message": "string",
"uploadUrl": "string"
}
]
},
"reviewLinks": [
{
"url": "string",
"label": "string"
}
],
"createdAt": "string",
"updatedAt": "string",
"errors": [
"string"
],
"message": "string"
}
Step 2 - Verifying your email identity (if not previously verified)
Request
POST /api/customer-engagement/identities
Payload
{
"emailAddress": "user@example.com"
}
Response
{
"emailAddress": "string",
"identityType": "string",
"verificationStatus": "string",
"message": "string"
}
Notes:
- After request an identity, you will receive an email from AWS to verify authenticate ownership of the request email identity.
Sending Review Requests to your customers
https://uberall.com/api/customer-management/swagger/review-generation-customer-service-1.0.yml
Step 1 - Uploading a list of customers you want to receive the request
Request
POST /api/customer-management/customers
Payload
{
"customerRequests": [
{
"businessId": 0,
"email": "string",
"locationId": 0,
"name": "string",
"phone": "string"
}
]
}
Response
{
"customerLocationIds": [
0
],
"message": "string"
}
Step 2 - Sending a request to your customers
Request
POST /api/review-template/job
Expected payload
{
"customerLocationIds": [
0
],
"reviewTemplateId": 0,
"scheduledDateTimeUtc": "string"
}
Response
{
"jobs": [
{
"batchId": 0,
"reviewTemplate": {
"name": "string",
"bodyText": "string",
"senderEmailId": "user@example.com",
"senderName": "string",
"type": "SMS",
"createdAt": "2023-03-29T12:35:06.721Z",
"updatedAt": "2023-03-29T12:35:06.721Z",
"id": 0,
"version": 0
},
"customerLocationId": 0,
"status": "IN_PROGRESS",
"createdAt": "2023-03-29T12:35:06.721Z",
"scheduledDateTimeUtc": "2023-03-29T12:35:06.721Z",
"id": 0,
"version": 0
}
],
"message": "string"
}
Notes:
- All requests require authentication. Please refer to your private API key.
- When sending a request for reviews, you'll need to include both the locationId related to each customer and the desired reviewTemplateId