Postcards

Create Postcard Create Postcard

Changed on

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

Request

  • Base URL
    https://api.postgrid.com
  • URL
    https://api.postgrid.com/print-mail/v1/postcards
  • Auth
    API key in header X-API-Key

Headers

idempotency-keystring

Request body

OR
OR
OR

Response

the created Postcard.

OR

Changes

    • breaking

      added to the //// request property allOf list

    • breaking

      the //// request property type changed from string to no type, and format from byte to no format

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      api operation id Postcards_create removed and replaced with Postcards_createJSON_Postcards_createMultipart

    • info

      added the new optional header request parameter idempotency-key

    • info

      added the media type multipart/form-data to the request body

    • info

      added to the response body anyOf list for the response status

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the new optional request property /////////////

    • info

      added the optional property ///// to the response with the status

    • info

      added the optional property ///// to the response with the status