Mailing Lists

Create Mailing List

print_mail.mailing_lists.create() -> MailingList

POST/print-mail/v1/mailing_lists

List Mailing Lists

print_mail.mailing_lists.list() -> SyncSkipLimit[MailingList]

GET/print-mail/v1/mailing_lists

Get Mailing List

print_mail.mailing_lists.retrieve() -> MailingList

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

Update Mailing List

print_mail.mailing_lists.update(, ) -> MailingListUpdate

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

Delete Mailing List

print_mail.mailing_lists.delete() -> MailingListDeleteResponse

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

Submit a Mailing List Job

print_mail.mailing_lists.jobs(, ) -> MailingList

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

ModelsExpand Collapse

class MailingList: …

Represents a mailing list.

id: str

A unique ID prefixed with mailing_list_

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

live: bool

true if this is a live mode resource else false.

status: Literal["creating_contacts", "removing_contacts", "counting_recipient_country_codes", "completed"]

Status of the mailing list processing.

One of the following:

"creating_contacts"

"removing_contacts"

"counting_recipient_country_codes"

"completed"

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

description: Optional[str]

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

errors: Optional[List[Error]]

A list of processing errors encountered, if any.

message: str

A human-readable message describing the error.

type: Literal["mailing_list_imports_not_found_error", "download_file_error", "operational_error", "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[Dict[str, object]]

See the section on Metadata.

class MailingListUpdate: …

Parameters for updating an existing mailing list.