API Reference

Print Mail

Mailing Lists

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update Mailing List

print_mail.mailing_lists.update(strid, MailingListUpdateParams**kwargs) -> MailingListUpdate

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

Update an existing mailing list.

ParametersExpand Collapse

id: str

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.

ReturnsExpand Collapse

class MailingListUpdate: …

Parameters for updating an existing mailing list.

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.

Update 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_update = client.print_mail.mailing_lists.update(
    id="id",
    description="Updated Mailing List Description",
)
print(mailing_list_update.description)

200 example

{
  "description": "Test Mailing List",
  "metadata": {
    "campaign": "launch"
  }
}

Returns Examples

200 example

{
  "description": "Test Mailing List",
  "metadata": {
    "campaign": "launch"
  }
}