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, such as a daily export of completed jobs.
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
| Method | Endpoint | Description |
|---|---|---|
GET | List automated campaigns | Paginated list of the caller's automation campaigns (rs_campaigns.type = 'automation'), each including its file_header configuration (headers map, sample-file path, location identifier). |
POST | Define a file format | Create the file-header (column-mapping) configuration for an automation campaign and uploads the sample file to S3. |
GET | Get a campaign's file format | Get the file-header configuration(s) for a given automation campaign. |
PUT | Edit a file format | Update an existing file-header configuration. |
DELETE | Delete a file format | Delete a file-header configuration and its associated sample file from S3. |
GET | Download a sample file | Get the S3 URL and metadata (name, size, mime type) for the sample file attached to a file-header configuration. |