API Reference

Print Mail

Mailing Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Mailing List

print_mail.mailing_lists.create(MailingListCreateParams**kwargs) -> MailingList

POST/print-mail/v1/mailing_lists

Create a new mailing list.

ParametersExpand Collapse

description: Optional[str]

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

metadata: Optional[Dict[str, object]]

See the section on Metadata.

idempotency_key: Optional[str]

ReturnsExpand 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.

Create Mailing List

Python

HTTP

TypeScript

Python

import os
from postgrid import PostGrid

client = PostGrid(
    print_mail_api_key=os.environ.get("POSTGRID_PRINT_MAIL_API_KEY"),  # This is the default and can be omitted
)
mailing_list = client.print_mail.mailing_lists.create(
    description="Test Mailing List",
    metadata={
        "campaign": "launch"
    },
)
print(mailing_list.id)

201 example

{
  "id": "mailing_list_123",
  "live": false,
  "description": "Test Mailing List",
  "metadata": {
    "campaign": "launch"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z",
  "status": "completed",
  "errors": []
}

Returns Examples

201 example

{
  "id": "mailing_list_123",
  "live": false,
  "description": "Test Mailing List",
  "metadata": {
    "campaign": "launch"
  },
  "createdAt": "2023-10-27T10:00:00Z",
  "updatedAt": "2023-10-27T10:00:00Z",
  "status": "completed",
  "errors": []
}