Synup
Create a key
v1Resources/Review Invites/getList campaigns

List campaigns

Lists a location's review-invite campaigns, newest first.

get/api/v1/review-invites/campaigns
review-invite:read
Query parameters
locationIdstringrequired
The location to list campaigns for. Required.
pageintegeroptional
Zero-indexed page number. Defaults to 0.
statusstring (all | draft | launched | stopped | archived)optional
Filter by status. Defaults to all.
Response
dataobjectoptional
campaignsarray of unknownoptional
The matching campaigns.
totalnumberoptional
Total number of campaigns matching the filters.
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
get/api/v1/review-invites/campaigns
Your API key
locationId *
page
status
{
  "data": {
    "rows": [
      {
        "id": "cm_campaign_1",
        "name": "Spring Checkup Follow-up",
        "type": "email_sms",
        "collectMode": "directory",
        "status": "draft",
        "archived": false,
        "locationLabel": "Acme Dental — Downtown · Austin",
        "emailsSent": 0,
        "smsSent": 0,
        "repliesCount": 0,
        "clickRate": null,
        "followUpSent": 0,
        "autoSend": true,
        "yelpCompliant": true,
        "staticUrl": null
      }
    ],
    "total": 1
  }
}