API Reference

Print Mail

Campaigns

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update Campaign

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

Update an existing campaign.

Campaigns can only be updated if they are in the draft or changes_required status. Updating a campaign will trigger reprocessing and set its status back to drafting.

Path ParametersExpand Collapse

id: string

Body ParametersJSONExpand Collapse

chequeProfile: optional string

The ID of the cheque profile to use. Setting this will remove other profile types. Set to null to remove.

defaultSenderContact: optional string

The ID of the default sender contact. Set to null to remove.

description: optional string

An optional description for the campaign. Set to null to remove the existing description.

letterProfile: optional string

The ID of the letter profile to use. Setting this will remove other profile types. Set to null to remove.

mailingList: optional string

The ID of the mailing list to associate with this campaign.

metadata: optional map[string]

Optional key-value data associated with the campaign. Set to null to remove existing metadata.

postcardProfile: optional string

The ID of the postcard profile to use. Setting this will remove other profile types. Set to null to remove.

selfMailerProfile: optional string

The ID of the self-mailer profile to use. Setting this will remove other profile types. Set to null to remove.

ReturnsExpand Collapse

Campaign = object { id, createdAt, createdCount, 15 more }

Represents a bulk mail campaign.

id: string

A unique ID prefixed with campaign_

createdAt: string

The UTC time at which this resource was created.

formatdate-time

createdCount: number

The number of orders successfully created for this campaign.

formatint32

live: boolean

true if this is a live mode resource else false.

mailingList: string

The ID of the mailing list associated with this campaign.

status: "drafting" or "changes_required" or "creating_orders" or 4 more

Status of the campaign lifecycle.

One of the following:

"drafting"

"changes_required"

"creating_orders"

"draft"

"ready"

"printing"

"processed_for_delivery"

updatedAt: string

The UTC time at which this resource was last updated.

formatdate-time

chequeProfile: optional string

The ID of the cheque profile used for this campaign, if applicable.

defaultSenderContact: optional string

The ID of the default sender contact to use for orders if not specified per recipient.

description: optional string

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

errors: optional array of object { message, type }

A list of processing errors encountered, if any. Present when status is 'changes_required'.

message: string

A human-readable message describing the error.

type: "processing_error" or "internal_error"

Type of error encountered during campaign processing.

One of the following:

"processing_error"

"internal_error"

letterProfile: optional string

The ID of the letter profile used for this campaign, if applicable.

metadata: optional map[unknown]

See the section on Metadata.

orderPreviewURL: optional string

A temporary URL to preview the first rendered order, available once the campaign status is 'draft' or later.

formaturi

postcardProfile: optional string

The ID of the postcard profile used for this campaign, if applicable.

reportURL: optional string

A temporary URL to download the processing report, available once the campaign is in the ready status.

formaturi

selfMailerProfile: optional string

The ID of the self-mailer profile used for this campaign, if applicable.

sendDate: optional string

The scheduled date and time for the campaign to be sent.

formatdate-time

Update Campaign

HTTP

HTTP

TypeScript

Python

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

200 example

{
  "id": "campaign_sqF12lZ1VlBb",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "createdCount": 0,
  "live": true,
  "mailingList": "mailingList",
  "status": "drafting",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "chequeProfile": "chequeProfile",
  "defaultSenderContact": "defaultSenderContact",
  "description": "description",
  "errors": [
    {
      "message": "message",
      "type": "processing_error"
    }
  ],
  "letterProfile": "letterProfile",
  "metadata": {
    "foo": "bar"
  },
  "orderPreviewURL": "https://example.com",
  "postcardProfile": "postcardProfile",
  "reportURL": "https://example.com",
  "selfMailerProfile": "selfMailerProfile",
  "sendDate": "2019-12-27T18:11:19.117Z"
}

Returns Examples

200 example

{
  "id": "campaign_sqF12lZ1VlBb",
  "createdAt": "2019-12-27T18:11:19.117Z",
  "createdCount": 0,
  "live": true,
  "mailingList": "mailingList",
  "status": "drafting",
  "updatedAt": "2019-12-27T18:11:19.117Z",
  "chequeProfile": "chequeProfile",
  "defaultSenderContact": "defaultSenderContact",
  "description": "description",
  "errors": [
    {
      "message": "message",
      "type": "processing_error"
    }
  ],
  "letterProfile": "letterProfile",
  "metadata": {
    "foo": "bar"
  },
  "orderPreviewURL": "https://example.com",
  "postcardProfile": "postcardProfile",
  "reportURL": "https://example.com",
  "selfMailerProfile": "selfMailerProfile",
  "sendDate": "2019-12-27T18:11:19.117Z"
}