Mailing Lists

The mailing lists API enables you to manage collections of contacts that can be used for bulk mail campaigns.

Create Mailing List

POST/print-mail/v1/mailing_lists

List Mailing Lists

GET/print-mail/v1/mailing_lists

Get Mailing List

GET/print-mail/v1/mailing_lists/{id}

Update Mailing List

POST/print-mail/v1/mailing_lists/{id}

Delete Mailing List

DELETE/print-mail/v1/mailing_lists/{id}

Submit a Mailing List Job

POST/print-mail/v1/mailing_lists/{id}/jobs

ModelsExpand Collapse

MailingList object { id, createdAt, live, 5 more }

Represents a mailing list.

id: string

A unique ID prefixed with mailing_list_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

live: boolean

true if this is a live mode resource else false.

status: "creating_contacts" or "removing_contacts" or "counting_recipient_country_codes" or "completed"

Status of the mailing list processing.

One of the following:

"creating_contacts"

"removing_contacts"

"counting_recipient_country_codes"

"completed"

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

description: optional string

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

errors: optional array of object { message, type }

A list of processing errors encountered, if any.

message: string

A human-readable message describing the error.

type: "mailing_list_imports_not_found_error" or "download_file_error" or "operational_error" or "internal_service_error"

Type of error encountered during mailing list processing.

One of the following:

"mailing_list_imports_not_found_error"

"download_file_error"

"operational_error"

"internal_service_error"

metadata: optional map[unknown]

See the section on Metadata.

MailingListUpdate object { description, metadata }

Parameters for updating an existing mailing list.