Automated campaigns

Send review requests automatically from a file your system produces, such as a daily export of completed jobs.

Send review requests automatically from a file your system produces, for example a daily export of completed jobs or transactions.

An automated campaign watches for uploads in a format you define. You tell it which column is the customer's name, which is email, which is phone, and it sends requests for each new row. Set the mapping once; upload files on your schedule.

You'll need an account token and a campaign to attach the automation to.

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

StatusMeaning
401The bearer token is missing, expired or invalid
403The token is valid but the record sits outside your account
422The request failed validation — the response names the fields
500Unexpected server error

Individual endpoints may return more; each page lists its own.

Endpoints

List automated campaigns

GET — Get the campaigns set up for automatic sending, with their file mappings.

Open →

Define a file format

POST — Tell a campaign which columns in your file mean what: name, email, phone, and any fields your templates use.

Open →

Get a campaign's file format

GET — See the column mapping a campaign expects.

Open →

Download a sample file

GET — Get a sample file in the format a campaign expects.

Open →

Edit a file format

PUT — Change a campaign's column mapping.

Open →

Delete a file format

DELETE — Remove a column mapping.

Open →


Did this page help you?