Price and order

Order it

Send the number of letters you expect, as a check. Live: paid from your letter credits, only if they cover it all; otherwise nothing is ordered and you get a link to pay in the app. Sandbox: every check, but nothing is ordered, printed, posted or charged.

Permission: Full access.

post/v1/letters/{letter}/order

Request

  • Base URL: https://app.verygoodletter.co/api
  • URL: https://app.verygoodletter.co/api/v1/letters/{letter}/order
  • Auth: HTTP bearer

Path parameters

letterstring uuid required

The letter’s id, from Start a letter or Your letters.

Request body

lettersinteger required

How many letters you expect it to be, as a check: one for each person on it.

Response

What it did, as JSON, with the mode it ran in.

mode'sandbox' | 'live' required

Which the request ran in: the key’s.

Changes

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