Skip to main content
POST

Authorizations

Authorization
string
header
required

Project API key (sk_api_…).

Body

application/json
name
string
required
Required string length: 1 - 120
kind
enum<string>
required
Available options:
csv_upload
uploadId
string<uuid>
required

An upload from /contact-lists/uploads, reusable for more than one list.

mapping
object

Overrides the columns detected when the file was uploaded.

Response

The stored list.

listId
string<uuid>
organizationId
string<uuid>
projectId
string<uuid>
name
string
sourceKind
enum<string>
Available options:
csv_upload,
paste,
google_sheets,
customer_api
sourceRef
string

Present only when the import supplied an uploadId or a sheet ref — inline rows have none, even when labelled csv_upload.

summary
object

What the import kept and dropped.

contactCount
integer

Contacts stored — the same number as summary.willBeCalled.

createdAt
string<date-time>
updatedAt
string<date-time>

Equal to createdAt, since a list is never edited.

version
integer

Always 1.