Create Letter

post

https://api.postgrid.com/print-mail/v1/letters

Create a letter. Note that you can supply one of the following:

HTML content for the letter
A template ID for the letter
A URL or file for a PDF for the letter
Upload the aforementioned PDF file via a multipart form upload request

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The details of the letter to create.

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

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

string

enum

The mailing class of this order. If not provided, automatically set to first_class.

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.

perforatedPage

number

enum

If specified, indicates which letter page is perforated. Currently, only the first page can be perforated.

Allowed:

returnEnvelope

string

The return envelope (ID) sent out with the letter, if any.

attachedPDF

object

Model representing an attached PDF.

plasticCard

object

Model representing a plastic card.

doubleSided

boolean

Defaults to false

Indicates if the letter is double-sided.

color

boolean

Defaults to false

Indicates if the letter is in color.

from

required

The contact information of the sender. You can pass contact information inline here just like you can for the to.

size

string

enum

Defaults to us_letter

Enum representing the supported letter sizes.

Allowed:

addressPlacement

string

enum

Defaults to top_first_page

Enum representing the placement of the address on the letter.

Allowed:

envelope

string

Defaults to standard

The envelope (ID) for the letter. You can either specify a custom envelope ID or use the default standard envelope.

html

string

required

The HTML content for the letter. You can supply either this or template but not both.

Responses

201the created Letter.

400the created Letter.

401the created Letter.

404the created Letter.

422the created Letter.

429the created Letter.

500the created Letter.