Campaigns

Campaign lifecycle: list, get, cancel, duplicate, template cleanup.

Campaign lifecycle: list, get, cancel, duplicate, template cleanup.

Prerequisites

A bearer token in the Authorization header. 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

Method	Endpoint	Description
`GET`	List campaigns	List campaigns for the authenticated user's own company (paginated), with status/search filtering and sorting.
`GET`	Get campaign by id	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 campaign	Cancel a campaign owned by the caller's company by setting its status to `cancelled`.
`POST`	Duplicate campaign	Duplicate a campaign (and its active channels) under the same company as a fresh `draft` named "… (Copy)" with audience/scheduling fields reset.
`DELETE`	Remove follow-up template	Clear the follow-up email template association on a campaign channel by setting its `follow_up_template_id` to null.
`POST`	Create / update campaign (wizard step)	Create or advances a review-solicitation campaign through the 4-step setup wizard, branching on the `step` field.
`POST`	Send review request (test-review-request — deprecated alias)	Create a one-off audience row and queues an Email and/or SMS review request for a campaign (dispatched after DB commit onto the messaging queue).
`POST`	Direct-to-company email	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`	Direct comment feedback	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.