Letters

Create and manage letter orders.

Letter Response

Name	Type	Description
id	string	A unique ID prefixed with letter_
object	string	Always letter
status	string	See Tracking
imbStatus	string or null	See Intelligent-Mail Tracking
live	boolean	true if this is a live mode letter else false
description	string or null	Optional line describing this letter
sendDate	Date	Date when the letter will be sent
to	Contact	The recipient of this letter
from	Contact	The sender of this letter
html	string or null	The raw html provided for this letter, if any
template	string or null	A Template ID, if any
uploadedPDF	string or null	A signed link to the original PDF uploaded for this letter, if any
addressPlacement	string	One of top_first_page or insert_blank_page
color	boolean	Whether the letter will be printed in color
doubleSided	boolean	Whether the letter will be printed double-sided
envelopeType	string	One of standard_double_window or flat
url	string or null	Signed link to a preview of this letter order
pageCount	number or null	Number of pages produced for this letter
mailingClass	first_class or standard_class	Defaults to first_class. See mailing class
mergeVariables	object or null	See merge variables
metadata	object or null	See metadata