Define a file format

Tell a campaign which columns in your file mean what: name, email, phone, and the column that identifies the location. Use this once per file format before your first automated upload. It replaces any file format the campaign already had and makes the campaign an automation campaign; a bulk_upload or kiosk campaign is refused with 400. Returns the mapping with its id (201).

Prerequisites: a bearer token, a campaign in your account whose type is unset or automation, and a sample file (xlsx, xls or csv, up to 10 MB).

Authentication: Account token. The campaign must belong to your own account; otherwise 404.

Rate limit: none.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
integer
required

The campaign. Must exist (otherwise 422), belong to your own account (otherwise 404), and not be bulk_upload or kiosk (otherwise 400).

string
required

A JSON object mapping each field to a column name in your file. Must have non-empty string values for email, phone, customer_name and location_identifier; otherwise 400.

file
required

A sample file in your format: .xlsx, .xls or .csv, up to 10 MB.

string
required
length ≤ 255

The value in your location column (the one named by file_headers.location_identifier) that marks this campaign's rows; other rows are skipped. Up to 255 characters. Must not already be used by a file format at another location.

Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json