Sign in
Letters

Create Letter Create Letter

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

  • HTML content for the letter
  • A template ID for the letter
  • A URL for a PDF for the letter Create a letter 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/letters

Headers

idempotency-keystring

Request body

OR
OR

Response

the created Letter.

OR

Changes

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

  • 537d2bbc624a261814See the full diff
    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithHTML]/attachedPDF/allOf[AttachedPDF]/file request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithHTML]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithHTML]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithPDF]/attachedPDF/allOf[AttachedPDF]/file request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithPDF]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithPDF]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithPDF]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithTemplate]/attachedPDF/allOf[AttachedPDF]/file request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithTemplate]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      removed subschema #1 subschema #2 from the anyOf[LetterCreateWithTemplate]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property anyOf list

      request-property-any-of-removed

    • ▲

      the response's body type/format changed from object/ to / for status 201

      response-body-type-changed

    • ▲

      removed the required property addressPlacement from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property color from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property createdAt from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property doubleSided from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property envelope from the response with the 201 status

      response-required-property-removed

    • ▲

      removed the required property from 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 attachedPDF from the response with the 201 status

      response-optional-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 html 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 pdfWorkflowRun from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property perforatedPage from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property plasticCard from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property returnEnvelope from the response with the 201 status

      response-optional-property-removed

    • ●

      removed the optional property template 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 uploadedPDF 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 Letters_create removed and replaced with Letters_createJSON_Letters_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 BinaryFile subschema #1 to the anyOf[LetterCreateWithHTML]/attachedPDF/allOf[AttachedPDF]/file request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithHTML]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithHTML]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithPDF]/attachedPDF/allOf[AttachedPDF]/file request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithPDF]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithPDF]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithPDF]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithTemplate]/attachedPDF/allOf[AttachedPDF]/file request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithTemplate]/plasticCard/allOf[PlasticCard]/doubleSided/allOf[PlasticCardDoubleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added BinaryFile subschema #1 to the anyOf[LetterCreateWithTemplate]/plasticCard/allOf[PlasticCard]/singleSided/allOf[PlasticCardSingleSided]/pdf request property oneOf list

      request-property-one-of-added

    • ○

      added Letter Letter to the response body anyOf list for the response status 201

      response-body-any-of-added

  • 54cf11f8a76f14See the full diff
    • ○

      added the new optional request property anyOf[LetterCreateWithHTML]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithHTML]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithHTML]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithHTML]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithPDF]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithPDF]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithPDF]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithPDF]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/from/anyOf[ContactCreate]/oneOf[ContactCreateWithFirstName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/to/anyOf[ContactCreate]/oneOf[ContactCreateWithCompanyName]/secret

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/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

  • afd5935c2b2c218See the full diff
    • ▲

      added the new required request property anyOf[LetterCreateWithTemplate]/from

      new-required-request-property

    • ▲

      added the new required request property anyOf[LetterCreateWithTemplate]/to

      new-required-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithHTML]/paper

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithPDF]/paper

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/addressPlacement

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/attachedPDF

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/color

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/description

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/doubleSided

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/envelope

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/mailingClass

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/mergeVariables

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/metadata

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/paper

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/perforatedPage

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/plasticCard

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/returnEnvelope

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/sendDate

      new-optional-request-property

    • ○

      added the new optional request property anyOf[LetterCreateWithTemplate]/size

      new-optional-request-property

    • ○

      added the optional property paper to the response with the 201 status

      response-optional-property-added

  • c8fedcbd705e42See 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 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

    This revision also has 21 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog