Campaigns

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

Create Campaign

client.printMail.campaigns.create(, ?): Campaign { id, createdAt, createdCount, 16 more }

POST/print-mail/v1/campaigns

List Campaigns

client.printMail.campaigns.list(?, ?): SkipLimit<Campaign { id, createdAt, createdCount, 16 more } >

GET/print-mail/v1/campaigns

Get Campaign

client.printMail.campaigns.retrieve(, ?): Campaign { id, createdAt, createdCount, 16 more }

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

Update Campaign

client.printMail.campaigns.update(, , ?): Campaign { id, createdAt, createdCount, 16 more }

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

Delete Campaign

client.printMail.campaigns.delete(, ?): CampaignDeleteResponse { id, deleted }

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

Send Campaign

client.printMail.campaigns.send(, , ?): Campaign { id, createdAt, createdCount, 16 more }

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

ModelsExpand Collapse

Campaign { 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" | "changes_required" | "creating_orders" | 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?: Cheque { 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?: string

ID of the bank account to use for the cheque.

currencyCode?: "CAD" | "USD"

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

description?: string

An optional description.

envelope?: string

The custom envelope ID or "standard".

letterSettings?: LetterSettings { color }

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

color?: boolean

Whether to print the attached letter in color.

letterTemplate?: string

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

letterUploadedPDF?: string

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

formaturi

logo?: string

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

formaturi

mailingClass?: "first_class" | "standard_class" | "express" | 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?: string

Memo line text for the cheque.

mergeVariables?: Record<string, unknown>

Default merge variables for the cheque.

message?: string

Message included on the cheque stub.

metadata?: Record<string, string>

Optional key-value metadata.

returnEnvelope?: string

ID of a return envelope to include.

size?: ChequeSize

Enum representing the supported cheque sizes.

One of the following:

"us_letter"

"us_legal"

defaultSenderContact?: string

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

description?: string

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

errors?: Array<Error>

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" | "internal_error"

Type of error encountered during campaign processing.

One of the following:

"processing_error"

"internal_error"

letter?: Letter { 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?: AddressPlacement

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

attachedPDF?: AttachedPdf { file, placement }

Model representing an attached PDF.

file: string | Uploadable

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

One of the following:

string

Uploadable

placement: "before_template" | "after_template"

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

color?: boolean

Whether to print in color.

description?: string

An optional description.

doubleSided?: boolean

Whether to print on both sides of the paper.

envelope?: string

The custom envelope ID or "standard".

envelopeType?: "standard_double_window" | "flat"

The type of envelope used for the letter.

One of the following:

"standard_double_window"

"flat"

mailingClass?: "first_class" | "standard_class" | "express" | 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?: Record<string, unknown>

Default merge variables for the letter.

metadata?: Record<string, string>

Optional key-value metadata.

paper?: "standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb" | (string & {})

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

One of the following:

"standard" | "premium_paper_letter_standard_white_70lb" | "premium_paper_letter_standard_white_80lb"

"standard"

"premium_paper_letter_standard_white_70lb"

"premium_paper_letter_standard_white_80lb"

(string & {})

perforatedPage?: 1

Which page number should be perforated (if any).

returnEnvelope?: string

ID of a return envelope to include.

size?: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

template?: string

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

uploadedPDF?: string

A signed URL to the uploaded PDF, if any.

formaturi

metadata?: Record<string, unknown>

See the section on Metadata.

orderPreviewURL?: string

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

formaturi

postcard?: Postcard { 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?: string

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

description?: string

An optional description.

frontTemplate?: string

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

mailingClass?: "first_class" | "standard_class" | "express" | 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?: Record<string, unknown>

Default merge variables for the postcard.

metadata?: Record<string, string>

Optional key-value metadata.

paper?: "standard" | "premium_paper_heavy_1_glossy" | "premium_paper_postcard_uv_glossy_ss" | 2 more | (string & {})

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

One of the following:

"standard" | "premium_paper_heavy_1_glossy" | "premium_paper_postcard_uv_glossy_ss" | 2 more

"standard"

"premium_paper_heavy_1_glossy"

"premium_paper_postcard_uv_glossy_ss"

"premium_paper_postcard_uv_glossy_ss_120lb"

"premium_paper_postcard_satin_ds"

(string & {})

size?: "6x4" | "9x6" | "11x6"

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

uploadedPDF?: string

A signed URL to the uploaded PDF, if any.

formaturi

reportURL?: string

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

formaturi

selfMailer?: SelfMailer { 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?: string

An optional description.

insideTemplate?: string

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

mailingClass?: "first_class" | "standard_class" | "express" | 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?: Record<string, unknown>

Default merge variables for the self-mailer.

metadata?: Record<string, string>

Optional key-value metadata.

outsideTemplate?: string

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

size?: "8.5x11_bifold" | "8.5x11_trifold" | "9.5x16_trifold"

Enum representing the supported self-mailer sizes.

One of the following:

"8.5x11_bifold"

"8.5x11_trifold"

"9.5x16_trifold"

uploadedPDF?: string

A signed URL to the uploaded PDF, if any.

formaturi

sendDate?: string

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

formatdate-time

snapPack?: SnapPack { 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?: string

An optional description.

insideTemplate?: string

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

mailingClass?: "first_class" | "standard_class" | "express" | 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?: Record<string, unknown>

Default merge variables for the snap pack.

metadata?: Record<string, string>

Optional key-value metadata.

outsideTemplate?: string

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

size?: "8.5x11_bifold_v"

Enum representing the supported snap pack sizes.

uploadedPDF?: string

A signed URL to the uploaded PDF, if any.

formaturi

CampaignDeleteResponse { id, deleted }

id: string

A unique ID prefixed with campaign_

deleted: true