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

print_mail.order_profiles.cheques.create(ChequeCreateParams**kwargs) -> ChequeProfile

POST/print-mail/v1/order_profiles/cheques

List Cheque Profiles

print_mail.order_profiles.cheques.list(ChequeListParams**kwargs) -> SyncSkipLimit[ChequeListResponse]

GET/print-mail/v1/order_profiles/cheques

Retrieve Cheque Profile

print_mail.order_profiles.cheques.retrieve(strid, ChequeRetrieveParams**kwargs) -> ChequeProfile

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

Update Cheque Profile

print_mail.order_profiles.cheques.update(strid, ChequeUpdateParams**kwargs) -> ChequeProfile

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

Delete Cheque Profile

print_mail.order_profiles.cheques.delete(strid) -> ChequeDeleteResponse

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

ModelsExpand Collapse

class ChequeProfile: …

id: str

Unique identifier for the order profile.

bank_account: str

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

created_at: datetime

Timestamp when the profile was created.

formatdate-time

currency_code: CurrencyCode

Enum representing the supported currency codes.

One of the following:

"CAD"

"USD"

live: bool

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

object: Literal["cheque_profile"]

Always cheque_profile.

size: ChequeSize

Enum representing the supported cheque sizes.

One of the following:

"us_letter"

"us_legal"

updated_at: datetime

Timestamp when the profile was last updated.

formatdate-time

description: Optional[str]

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

letter_template: Optional[str]

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

letter_uploaded_pdf: Optional[str]

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

formaturi

logo: Optional[str]

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

formaturi

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

Memo line text for the cheque. Set to null to remove during update.

merge_variables: Optional[Dict[str, object]]

Default merge variables for orders created using this profile.

message: Optional[str]

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

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

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

print_mail.order_profiles.letters.create(LetterCreateParams**kwargs) -> LetterProfile

POST/print-mail/v1/order_profiles/letters

List Letter Profiles

print_mail.order_profiles.letters.list(LetterListParams**kwargs) -> SyncSkipLimit[LetterProfile]

GET/print-mail/v1/order_profiles/letters

Retrieve Letter Profile

print_mail.order_profiles.letters.retrieve(strid, LetterRetrieveParams**kwargs) -> LetterProfile

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

Update Letter Profile

print_mail.order_profiles.letters.update(strid, LetterUpdateParams**kwargs) -> LetterProfile

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

Delete Letter Profile

print_mail.order_profiles.letters.delete(strid) -> LetterDeleteResponse

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

ModelsExpand Collapse

class LetterProfile: …

id: str

Unique identifier for the order profile.

created_at: datetime

Timestamp when the profile was created.

formatdate-time

live: bool

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

object: Literal["letter_profile"]

Always letter_profile.

size: LetterSize

Enum representing the supported letter sizes.

One of the following:

"us_letter"

"a4"

updated_at: datetime

Timestamp when the profile was last updated.

formatdate-time

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]

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

description: Optional[str]

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

double_sided: Optional[bool]

Specifies whether to print on both sides of the paper.

envelope: Optional[str]

ID of a custom envelope to use.

mailing_class: Optional[Literal["first_class", "standard_class", "express", 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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for orders created using this profile.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

perforated_page: Optional[Literal[1]]

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

template: Optional[str]

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

uploaded_pdf: Optional[str]

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

print_mail.order_profiles.postcards.create(PostcardCreateParams**kwargs) -> PostcardProfile

POST/print-mail/v1/order_profiles/postcards

List Postcard Profiles

print_mail.order_profiles.postcards.list(PostcardListParams**kwargs) -> SyncSkipLimit[PostcardProfile]

GET/print-mail/v1/order_profiles/postcards

Retrieve Postcard Profile

print_mail.order_profiles.postcards.retrieve(strid, PostcardRetrieveParams**kwargs) -> PostcardProfile

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

Update Postcard Profile

print_mail.order_profiles.postcards.update(strid, PostcardUpdateParams**kwargs) -> PostcardProfile

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

Delete Postcard Profile

print_mail.order_profiles.postcards.delete(strid) -> PostcardDeleteResponse

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

ModelsExpand Collapse

class PostcardProfile: …

id: str

Unique identifier for the order profile.

created_at: datetime

Timestamp when the profile was created.

formatdate-time

live: bool

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

object: Literal["postcard_profile"]

Always postcard_profile.

size: PostcardSize

Enum representing the supported postcard sizes.

One of the following:

"6x4"

"9x6"

"11x6"

updated_at: datetime

Timestamp when the profile was last updated.

formatdate-time

back_template: Optional[str]

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

description: Optional[str]

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

front_template: Optional[str]

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

mailing_class: Optional[Literal["first_class", "standard_class", "express", 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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for orders created using this profile.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

uploaded_pdf: Optional[str]

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

formaturi

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

print_mail.order_profiles.self_mailers.create(SelfMailerCreateParams**kwargs) -> SelfMailerProfile

POST/print-mail/v1/order_profiles/self_mailers

List Self-Mailer Profiles

print_mail.order_profiles.self_mailers.list(SelfMailerListParams**kwargs) -> SyncSkipLimit[SelfMailerProfile]

GET/print-mail/v1/order_profiles/self_mailers

Retrieve Self-Mailer Profile

print_mail.order_profiles.self_mailers.retrieve(strid, SelfMailerRetrieveParams**kwargs) -> SelfMailerProfile

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

Update Self-Mailer Profile

print_mail.order_profiles.self_mailers.update(strid, SelfMailerUpdateParams**kwargs) -> SelfMailerProfile

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

Delete Self-Mailer Profile

print_mail.order_profiles.self_mailers.delete(strid) -> SelfMailerDeleteResponse

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

ModelsExpand Collapse

class SelfMailerProfile: …

Represents a Self-Mailer Profile resource.

id: str

Unique identifier for the order profile.

created_at: datetime

Timestamp when the profile was created.

formatdate-time

live: bool

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

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

updated_at: datetime

Timestamp when the profile was last updated.

formatdate-time

description: Optional[str]

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

inside_template: Optional[str]

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

mailing_class: Optional[Literal["first_class", "standard_class", "express", 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"

merge_variables: Optional[Dict[str, object]]

Default merge variables for orders created using this profile.

metadata: Optional[Dict[str, str]]

Optional key-value metadata.

outside_template: Optional[str]

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

uploaded_pdf: Optional[str]

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

formaturi

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"