Review Campaign Info Attributes

Overview

The Review Campaigns API allows you to create, manage, and retrieve review campaigns for specific locations. These campaigns help businesses collect customer reviews across various platforms.

Campaign Attributes

The following fields are used for creating campaigns. These fields are also returned while fetching campaigns.

Name	Field type	Description
id	String	Review Campaign ID
locationId	String	Location ID
screening	Boolean	Flag for screening enabled/disabled
landingPageTemplate	Object	Template for landing page. Refer Landing page template fields for details.
openingEmailTemplate	Object	Template for opening email. Refer Opening email template fields for details.
smsTemplate	Object	Template for SMS. Refer SMS template fields for details.
firstFollowUpTemplate	Object	Template for first follow-up. Refer First follow-up template fields for details.
firstFollowUpSchedule	Object	Schedule for first follow-up. Refer First follow-up schedule for details.
secondFollowUpTemplate	Object	Template for second follow-up. Refer Second follow-up template fields for details.
secondFollowUpSchedule	Object	Schedule for second follow-up. Refer Second follow-up schedule for details.
thankYouTemplate	Object	Template for thank you email. Refer Thank You template fields for details.
thankYouSchedule	Object	Schedule for thank you email. Refer Thank You email schedule for details.

Landing page template fields

Name	Field type	Description
content	String	Template content
heading	String	Template heading
reviewSiteHash	Array of Objects	Review site information

Opening email template fields

Name	Field type	Description
fromEmail	String	From email
replyTo	String	Reply to email
subject	String	Email subject
heading	String	Email heading
content	String	Email content
reviewSiteHash	Array of Objects	Review site information

SMS Template Fields

Name	Field type	Description
content	String	Template content
reviewSiteHash	Array of Objects	Review site information

First Follow-up Template Fields

Name	Field type	Description
fromEmail	String	From email
replyTo	String	Reply to email
subject	String	Email subject
heading	String	Email heading
content	String	Email content
reviewSiteHash	Array of Objects	Review site information

First Follow-up Schedule

The schedule can have the following values:

NEVER , DAYS_2 , DAYS_4 , DAYS_7

Second Follow-up Template Fields

Name	Field type	Description
fromEmail	String	From email
replyTo	String	Reply to email
subject	String	Email subject
heading	String	Email heading
content	String	Email content
reviewSiteHash	Array of Objects	Review site information

Second Follow-up Schedule

The schedule can have the following values:

NEVER , DAYS_5 , DAYS_10 , DAYS_15

Thank You Template Fields

Name	Field type	Description
fromEmail	String	From email
replyTo	String	Reply to email
subject	String	Email subject
heading	String	Email heading
content	String	Email content
reviewSiteHash	Array of Objects	Review site information

Thank You Email Schedule

The schedule can have the following values:

NEVER , HOURS_12 , DAY_1 , DAYS_3

Stat Fields

Name	Field type	Description
name	String	Stat name
value	String	Stat value

Review Campaign Info Attributes

reviewCampaignInfo Fields

Name	Field type	Description
campaignName	String	Review campaign name
reviewCampaignCustomers	Array	Customer details

reviewCampaignCustomers Fields

Name	Field type	Description
name	String	Customer name
phone	String	Customer phone
email	String	Customer email
rating	Integer	Rating given by customer
response	String	Response given by customer
date	String	Rating received date
followUpSent	Integer	No. of follow-ups sent
smsDeliveredAt	String	SMS delivered date and time
smsOpenedAt	String	SMS opened date and time
emailDeliveredAt	String	Email delivered date and time
emailLastOpenedAt	String	Email last opened date and time
emailLastClickedAt	String	Email last clicked at date and time
firstFollowUpAt	String	First follow-up sent date and time
firstFollowUpDeliveredAt	String	First follow-up delivered date and time
secondFollowUpAt	String	Second follow-up date and time
secondFollowUpDeliveredAt	String	Second follow-up delivered date and time

Follow-up Sent Values

The followUpSent field can have the following values:

0 , 1 , 2