Skip to content

Import an existing list

POST
/v1/waitlist/import

Bring signups over from another tool. At most 1,000 rows per call. Rows are validated one by one: a bad row is skipped and reported, it never fails the call. Nobody is emailed. Imports count toward the plan’s signup limit, and running the same rows twice is safe. created_at keeps the original signup order.

Auth: Secret key only. All plans.

object
rows
required
Array<object>
>= 1 items <= 1000 items
object
email
required
string format: email
<= 254 characters /^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$/
created_at
string format: date-time
/^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$/
metadata
object
key
additional properties
Any of:
string
source
object
referrer
string
<= 2048 characters
utm_source
string
<= 255 characters
utm_medium
string
<= 255 characters
utm_campaign
string
<= 255 characters
landing_path
string
<= 512 characters
consent_confirmed
required

You confirm these people agreed to hear from you about this product.

boolean

inserted, skipped, skipped_by_reason (invalid_row, duplicate_in_file, already_on_list, disposable_email, plan_limit_reached), the first 100 skipped_rows with their index, and remaining_capacity.

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties

Error envelope. See error.code for the discriminator.

object
data
required
null
error
required
object
code
required
string
message
required
string
remediation
required
string
doc_url
string format: uri
param
string
request_id
string
meta
object
key
additional properties