Postcards

Create and manage postcard mailings.

Postcard Response

NameTypeDescription
idstringA unique ID prefixed with postcard_
objectstringAlways postcard
statusstringSee Tracking
imbStatusstring or nullSee Intelligent-Mail Tracking
livebooleantrue if this is a live mode postcard else false
descriptionstring or nullOptional line describing this letter
sendDateDateDate when the postcard will be printed
sizestringOne of 6x4, 9x6, 11x6
toContactThe recipient of this postcard
fromContact or nullOptional sender of this postcard
frontHTMLstring or nullThe raw html provided for the front of this postcard, if any
backHTMLstring or nullThe raw html provided for the back of this postcard, if any
frontTemplatestring or nullA Template ID for the front, if any
backTemplatestring or nullA Template ID for the back, if any
uploadedPDFstring or nullA signed URL to the PDF that was uploaded for this postcard, if any
urlstring or nullSigned link to a preview of this letter order
mailingClassfirst_class or standard_classDefaults to first_class. See mailing class
mergeVariablesobject or nullSee merge variables
metadataobject or nullSee metadata