API Reference

Print Mail

Order Profiles

Self Mailers

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Create Self-Mailer Profile

POST/print-mail/v1/order_profiles/self_mailers

Creates a new Self-Mailer Profile. Provide either insideTemplate and outsideTemplate IDs, or upload a 2-page pdf. If providing a pdf, the request Content-Type must be multipart/form-data.

Query ParametersExpand Collapse

expand: optional array of string

Optional list of related resources to expand in the response.

Body ParametersJSONExpand Collapse

size: SelfMailerSize

Enum representing the supported self-mailer sizes.

One of the following:

"8.5x11_bifold"

"8.5x11_trifold"

"9.5x16_trifold"

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.

pdf: optional string

A 2-page PDF file containing the self-mailer content (inside and outside). Cannot be used with insideTemplate/outsideTemplate.

formaturi

ReturnsExpand 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

Create Self-Mailer Profile

HTTP

HTTP

TypeScript

Python

curl https://api.postgrid.com/print-mail/v1/order_profiles/self_mailers \
    -H 'Content-Type: application/json' \
    -H "X-API-Key: $POSTGRID_PRINT_MAIL_API_KEY" \
    -d '{
          "size": "8.5x11_bifold"
        }'

201 example

{
  "id": "self_mailer_profile_101",
  "object": "self_mailer_profile",
  "live": false,
  "description": "Marketing Self-Mailer",
  "size": "8.5x11_bifold",
  "insideTemplate": "template_123",
  "outsideTemplate": "template_456",
  "mailingClass": "standard_class",
  "createdAt": "2023-04-25T13:00:00Z",
  "updatedAt": "2023-04-25T13:00:00Z"
}

Returns Examples

201 example

{
  "id": "self_mailer_profile_101",
  "object": "self_mailer_profile",
  "live": false,
  "description": "Marketing Self-Mailer",
  "size": "8.5x11_bifold",
  "insideTemplate": "template_123",
  "outsideTemplate": "template_456",
  "mailingClass": "standard_class",
  "createdAt": "2023-04-25T13:00:00Z",
  "updatedAt": "2023-04-25T13:00:00Z"
}