Skip to content
SynupAPI
Get an API key

CreateReviewCampaignRequest__v2

Fields

NameTypeRequiredDescription
inputobjectrequired
input.locationIdstringrequiredEncoded Location ID
input.namestringrequiredReview Campaign Name
input.locationCustomersarray of objectrequiredCampaign customers to create
input.locationCustomers[].namestringrequired
input.locationCustomers[].emailstringoptional
input.locationCustomers[].phonestringoptional
input.screeningbooleanoptionalFlag for screening enabled/disabled
input.landingPageTemplateobjectoptionalLanding page template(Use only when screening = true).
input.landingPageTemplate.contentstringoptional
input.landingPageTemplate.headingstringoptional
input.landingPageTemplate.reviewSiteHasharray of objectoptional
input.landingPageTemplate.reviewSiteHash[].namestringoptional
input.landingPageTemplate.reviewSiteHash[].urlstringoptionalURL for connected sites (maps.google.com, facebook.com, foursquare.com) or custom sites
input.openingEmailTemplateobjectoptionalTemplate for the very first email sent out.
input.openingEmailTemplate.replyTostringoptional
input.openingEmailTemplate.subjectstringoptional
input.openingEmailTemplate.headingstringoptional
input.openingEmailTemplate.contentstringoptional
input.openingEmailTemplate.reviewSiteHasharray of objectoptionalNot required when screening is true
input.openingEmailTemplate.reviewSiteHash[].namestringoptional
input.openingEmailTemplate.reviewSiteHash[].urlstringoptionalURL for connected sites (maps.google.com, facebook.com, foursquare.com) or custom sites
input.smsTemplateobjectoptionalTemplate for the very first SMS sent out.
input.smsTemplate.contentstringoptional
input.smsTemplate.reviewSiteHasharray of objectoptionalMax 1 for smsTemplate Not required when screening is true
input.smsTemplate.reviewSiteHash[].namestringoptional
input.smsTemplate.reviewSiteHash[].urlstringoptionalURL for connected sites (maps.google.com, facebook.com, foursquare.com) or custom sites