Create and manage postcard mailings.
Postcard Response
Name | Type | Description |
---|---|---|
id | string | A unique ID prefixed with postcard_ |
object | string | Always postcard |
status | string | See Tracking |
imbStatus | string or null | See Intelligent-Mail Tracking |
live | boolean | true if this is a live mode postcard else false |
description | string or null | Optional line describing this letter |
sendDate | Date | Date when the postcard will be printed |
size | string | One of 6x4 , 9x6 , 11x6 |
to | Contact | The recipient of this postcard |
from | Contact or null | Optional sender of this postcard |
frontHTML | string or null | The raw html provided for the front of this postcard, if any |
backHTML | string or null | The raw html provided for the back of this postcard, if any |
frontTemplate | string or null | A Template ID for the front, if any |
backTemplate | string or null | A Template ID for the back, if any |
uploadedPDF | string or null | A signed URL to the PDF that was uploaded for this postcard, if any |
url | string or null | Signed link to a preview of this letter order |
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 |