Create Letter

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

Create a letter order using either of HTML, PDF, or a letter template.

Body Params

string

required

Defaults to contact_pxd7wnnD1xY6H6etKNvjb4

The id or contact object of the receiver. You can either pass a contact object or a contact's id.

from

string

required

Defaults to contact_pxd7wnnD1xY6H6etKNvjb4

The id or contact object of the sender. You can either pass a contact object or a contact's id.

html

string

required

Defaults to <b>Hello</b>, {{to.firstName}}!

The HTML content of the letter. This field can be replaced by template which takes the id of a template to be used for the letter. This field can be replaced by pdf which takes an uploaded PDF or a publicly accessible link to PDF.

addressPlacement

string

Defaults to top_first_page

The location where the address will be placed. Must be either top_first_page or insert_blank_page.

doubleSided

boolean

Defaults to true

Indicates if the letter is double sided or not.

color

string

Defaults to false

Indicates whether the letter will be printed in color or not.

perforatedPage

string

Defaults to 1

Indicates if the page is to be perforated (holes). 1 denotes true.

extraService

string

Defaults to certified

Indicates extra services for the letter.

envelopeType

string

Defaults to flat

Indicates the envelope type for the letter. Must be either standard_double_window or flat.

returnEnvelope

string

Defaults to return_envelope_97Tcv1LxhWWLPUvn58CuVJ

The id of the return envelope to be used.

sendDate

date

Defaults to 2023-02-16T15:40:35.873Z

The desired date for the letter to be sent out.

description

string

Defaults to My HTML letter

A description for the letter.

express

string

Defaults to false

Express shipping

mergeVariables

object

metadata

object

mailingClass

string

Defaults to first_class

Headers

Content-Type

string

Defaults to application/json

Response

Language

Credentials

Header

Request


xxxxxxxxxx
1
letter = postgrid.Letter.create(
2
  description='Cool new letter', 
3
  pdf='https://www.icnaam.org/documents/8x11singlesample.pdf'
4
  to='contact_aTC5hxsH81LfQTkegDgZ52', 
5
  from_='contact_aTC5hxsH81LfQTkegDgZ52', 
6
)

Click Try It! to start a request and see the response here! Or choose an example:

application/json

201201