Postcards

Create Postcard Create Postcard

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 for a 2 page PDF where the first page is the front of the postcard and the second page is the back Create a postcard via a multipart/form-data request. Accepts the same fields as the JSON create body (nested objects are bracket-encoded form fields, e.g. to[firstName]); use this content type to upload the PDF file directly.

post/print-mail/v1/postcards

Headers

idempotency-keystring

Request body

Response

the created Postcard.

Changes

Changed in 4 of the 7 revisions of this API.181841

Jun 12, 2026537d2bbc624a13114See the full diff
- ▲
  added BinaryFile to the anyOf[PostcardCreateWithPDFFile]/pdf request property allOf list
  request-property-all-of-added
- ▲
  the anyOf[PostcardCreateWithPDFFile]/pdf request property type/format changed from string/byte to /
  request-property-type-changed
- ▲
  the response's body type/format changed from object/ to / for status 201
  response-body-type-changed
- ▲
  removed the required property createdAt from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property id from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property live from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property mailingClass from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property object from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property sendDate from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property size from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property status from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property to from the response with the 201 status
  response-required-property-removed
- ▲
  removed the required property updatedAt from the response with the 201 status
  response-required-property-removed
- ●
  removed the optional property cancellation from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property description from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property from from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property imbDate from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property imbStatus from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property imbZIPCode from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property mergeVariables from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property metadata from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property paper from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property trackingNumber from the response with the 201 status
  response-optional-property-removed
- ●
  removed the optional property url from the response with the 201 status
  response-optional-property-removed
- ○
  api operation id Postcards_create removed and replaced with Postcards_createJSON_Postcards_createMultipart
  api-operation-id-removed
- ○
  added the new optional header request parameter idempotency-key
  new-optional-request-parameter
- ○
  added the media type multipart/form-data to the request body
  request-body-media-type-added
- ○
  added Postcard Postcard to the response body anyOf list for the response status 201
  response-body-any-of-added
Jun 12, 202654cf11f8a76f18See the full diff
- ○
  added the new optional request property anyOf[PostcardCreateWithHTML]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithHTML]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithHTML]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithHTML]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFFile]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFFile]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFFile]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFFile]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFURL]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFURL]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFURL]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFURL]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret
  new-optional-request-property
- ○
  added the optional property from/allOf[Contact]/secret to the response with the 201 status
  response-optional-property-added
- ○
  added the optional property to/allOf[Contact]/secret to the response with the 201 status
  response-optional-property-added
May 21, 2026afd5935c2b2c5313See the full diff
- ▲
  added the new required request property anyOf[PostcardCreateWithTemplate]/size
  new-required-request-property
- ▲
  added the new required request property anyOf[PostcardCreateWithTemplate]/to
  new-required-request-property
- ▲
  added PostcardPremiumPaperID to the anyOf[PostcardCreateWithHTML]/paper request property allOf list
  request-property-all-of-added
- ▲
  added PostcardPremiumPaperID to the anyOf[PostcardCreateWithPDFFile]/paper request property allOf list
  request-property-all-of-added
- ▲
  added PostcardPremiumPaperID to the anyOf[PostcardCreateWithPDFURL]/paper request property allOf list
  request-property-all-of-added
- ●
  removed PremiumPaperID from the anyOf[PostcardCreateWithHTML]/paper request property allOf list
  request-property-all-of-removed
- ●
  removed PremiumPaperID from the anyOf[PostcardCreateWithPDFFile]/paper request property allOf list
  request-property-all-of-removed
- ●
  removed PremiumPaperID from the anyOf[PostcardCreateWithPDFURL]/paper request property allOf list
  request-property-all-of-removed
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/description
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/from
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/mailingClass
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/mergeVariables
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/metadata
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/paper
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithTemplate]/sendDate
  new-optional-request-property
- ○
  the paper request property default value standard was removed
  request-property-default-value-removed
- ○
  the paper request property default value standard was removed
  request-property-default-value-removed
- ○
  the paper request property default value standard was removed
  request-property-default-value-removed
- ○
  added PostcardPremiumPaperID to the paper response property allOf list for the response status 201
  response-property-all-of-added
- ○
  removed PremiumPaperID from the paper response property allOf list for the response status 201
  response-property-all-of-removed
- ○
  the paper response's property default value standard was removed for the status 201
  response-property-default-value-removed
May 1, 2026c8fedcbd705e46See the full diff
- ●
  added the new internal_server_error enum value to the error/type response property for the response status 500
  response-property-enum-value-added
- ●
  added the new not_found_error enum value to the error/type response property for the response status 404
  response-property-enum-value-added
- ●
  added the new rate_limit_exceeded_error enum value to the error/type response property for the response status 429
  response-property-enum-value-added
- ●
  added the new validation_error enum value to the error/type response property for the response status 400
  response-property-enum-value-added
- ○
  added the new optional request property anyOf[PostcardCreateWithHTML]/paper
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFFile]/paper
  new-optional-request-property
- ○
  added the new optional request property anyOf[PostcardCreateWithPDFURL]/paper
  new-optional-request-property
- ○
  added subschema #1 subschema #2 to the response body anyOf list for the response status 401
  response-body-any-of-added
- ○
  removed subschema #1 subschema #2 from the response body anyOf list for the response status 401
  response-body-any-of-removed
- ○
  added the optional property paper to the response with the 201 status
  response-optional-property-added
This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history