---
title: "Create Self Mailer"
method: POST
path: "/print-mail/v1/self_mailers"
tags: ["Self Mailers"]
---

# Create Self Mailer

`POST /print-mail/v1/self_mailers`

Create a self-mailer. Note that you can supply one of the following:
- HTML content for the inside and outside of the self-mailer
- A template ID for the inside and outside of the self-mailer
- A URL or file for a 2 page PDF where the first page is the outside of the self-mailer and the second page is the inside
- Upload the aforementioned PDF file via a multipart form upload request

## Request body

- union
  - SelfMailerCreateWithHTML
    - `mergeVariables` object — These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order.
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `sendDate` string, date-time — This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date.
    - `mailingClass` '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'
    - `to` union, required — The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `size` '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold', required — Enum representing the supported self-mailer sizes.
    - `from` union, required — The contact information of the sender. You can pass contact information inline here just like you can for the `to`.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `insideHTML` string, required — The HTML content for the inside of the self-mailer. You can supply _either_ this or `insideTemplate` but not both.
    - `outsideHTML` string, required — The HTML content for the outside of the self-mailer. You can supply _either_ this or `outsideTemplate` but not both.
  - SelfMailerCreateWithTemplate
    - `mergeVariables` object — These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order.
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `sendDate` string, date-time — This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date.
    - `mailingClass` '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'
    - `to` union, required — The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `size` '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold', required — Enum representing the supported self-mailer sizes.
    - `from` union, required — The contact information of the sender. You can pass contact information inline here just like you can for the `to`.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `insideTemplate` string, required — The template ID for the inside of the self-mailer. You can supply _either_ this or `insideHTML` but not both.
    - `outsideTemplate` string, required — The template ID for the outside of the self-mailer. You can supply _either_ this or `outsideHTML` but not both.
  - SelfMailerCreateWithPDFURL
    - `mergeVariables` object — These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order.
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `sendDate` string, date-time — This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date.
    - `mailingClass` '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'
    - `to` union, required — The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `size` '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold', required — Enum representing the supported self-mailer sizes.
    - `from` union, required — The contact information of the sender. You can pass contact information inline here just like you can for the `to`.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `pdf` string, uri, required — A URL pointing to a 2 page PDF file. The first page is the inside of the self-mailer and the second page is the outside (where the address will be stamped on).
  - SelfMailerCreateWithPDFFile
    - `mergeVariables` object — These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order.
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `sendDate` string, date-time — This order will transition from `ready` to `printing` on the day after this date. You can use this parameter to schedule orders for a future date.
    - `mailingClass` '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'
    - `to` union, required — The recipient of this order. You can either supply the contact information inline here or provide a contact ID. PostGrid will automatically deduplicate contacts regardless of whether you provide the information inline here or call the contact creation endpoint.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `size` '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold', required — Enum representing the supported self-mailer sizes.
    - `from` union, required — The contact information of the sender. You can pass contact information inline here just like you can for the `to`.
      - union
        - ContactCreateWithFirstName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `companyName` string — Company name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `firstName` string, required
        - ContactCreateWithCompanyName
          - `addressLine1` string, required — The first line of the contact's address.
          - `addressLine2` string — Second line of the contact's address, if applicable.
          - `city` string — The city of the contact's address.
          - `provinceOrState` string — Province or state of the contact's address.
          - `postalOrZip` string — The postal or ZIP code of the contact's address.
          - `countryCode` string, required — The ISO 3611-1 country code of the contact's address.
          - `firstName` string — First name of the contact.
          - `lastName` string — Last name of the contact.
          - `email` string — Email of the contact.
          - `phoneNumber` string — Phone number of the contact.
          - `jobTitle` string — Job title of the contact.
          - `skipVerification` boolean — If `true`, PostGrid will skip running this contact's address through our address verification system.
          - `forceVerifiedStatus` boolean — If `true`, PostGrid will force this contact to have an `addressStatus` of `verified` even if our address verification system says otherwise.
          - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
          - `metadata` object — See the section on Metadata.
          - `companyName` string, required
      - string
    - `pdf` string, byte, required — A 2 page PDF file. The first page is the inside of the self-mailer and the second page is the outside (where the address will be stamped on).

## Response `201`

the created SelfMailer.

- SelfMailer
  - `status` 'ready' | 'printing' | 'processed_for_delivery' | 'completed' | 'cancelled', required
  - `mergeVariables` object — These will be merged with the variables in the template or HTML you create this order with. The keys in this object should match the variable names in the template _exactly_ as they are case-sensitive. Note that these _do not_ apply to PDFs uploaded with the order.
  - `trackingNumber` string — The tracking number of this order. Populated after an express/certified order has been processed for delivery.
  - `imbStatus` 'entered_mail_stream' | 'out_for_delivery' | 'returned_to_sender'
  - `imbZIPCode` string — The most recent ZIP code of the USPS facility that the order has been processed through. Only populated when an `imbStatus` is present.
  - `imbDate` string, date-time — The last date that the IMB status was updated. See `imbStatus` for more details.
  - `cancellation` Cancellation
    - `reason` 'user_initiated' | 'invalid_content' | 'invalid_order_mailing_class', required
    - `cancelledByUser` string — The user ID who cancelled the order.
    - `note` string — An optional note provided by the user who cancelled the order.
  - `url` string, uri — PostGrid renders a PDF preview for all orders. This should be inspected to ensure that the order is correct before it is sent out because it shows what will be printed and mailed to the recipient. Once the PDF preview is generated, this field will be returned by all `GET` endpoints which produce this order. This URL is a signed link to the PDF preview. It will expire after a short period of time. If you need to access this URL after it has expired, you can regenerate it by calling the `GET` endpoint again.
  - `id` string, required — A unique ID prefixed with self_mailer_
  - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
  - `metadata` object — See the section on Metadata.
  - `live` boolean, required — `true` if this is a live mode resource else `false`.
  - `createdAt` string, date-time, required — The UTC time at which this resource was created.
  - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
  - `sendDate` string, date-time, required — This order will transition from `ready` to `printing` on the day after this date. For example, if this is a date on Tuesday, the order will transition to `printing` on Wednesday at midnight eastern time.
  - `mailingClass` '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', required
  - `to` Contact, required
    - `id` string, required — A unique ID prefixed with contact_
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `live` boolean, required — `true` if this is a live mode resource else `false`.
    - `createdAt` string, date-time, required — The UTC time at which this resource was created.
    - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.
  - `object` 'self_mailer', required — Always `self_mailer`.
  - `size` '8.5x11_bifold' | '8.5x11_trifold' | '9.5x16_trifold', required — Enum representing the supported self-mailer sizes.
  - `from` Contact, required
    - `id` string, required — A unique ID prefixed with contact_
    - `description` string — An optional string describing this resource. Will be visible in the API and the dashboard.
    - `metadata` object — See the section on Metadata.
    - `live` boolean, required — `true` if this is a live mode resource else `false`.
    - `createdAt` string, date-time, required — The UTC time at which this resource was created.
    - `updatedAt` string, date-time, required — The UTC time at which this resource was last updated.

## Other responses

- `400` — the created SelfMailer.
- `401` — the created SelfMailer.
- `404` — the created SelfMailer.
- `422` — the created SelfMailer.
- `429` — the created SelfMailer.
- `500` — the created SelfMailer.

---

[API](https://skmtc.net/postgrid/apis/postgrid-print-mail-api.md) · [All operations](https://skmtc.net/postgrid/apis/postgrid-print-mail-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/postgrid/postgrid-print-mail-api/revisions/6bb9d268c5d1/schema)
