Campaigns

The campaigns API enables you to send out large volumes of fully personalized mail to a mailing list.

Create Campaign

POST/print-mail/v1/campaigns

List Campaigns

GET/print-mail/v1/campaigns

Get Campaign

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

Update Campaign

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

Delete Campaign

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

Send Campaign

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

ModelsExpand Collapse

Campaign object { id, createdAt, createdCount, 16 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

cheque: optional object { bankAccount, currencyCode, description, 12 more }

Inline cheque configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

bankAccount: optional string

ID of the bank account to use for the cheque.

currencyCode: optional "CAD" or "USD"

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

description: optional string

An optional description.

envelope: optional string

The custom envelope ID or "standard".

letterSettings: optional object { color }

Settings for the attached letter (e.g., color printing).

color: optional boolean

Whether to print the attached letter in color.

letterTemplate: optional string

ID of a template for an optional attached letter. Cannot be used with letterPDF.

letterUploadedPDF: optional string

A signed URL to the attached letter PDF, if any.

formaturi

logo: optional string

A publicly accessible URL for the logo to print on the cheque.

formaturi

mailingClass: optional "first_class" or "standard_class" or "express" or 23 more

Mailing class for the cheque.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

memo: optional string

Memo line text for the cheque.

mergeVariables: optional map[unknown]

Default merge variables for the cheque.

message: optional string

Message included on the cheque stub.

metadata: optional map[string]

Optional key-value metadata.

returnEnvelope: optional string

ID of a return envelope to include.

size: optional ChequeSize

Enum representing the supported cheque sizes.

One of the following:

"us_letter"

"us_legal"

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"

letter: optional object { addressPlacement, attachedPDF, color, 13 more }

Inline letter configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

addressPlacement: optional AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

attachedPDF: optional AttachedPdf { file, placement }

Model representing an attached PDF.

file: string

The file (multipart form upload) or URL pointing to a PDF for the attached PDF.

formaturi

placement: "before_template" or "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

color: optional boolean

Whether to print in color.

description: optional string

An optional description.

doubleSided: optional boolean

Whether to print on both sides of the paper.

envelope: optional string

The custom envelope ID or "standard".

envelopeType: optional "standard_double_window" or "flat"

The type of envelope used for the letter.

One of the following:

"standard_double_window"

"flat"

mailingClass: optional "first_class" or "standard_class" or "express" or 23 more

Mailing class for the letter.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

mergeVariables: optional map[unknown]

Default merge variables for the letter.

metadata: optional map[string]

Optional key-value metadata.

paper: optional "standard" or "premium_paper_letter_standard_white_70lb" or "premium_paper_letter_standard_white_80lb" or string

Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.

One of the following:

LetterBuiltInPremiumPaperID = "standard" or "premium_paper_letter_standard_white_70lb" or "premium_paper_letter_standard_white_80lb"

Built-in paper IDs for letter products. Actual availability depends on your organization settings.

One of the following:

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

PremiumPaperID = string

Premium paper identifier.

standard is always accepted. Organizations may also have additional custom premium_paper_* IDs beyond the built-in values documented here.

perforatedPage: optional 1

Which page number should be perforated (if any).

returnEnvelope: optional string

ID of a return envelope to include.

size: optional LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

template: optional string

ID of a template for the letter content. Cannot be used with pdf.

uploadedPDF: optional string

A signed URL to the uploaded PDF, if any.

formaturi

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

postcard: optional object { backTemplate, description, frontTemplate, 6 more }

Inline postcard configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

backTemplate: optional string

ID of the template for the back side. Cannot be used with pdf.

description: optional string

An optional description.

frontTemplate: optional string

ID of the template for the front side. Cannot be used with pdf.

mailingClass: optional "first_class" or "standard_class" or "express" or 23 more

Mailing class for the postcard.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

mergeVariables: optional map[unknown]

Default merge variables for the postcard.

metadata: optional map[string]

Optional key-value metadata.

paper: optional "standard" or "premium_paper_heavy_1_glossy" or "premium_paper_postcard_uv_glossy_ss" or 2 more or string

Premium paper selection (“standard” or a premium paper ID). If omitted, org default is used when configured; otherwise “standard”.

One of the following:

PostcardBuiltInPremiumPaperID = "standard" or "premium_paper_heavy_1_glossy" or "premium_paper_postcard_uv_glossy_ss" or 2 more

Built-in paper IDs for postcard products. Actual availability depends on your organization settings.

One of the following:

"standard"

"premium_paper_heavy_1_glossy"

"premium_paper_postcard_uv_glossy_ss"

"premium_paper_postcard_uv_glossy_ss_120lb"

"premium_paper_postcard_satin_ds"

PremiumPaperID = string

Premium paper identifier.

standard is always accepted. Organizations may also have additional custom premium_paper_* IDs beyond the built-in values documented here.

size: optional "6x4" or "9x6" or "11x6"

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

uploadedPDF: optional string

A signed URL to the uploaded PDF, if any.

formaturi

reportURL: optional string

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

formaturi

selfMailer: optional object { description, insideTemplate, mailingClass, 5 more }

Inline self-mailer configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

description: optional string

An optional description.

insideTemplate: optional string

ID of the template for the inside. Cannot be used with pdf.

mailingClass: optional "first_class" or "standard_class" or "express" or 23 more

Mailing class for the self-mailer.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

mergeVariables: optional map[unknown]

Default merge variables for the self-mailer.

metadata: optional map[string]

Optional key-value metadata.

outsideTemplate: optional string

ID of the template for the outside. Cannot be used with pdf.

size: optional "8.5x11_bifold" or "8.5x11_trifold" or "9.5x16_trifold"

Enum representing the supported self-mailer sizes.

One of the following:

"8.5x11_bifold"

"8.5x11_trifold"

"9.5x16_trifold"

uploadedPDF: optional string

A signed URL to the uploaded PDF, if any.

formaturi

sendDate: optional string

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

formatdate-time

snapPack: optional object { description, insideTemplate, mailingClass, 5 more }

Inline snap pack configuration for a campaign. All fields are optional since campaigns may be in a partial state during drafting.

description: optional string

An optional description.

insideTemplate: optional string

ID of the template for the inside. Cannot be used with pdf.

mailingClass: optional "first_class" or "standard_class" or "express" or 23 more

Mailing class for the snap pack.

One of the following:

"first_class"

"standard_class"

"express"

"certified"

"certified_return_receipt"

"registered"

"usps_first_class"

"usps_standard_class"

"usps_eddm"

"usps_express_2_day"

"usps_express_3_day"

"usps_first_class_certified"

"usps_first_class_certified_return_receipt"

"usps_first_class_registered"

"usps_express_3_day_signature_confirmation"

"usps_express_3_day_certified"

"usps_express_3_day_certified_return_receipt"

"ca_post_lettermail"

"ca_post_personalized"

"ca_post_neighbourhood_mail"

"ups_express_overnight"

"ups_express_2_day"

"ups_express_3_day"

"royal_mail_first_class"

"royal_mail_second_class"

"au_post_second_class"

mergeVariables: optional map[unknown]

Default merge variables for the snap pack.

metadata: optional map[string]

Optional key-value metadata.

outsideTemplate: optional string

ID of the template for the outside. Cannot be used with pdf.

size: optional "8.5x11_bifold_v"

Enum representing the supported snap pack sizes.

uploadedPDF: optional string

A signed URL to the uploaded PDF, if any.

formaturi

CampaignDeleteResponse object { id, deleted }

id: string

A unique ID prefixed with campaign_

deleted: true