v7

latestOpenAPI 3.0.0raw.githubusercontent.com2026-06-121372601.5 MB
Mailing List Imports

Update Mailing List Import

Update an existing mailing list import.

post/print-mail/v1/mailing_list_imports/{id}

Path parameters

idstring required

The unique identifier (mailing_list_import_...) for the import to update.

Request body

descriptionstring nullable

An optional description for the import. Set to null to remove the existing description.

metadataobject nullable

Optional key-value data associated with the import. Set to null to remove existing metadata.

Response

The updated mailing list import details.

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.