Skip to content
SynupAPI
Get an API key

ReviewCampaign

Fields

NameTypeRequiredDescription
idstringoptionalUnique identifier for the review campaign
locationIdstringoptionalLocation identifier
namestringoptionalName of the campaign
screeningbooleanoptionalWhether screening is enabled
createdAtstringoptionalCreation timestamp
openingEmailTemplateobjectoptional
openingEmailTemplate.contentstringoptional
openingEmailTemplate.fromEmailstringoptional
openingEmailTemplate.headingstringoptional
openingEmailTemplate.replyTostringoptional
openingEmailTemplate.reviewSiteHasharray of stringoptional
openingEmailTemplate.subjectstringoptional
smsTemplateobjectoptional
smsTemplate.contentstringoptional
smsTemplate.reviewSiteHasharray of stringoptional
firstFollowUpSchedulestringoptional
DAYS_2DAYS_5
firstFollowUpTemplateobjectoptional
firstFollowUpTemplate.contentstringoptional
firstFollowUpTemplate.fromEmailstringoptional
firstFollowUpTemplate.headingstringoptional
firstFollowUpTemplate.replyTostringoptional
firstFollowUpTemplate.reviewSiteHasharray of stringoptional
firstFollowUpTemplate.subjectstringoptional
secondFollowUpSchedulestringoptional
DAYS_2DAYS_5
secondFollowUpTemplateobjectoptional
secondFollowUpTemplate.contentstringoptional
secondFollowUpTemplate.fromEmailstringoptional
secondFollowUpTemplate.headingstringoptional
secondFollowUpTemplate.replyTostringoptional
secondFollowUpTemplate.reviewSiteHasharray of stringoptional
secondFollowUpTemplate.subjectstringoptional
statsarray of objectoptional
stats[].namestringoptional
emails_sentsms_sentinvite_open_rateclicks_ratecustomer_exp_score
stats[].valuestringoptional
numberOfFeedbacksintegeroptionalTotal number of feedbacks received