Letters

Change a letter

The same words for everyone (with {{first_name}}, {{company}} and your own fields), or written_for_each for a letter written for each person. Also a P.S., the look, the name or the postage.

Permission: Read and write.

patch/v1/letters/{letter}

Request

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

Path parameters

letterstring uuid required

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

Request body

wordsstring

The same words for everyone, with {{first_name}}, {{company}} and your own fields.

written_for_eachboolean

True for a letter written for each person: each person’s letter comes from their letter when you add them.

second_notestring nullable

A P.S., or null for none.

lookstring

A look’s id, from Looks for a letter.

namestring
postage'first' | 'second'
their_logoboolean

True to print each person’s own company logo on their letter, in a space where it sits best; false to take it off. Give each person’s logo when you add them.

if_no_logo'wait' | 'company_name' | 'blank'

What prints for anyone without a logo: wait (the default: it can’t be ordered until everyone has one), company_name (their company’s name instead), or blank.

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.