1. Review Campaigns
  • Getting Started
  • Locations
    • Location Attributes
      MARKDOWN
    • Photo specifications for your business location
      MARKDOWN
    • Star and Unstar Photos
      MARKDOWN
    • Create a new business location
      POST
    • Update business location
      POST
    • List all locations
      GET
    • List particular locations
      GET
    • Search locations
      GET
    • Get locations by store codes
      GET
    • Upload Photos to a Location
      POST
    • Check Bulk Photo Upload Status
      GET
    • Star/Unstar Location Photos
      POST
    • Delete Location Photos
      POST
    • Archive multiple locations
      POST
    • Cancel scheduled location archival
      POST
    • Activate archived locations
      POST
    • List Active Subscriptions
      GET
    • Get a list of supported countries and their states
      GET
    • Get SubCategories and AdditionalCategories
      GET
    • Get Site Details for Your Plan
      GET
  • Organizing locations
    • Organizing locations
      MARKDOWN
    • Create a new folder
      POST
    • List all folders
      GET
    • List all folders under an account in hierarchical structure
      GET
    • Get details of a folder
      GET
    • Rename a folder
      POST
    • Add locations to a folder
      POST
    • Remove locations from a folder
      POST
    • Delete a folder
      POST
    • List locations under a folder
      GET
    • List all tags
      GET
    • List locations by tags
      GET
    • Add location to a tag
      POST
    • Remove location from a tag
      POST
  • User Management
    • User Attributes
    • Create User with Role
    • List Users
    • List Users by ID
    • Add Locations to User
    • Add User and folder
    • List User Roles
    • Add folders to user
    • List User Resources
    • Update a User
    • Remove Folders for User
    • Remove Locations for User
  • Grid Rank
    • Local Rank Grid
    • Create Rank Grid Report
    • Fetch All Grid Reports for Location
    • Fetch Rank Grid Report By ID
  • Review Campaigns
    • Review Campaign Info Attributes
      MARKDOWN
    • Create a review campaign
      POST
    • Add customers to a review campaign
      POST
    • List review campaigns
      GET
    • List review campaign customers
      GET
  • Listings
    • Listings
    • Listing Status Webhooks
    • Get premium listings
    • Get voice listings for a location
    • Get duplicate listings for a location
    • Get all duplicate listings for an account
    • Mark listings as duplicates
    • Mark listings as not duplicates
    • Get AI listings
  • Connected Accounts
    • Connected Accounts
    • Connect Google Profile to Account
    • Connect Facebook Page to Account
    • List all connected accounts
    • List folders under a Google account
    • Create GMB Listing
    • Disconnect GMB Profile
    • Disconnect Facebook Account
    • Fetch Connected Account Details
    • Trigger New Matches
    • List Connection Suggestions
    • Fetch Connected Account Listings
    • Confirm Connected Account Matches
    • Connect a location with a listing of a connected account
    • Disconnect Location from Listing
  • Rankings
    • Rankings Analytics Attributes
    • Add keywords
    • List Keywords
    • Get keywords performance
    • Archive a keyword
    • Get Rollup Keyword Performance
    • Get Rankings Distribution By Time
  • Profile Analytics
    • Profile Analytics
    • Get Bing Analytics
    • Get Facebook Page Analytics
    • Get Google My Business Analytics
  • Reviews
    • Reviews
    • Review Sources
      • Get a list of interaction sources for location
      • Get a list of interaction sources for account
      • Add / Edit interaction source
    • Fetch all interactions
    • List Interactions by IDs
    • Respond to an Interaction
    • Edit Response for Interaction
    • Archive Response for Interaction
    • Get Interaction Analytics
    • Add Review Widget
    • Edit Review Widget
  • Automations
    • Temporary Close Location with a reopening date
  • Error Codes
    • ERROR CODES
  1. Review Campaigns

Review Campaign Info Attributes

MARKDOWN
https://api.synup.com/api/v4

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
Modified at 2025-02-19 08:31:59
Previous
Fetch Rank Grid Report By ID
Next
Create a review campaign
Built with