Campaigns
Campaign lifecycle: list, get, cancel, duplicate, template cleanup.
Campaign lifecycle: list, get, cancel, duplicate, template cleanup.
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
GET — List campaigns for the authenticated user's own company (paginated), with status/search filtering and sorting.
GET — Get one campaign, including its channels, follow-up template, email and SMS requests, and file-header mapping — all in a single response, so you do not need follow-up calls to assemble the full picture.
POST — Cancel a campaign owned by the caller's company by setting its status to cancelled.
POST — Duplicate a campaign (and its active channels) under the same company as a fresh draft named "… (Copy)" with audience/scheduling fields reset.
DELETE — Clear the follow-up email template association on a campaign channel by setting its follow_up_template_id to null.
POST — Create or advance a review-solicitation campaign through the 4-step setup wizard, branching on the step field.
POST — Create a one-off audience row and queue an Email and/or SMS review request for a campaign (dispatched after DB commit onto the messaging queue).
POST — Record an internal customer_comment tied to an Email or SMS review request (looked up by unique_code) and emails the resolved recipients (store owner and/or configured manager/other-manager addresses, based on direct_to_option) using the DIRECT_TO_COMPANY template.
POST — Create an off-platform reviews row plus an internal customer comment tied to an Email or SMS review request (looked up by unique_code), then notifies the store's configured recipients with the CUSTOMER_COMMENT template.
Updated 11 days ago