Skip to main content
POST
Import a file

Authorizations

Authorization
string
header
required

An API token. The "read" ability: GET routes only. "read + write": every route.

Headers

Idempotency-Key
string

Replay a write safely: the same key gives back the first answer for 24 hours (header Idempotent-Replay: true). Read on POST, PUT and PATCH; DELETE ignores it. 255 characters at most.

Maximum string length: 255

Path Parameters

list
string<uuid>
required

The list's identifier (uuid).

Body

multipart/form-data
file
file
required
mapping
object

Column header => email, first_name, last_name, tags, timezone, locale, ignore, or attribute:name.

tags
string[]

Given to every line.

Maximum array length: 20
replace_tags
boolean
resubscribe_unsubscribed
boolean

Subscribes again the people in the file who had unsubscribed.

trigger_automations
boolean
default:false

Welcomes the people of the file as new subscribers: the welcome e-mail and the automations for newcomers start for every row. Off by default: imported people are added quietly, and only the webhooks are told.

Response

Import accepted and queued.

data
object