v1

latestOpenAPI 3.0.02026-07-14106203730.9 KB

Mailing List Imports

Create Mailing List Import

Create a new mailing list import.

Initiates the import process for a contact list file. The import enters the validating status while contacts are processed and verified.

post/print-mail/v1/mailing_list_imports

idempotency-keystring

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

fileType'csv' required

Type of file supported for mailing list imports.

receiverMergeVariableMappingobject

Optional mapping of columns for receiver merge variables.

senderMergeVariableMappingobject

Optional mapping of columns for sender merge variables.

receiverAddressMappingobject required

Mapping of columns for receiver addresses.

senderAddressMappingobject

Optional mapping of columns for sender addresses. If this is present, then all receivers should have a corresponding sender.

The newly created mailing list import in validating status.

idstring required

A unique ID prefixed with mailing_list_import_

descriptionstring

An optional string describing this resource. Will be visible in the API and the dashboard.

metadataobject

See the section on Metadata.

liveboolean required

true if this is a live mode resource else false.

createdAtstring date-time required

The UTC time at which this resource was created.

updatedAtstring date-time required

The UTC time at which this resource was last updated.

status'validating' | 'completed' | 'changes_required' required

Status of the mailing list import process.

reportURLstring uri

A temporary URL to download the processing report, available once the import is completed.

validRowCountinteger required

Number of valid rows processed from the file.

invalidRowCountinteger required

Number of invalid rows found in the file.

organizationstring required

The organization that owns this import.