Create a draft letter (nothing is charged). The envelope always carries our return address.

post/letters

Request

  • Base URL: https://printandmailcompany.com/api/v1
  • URL: https://printandmailcompany.com/api/v1/letters
  • Auth: HTTP bearer

Request body

documentIdstring required
duplexboolean
color'bw' | 'color'
envelope'DL' | 'C5' | 'C4'

Omit for the smallest envelope that fits

registeredboolean
paperSize'a4' | 'us_letter'

Only for a US Letter document (printedOn "US Letter") to a destination outside US, CA, PR, VI, GU, AS, MP (paperChoiceRequired): "a4" = shrink to A4 (recommended), "us_letter" = keep US Letter. Ask the user; same price. Ignored (not stored) for other letters: A4 and mixed documents are printed on A4, US Letter documents to those countries on US Letter.

Response

Draft letter with total; url is its page, where the account holder sees the print-ready PDF before sending

idstring
referencestring

Shown to the customer and on receipts, e.g. PM-7K3QX9

status'draft' | 'paid' | 'in_production' | 'printed' | 'posted' | 'cancelled' | 'returned'
documentIdstring
recipientLinesstring[]

The address as printed on the envelope

paperSize'a4' | 'us_letter' | 'null' nullable

Paper the letter is printed on (a draft's as decided from its document now, a paid letter's as fixed at payment); null while the customer still has to choose (paperChoiceRequired)

paperChoiceRequiredboolean

A US Letter document to a destination outside the US, Canada and US territories, and no choice yet: ask "shrink to A4 (recommended) or keep US Letter?" and send paperSize with /letters/{id}/send. Sending without it answers 409 PAPER_CHOICE_REQUIRED.

destinationPaperSize'a4' | 'us_letter'

Standard paper of the destination: us_letter for US, CA, PR, VI, GU, AS, MP, else a4

currency'EUR' | 'USD' | 'GBP' | 'CHF'
totalinteger

Total in minor units of currency

totalFormattedstring
quoteobject

Price breakdown in EUR cents (lines, netEurCents, vatEurCents, grossEurCents, vatRate, reverseCharge), postal size class and zone

priceLabelstring

"incl. 17% VAT", or "excl. VAT — reverse charge"

trackingNumberstring nullable

Registered letters, once posted

createdVia'web' | 'mcp' | 'api'
createdAtstring date-time
paidAtstring date-time nullable
postedAtstring date-time nullable
cancelledAtstring date-time nullable
urlstring uri

The letter's page in the customer's account, in the account's language: the print-ready PDF (page previews, open, download) until the retention period ends, the status and the price. Give it to the account holder to check the letter before sending; it needs their sign-in.

Changes

No recorded changes to this operation across all 1 revision of this API.