Skip to main content
POST
curl

Authorizations

X-Api-Key
string
header
required

Your API key, sent as the value of the X-Api-Key header. In the dashboard, go to Integrations and open Deliveryman API Keys to create one.

Body

application/json
workspace_id
integer
required

ID of the workspace to create the contact list in.

name
string
required

Name of the contact list. Max 300 characters.

Required string length: 1 - 300
columns
string[]
required

Column names, in the same order as the values in each row. Column names must be unique.

Minimum array length: 1
Minimum string length: 1
Example:
rows
string[][]
required

Contact rows, excluding the header row. Each row lists values in columns order. Missing trailing values are treated as empty and extra values are ignored. Rows with a duplicate email address are skipped. At most 100000 rows.

Required array length: 1 - 100000 elements
Example:
field_mappings
ContactListFieldMapping · object[]
required

Which columns to import and the contact field each one is stored as. Exactly one column must be mapped to Email Address. Columns that aren't mapped are not imported.

Minimum array length: 1
unsubscribe_column
string | null

Column that marks contacts as unsubscribed. Contacts whose value in this column is yes, true or 1 (case-insensitive) are imported as unsubscribed and never emailed.

Minimum string length: 1
verify_emails
boolean
default:true

Whether to verify the contacts' email addresses after the import. Verification may be unavailable for some accounts, in which case it is skipped.

Response

Import Started

uid
string
required

UID of this contact list.

Maximum string length: 255
workspace_id
integer
required
read-only

ID of workspace this contact list belongs to.

name
string
required

Name of the contact list.

Maximum string length: 300
created_on
string<date-time>
required
read-only

Timestamp of when the contact list was created. ISO format date string in UTC timezone.

field_mappings
object[]
required
read-only

How the list's columns map to contact fields.

is_deletable
boolean
required
read-only

False while the list is used by a campaign that is created, scheduled, running or paused.

status
string

Current status of the contact list: uploading while contacts are being imported, verifying while email addresses are being verified, active when it's ready to use, or failed if the import failed.

Maximum string length: 100
source
string

Source of the contact list.

Maximum string length: 300
available_columns
any

List of columns available in the contact list.

has_unsubscribe_column
boolean

Indicates if the contact list contains an unsubscribe column.

unsubscribe_column_name
string | null

Name of the unsubscribe column, if present.

Maximum string length: 300
contacts_count
integer

Number of contacts in the contact list.

Required range: 0 <= x <= 2147483647
email_verification_status
enum<string>

Status of email address verification for this list.

  • processing - Processing
  • completed - Completed
  • skipping - Skipping
  • skipped - Skipped
  • failed - Failed
  • N/A - Not Applicable
Available options:
processing,
completed,
skipping,
skipped,
failed,
N/A