API Reference

Print Mail

Campaigns

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Delete Campaign

print_mail.campaigns.delete(strid) -> CampaignDeleteResponse

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

Delete a campaign.

Campaigns can only be deleted if they are in draft, changes_required, or ready status. This also permanently deletes associated resources. This operation cannot be undone.

ParametersExpand Collapse

id: str

ReturnsExpand Collapse

class CampaignDeleteResponse: …

id: str

A unique ID prefixed with campaign_

deleted: Literal[true]

Delete Campaign

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
)
campaign = client.print_mail.campaigns.delete(
    "id",
)
print(campaign.id)

200 example

{
  "id": "campaign_sqF12lZ1VlBb",
  "deleted": true
}

Returns Examples

200 example

{
  "id": "campaign_sqF12lZ1VlBb",
  "deleted": true
}