Print and Mail FAQAddress Verification FAQ
API Reference

Create Postcard

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

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

  • HTML content for the front and back of the postcard
  • A template ID for the front and back of the postcard
  • A URL or file for a 2 page PDF where the first page is the front of the postcard and the second page is the back
  • Upload the aforementioned PDF file via a multipart form upload request
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The details of the postcard 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.

string

An optional string describing this resource. Will be visible in the API and the dashboard.

metadata
object

See the section on Metadata.

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.

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.

string
enum
required

Enum representing the supported postcard sizes.

Allowed:
string
Defaults to standard

Premium paper identifier. Use "standard" for regular stock or a premium_paper_* ID.

The contact information of the sender. You can pass contact information inline here just like you can for the to. Unlike other order types, the sender address is optional for postcards.

string
required

The HTML content for the front of the postcard. You can supply either this or frontTemplate but not both.

string
required

The HTML content for the back of the postcard. You can supply either this or backTemplate but not both.

Responses

Updated about 1 month ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated about 1 month ago