Campaigns
Set up and manage the campaigns that send review requests by email and text, and handle the private feedback that comes back.
Set up and manage the campaigns that send review requests by email and text, and handle the private feedback that comes back.
A campaign is a configured set of messages: who gets them, which templates, which channels, when, and any follow-up. Build one with the four-step wizard call, add recipients (Recipients page), preview it (Send a review request page), then launch. This page manages the campaign itself.
Private feedback. When a customer opens a review request and says they had a bad experience, they can leave a comment that goes to the business privately instead of becoming a public review. Two endpoints here handle that: one sends the comment to the business, the other records it as private feedback. Both are called by the landing page; they're documented so you can build your own landing experience if you want.
You'll need an account token and the store_id the campaign is for.
Prerequisites
- A bearer token in the
Authorizationheader. Any endpoint that needs no token says so on its own page. - The id of each record the call targets. Every endpoint page lists the ids it needs.
Errors
| Status | Meaning |
|---|---|
401 | The bearer token is missing, expired or invalid |
403 | The token is valid but the record sits outside your account |
422 | The request failed validation — the response names the fields |
500 | Unexpected server error |
Individual endpoints may return more; each page lists its own.
Endpoints
POST — Create a campaign, or update one in progress, one step at a time: details, channels and templates, recipients, schedule.
GET — Get everything about a campaign in one call: channels, templates, follow-up, recipients summary, and file mapping.
POST — Copy a campaign as a new draft with the same channels and templates but no recipients or schedule.
POST — Save a customer's private comment about their experience, tied to the review request they received, and notify the business.
POST — Email a customer's comment directly to the business owner or their managers, tied to the review request it came from.
Updated 26 days ago