Edit a file format

Change a campaign's column mapping, location identifier or sample file. Use this when your export format changes. Send only the fields you want to change; a new sample file replaces the old one. Returns the updated mapping.

Prerequisites: a bearer token and the file format's id.

Authentication: Account token. The file format's campaign must be an automation campaign in your own account; otherwise 403.

Rate limit: none.

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

Required. The file format id. Digits only.

Body Params
string

A new column mapping, as a JSON object. When sent, it must have non-empty string values for email, phone, customer_name and location_identifier; otherwise 400.

file

A new sample file: .xlsx, .xls or .csv, up to 10 MB. Replaces the old one.

string
length ≤ 255

A new value for the location column that marks this campaign's rows, up to 255 characters.

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