API Reference

Print Mail

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Order Profiles

Order ProfilesCheques

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Cheque Profile

POST/print-mail/v1/order_profiles/cheques

List Cheque Profiles

GET/print-mail/v1/order_profiles/cheques

Retrieve Cheque Profile

GET/print-mail/v1/order_profiles/cheques/{id}

Update Cheque Profile

POST/print-mail/v1/order_profiles/cheques/{id}

Delete Cheque Profile

DELETE/print-mail/v1/order_profiles/cheques/{id}

ModelsExpand Collapse

ChequeProfile = object { id, bankAccount, createdAt, 14 more }

id: string

Unique identifier for the order profile.

bankAccount: string

ID of the bank account to use for the cheque. Required for creation.

createdAt: string

Timestamp when the profile was created.

formatdate-time

currencyCode: CurrencyCode

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

live: boolean

Indicates if the profile is associated with the live or test environment.

object: "cheque_profile"

Always cheque_profile.

size: ChequeSize

Enum representing the supported cheque sizes.

One of the following:

"us_letter"

"us_legal"

updatedAt: string

Timestamp when the profile was last updated.

formatdate-time

description: optional string

An optional description for the profile. Set to null to remove during update.

letterTemplate: optional string

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

letterUploadedPDF: optional string

A temporary, signed URL to view the attached letter PDF, if any. Output only.

formaturi

logo: optional string

A publicly accessible URL for the logo to print on the cheque. Set to null to remove during update.

formaturi

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

Mailing class. Generally must be first class (or equivalent for destination country) for cheques.

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. Set to null to remove during update.

mergeVariables: optional map[unknown]

Default merge variables for orders created using this profile.

message: optional string

Message included on the cheque stub. Set to null to remove during update.

metadata: optional map[string]

Optional key-value metadata.

CurrencyCode = "CAD" or "USD"

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

Order ProfilesLetters

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Letter Profile

POST/print-mail/v1/order_profiles/letters

List Letter Profiles

GET/print-mail/v1/order_profiles/letters

Retrieve Letter Profile

GET/print-mail/v1/order_profiles/letters/{id}

Update Letter Profile

POST/print-mail/v1/order_profiles/letters/{id}

Delete Letter Profile

DELETE/print-mail/v1/order_profiles/letters/{id}

ModelsExpand Collapse

LetterProfile = object { id, createdAt, live, 15 more }

id: string

Unique identifier for the order profile.

createdAt: string

Timestamp when the profile was created.

formatdate-time

live: boolean

Indicates if the profile is associated with the live or test environment.

object: "letter_profile"

Always letter_profile.

size: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

updatedAt: string

Timestamp when the profile was last updated.

formatdate-time

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

Specifies whether to print in color (true) or black and white (false).

description: optional string

An optional description for the profile. Set to null to remove during update.

doubleSided: optional boolean

Specifies whether to print on both sides of the paper.

envelope: optional string

ID of a custom envelope to use.

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

Mailing class.

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 orders created using this profile.

metadata: optional map[string]

Optional key-value metadata.

perforatedPage: optional 1

Specifies which page number should be perforated (if any).

template: optional string

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

uploadedPDF: optional string

A temporary, signed URL to view the uploaded PDF, if any.

formaturi

Order ProfilesPostcards

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Postcard Profile

POST/print-mail/v1/order_profiles/postcards

List Postcard Profiles

GET/print-mail/v1/order_profiles/postcards

Retrieve Postcard Profile

GET/print-mail/v1/order_profiles/postcards/{id}

Update Postcard Profile

POST/print-mail/v1/order_profiles/postcards/{id}

Delete Postcard Profile

DELETE/print-mail/v1/order_profiles/postcards/{id}

ModelsExpand Collapse

PostcardProfile = object { id, createdAt, live, 10 more }

id: string

Unique identifier for the order profile.

createdAt: string

Timestamp when the profile was created.

formatdate-time

live: boolean

Indicates if the profile is associated with the live or test environment.

object: "postcard_profile"

Always postcard_profile.

size: PostcardSize

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

updatedAt: string

Timestamp when the profile was last updated.

formatdate-time

backTemplate: optional string

ID of the template for the back side. Required unless pdf is provided.

description: optional string

An optional description for the profile. Set to null to remove during update.

frontTemplate: optional string

ID of the template for the front side. Required unless pdf is provided.

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

Mailing class (cannot include extra services like certified or registered for postcards, though).

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 orders created using this profile.

metadata: optional map[string]

Optional key-value metadata.

uploadedPDF: optional string

A temporary, signed URL to view the uploaded PDF content, if any.

formaturi

PostcardSize = "6x4" or "9x6" or "11x6"

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

Order ProfilesSelf Mailers

Order Profiles are reusable blueprints for creating print and mail orders (Letters, Postcards, Cheques, Self-Mailers). They define common properties like size, content (via templates or uploaded PDFs), mailing class, and metadata. Using profiles simplifies order creation, especially for recurring mailings or campaigns, by pre-filling many parameters.

Profiles are environment-specific (live vs. test).

Create Self-Mailer Profile

POST/print-mail/v1/order_profiles/self_mailers

List Self-Mailer Profiles

GET/print-mail/v1/order_profiles/self_mailers

Retrieve Self-Mailer Profile

GET/print-mail/v1/order_profiles/self_mailers/{id}

Update Self-Mailer Profile

POST/print-mail/v1/order_profiles/self_mailers/{id}

Delete Self-Mailer Profile

DELETE/print-mail/v1/order_profiles/self_mailers/{id}

ModelsExpand Collapse

SelfMailerProfile = object { id, createdAt, live, 10 more }

Represents a Self-Mailer Profile resource.

id: string

Unique identifier for the order profile.

createdAt: string

Timestamp when the profile was created.

formatdate-time

live: boolean

Indicates if the profile is associated with the live or test environment.

object: "self_mailer_profile"

Always self_mailer_profile.

size: SelfMailerSize

Enum representing the supported self-mailer sizes.

One of the following:

"8.5x11_bifold"

"8.5x11_trifold"

"9.5x16_trifold"

updatedAt: string

Timestamp when the profile was last updated.

formatdate-time

description: optional string

An optional description for the profile. Set to null to remove during update.

insideTemplate: optional string

ID of the template for the inside. Required unless pdf is provided.

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

Mailing class (cannot include extra services for self-mailers).

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 orders created using this profile.

metadata: optional map[string]

Optional key-value metadata.

outsideTemplate: optional string

ID of the template for the outside. Required unless pdf is provided.

uploadedPDF: optional string

A temporary, signed URL to view the uploaded PDF, if any.

formaturi

SelfMailerSize = "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"