Campaigns

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

Create Campaign

print_mail.campaigns.create() -> Campaign

POST/print-mail/v1/campaigns

List Campaigns

print_mail.campaigns.list() -> SyncSkipLimit[Campaign]

GET/print-mail/v1/campaigns

Get Campaign

print_mail.campaigns.retrieve() -> Campaign

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

Update Campaign

print_mail.campaigns.update(, ) -> Campaign

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

Delete Campaign

print_mail.campaigns.delete() -> CampaignDeleteResponse

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

Send Campaign

print_mail.campaigns.send(, ) -> Campaign

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

ModelsExpand Collapse

class Campaign: …

Represents a bulk mail campaign.

id: str

A unique ID prefixed with campaign_

created_at: datetime

The UTC time at which this resource was created.

formatdate-time

created_count: int

The number of orders successfully created for this campaign.

formatint32

live: bool

true if this is a live mode resource else false.

mailing_list: str

The ID of the mailing list associated with this campaign.

status: Literal["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"

updated_at: datetime

The UTC time at which this resource was last updated.

formatdate-time

cheque: Optional[Cheque]

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

bank_account: Optional[str]

ID of the bank account to use for the cheque.

currency_code: Optional[Literal["CAD", "USD"]]

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

description: Optional[str]

An optional description.

envelope: Optional[str]

The custom envelope ID or "standard".

letter_settings: Optional[ChequeLetterSettings]

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

color: Optional[bool]

Whether to print the attached letter in color.

letter_template: Optional[str]

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

letter_uploaded_pdf: Optional[str]

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

formaturi

logo: Optional[str]

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

formaturi

mailing_class: Optional[Literal["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: Optional[str]

Memo line text for the cheque.

merge_variables: Optional[Dict[str, object]]

Default merge variables for the cheque.

message: Optional[str]

Message included on the cheque stub.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

return_envelope: Optional[str]

ID of a return envelope to include.

size: Optional[ChequeSize]

Enum representing the supported cheque sizes.

One of the following:

"us_letter"

"us_legal"

default_sender_contact: Optional[str]

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

description: Optional[str]

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

errors: Optional[List[Error]]

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

message: str

A human-readable message describing the error.

type: Literal["processing_error", "internal_error"]

Type of error encountered during campaign processing.

One of the following:

"processing_error"

"internal_error"

letter: Optional[Letter]

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

address_placement: Optional[AddressPlacement]

Enum representing the placement of the address on the letter.

One of the following:

"top_first_page"

"insert_blank_page"

attached_pdf: Optional[AttachedPdf]

Model representing an attached PDF.

file: str

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

formaturi

placement: Literal["before_template", "after_template"]

Enum representing the placement of the attached PDF.

One of the following:

"before_template"

"after_template"

color: Optional[bool]

Whether to print in color.

description: Optional[str]

An optional description.

double_sided: Optional[bool]

Whether to print on both sides of the paper.

envelope: Optional[str]

The custom envelope ID or "standard".

envelope_type: Optional[Literal["standard_double_window", "flat"]]

The type of envelope used for the letter.

One of the following:

"standard_double_window"

"flat"

mailing_class: Optional[Literal["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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for the letter.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

paper: Optional[Union[Literal["standard", "premium_paper_letter_standard_white_70lb", "premium_paper_letter_standard_white_80lb"], str, null]]

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

One of the following:

Literal["standard", "premium_paper_letter_standard_white_70lb", "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"

str

Premium paper identifier.

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

perforated_page: Optional[Literal[1]]

Which page number should be perforated (if any).

return_envelope: Optional[str]

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[str]

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

uploaded_pdf: Optional[str]

A signed URL to the uploaded PDF, if any.

formaturi

metadata: Optional[Dict[str, object]]

See the section on Metadata.

order_preview_url: Optional[str]

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

formaturi

postcard: Optional[Postcard]

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

back_template: Optional[str]

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

description: Optional[str]

An optional description.

front_template: Optional[str]

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

mailing_class: Optional[Literal["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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for the postcard.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

paper: Optional[Union[Literal["standard", "premium_paper_heavy_1_glossy", "premium_paper_postcard_uv_glossy_ss", 2 more], str, null]]

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

One of the following:

Literal["standard", "premium_paper_heavy_1_glossy", "premium_paper_postcard_uv_glossy_ss", 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"

str

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[Literal["6x4", "9x6", "11x6"]]

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

uploaded_pdf: Optional[str]

A signed URL to the uploaded PDF, if any.

formaturi

report_url: Optional[str]

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

formaturi

self_mailer: Optional[SelfMailer]

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

description: Optional[str]

An optional description.

inside_template: Optional[str]

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

mailing_class: Optional[Literal["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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for the self-mailer.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

outside_template: Optional[str]

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

size: Optional[Literal["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"

uploaded_pdf: Optional[str]

A signed URL to the uploaded PDF, if any.

formaturi

send_date: Optional[datetime]

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

formatdate-time

snap_pack: Optional[SnapPack]

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

description: Optional[str]

An optional description.

inside_template: Optional[str]

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

mailing_class: Optional[Literal["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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for the snap pack.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

outside_template: Optional[str]

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

size: Optional[Literal["8.5x11_bifold_v"]]

Enum representing the supported snap pack sizes.

uploaded_pdf: Optional[str]

A signed URL to the uploaded PDF, if any.

formaturi

class CampaignDeleteResponse: …

id: str

A unique ID prefixed with campaign_

deleted: Literal[true]