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

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

Update an existing mailing list.

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

ReturnsExpand Collapse

MailingListUpdate = object { description, metadata }

Parameters for updating an existing mailing list.

description: optional string

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

metadata: optional map[unknown]

See the section on Metadata.

Update Mailing List

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/mailing_lists/$ID \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY" \
    -d '{}'

200 example

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

Returns Examples

200 example

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