Skip to main content
GET
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required
Minimum string length: 1

Response

The exported cover letter document.

name
string
required
Required string length: 1 - 100
recipient
string
required
Maximum string length: 20000
content
string
required
Maximum string length: 100000
style
object
required
format
any
required
version
any
required
greeting
string | null

Custom greeting; null uses the document language default, empty omits it.

Maximum string length: 2000
signOff
string | null

Custom signature including name and optional contact details; null uses the document language default with the sender's name, empty omits it.

Maximum string length: 2000
layout
enum<string>
default:freeform

structured: recipient name, company and date fields, a greeting from the name, the body and a sign-off. freeform: the recipient block and body as written (letters from before structured letters).

Available options:
structured,
freeform
recipientName
string
default:""

Who the letter is to: a person, or a team.

Maximum string length: 200
recipientCompany
string
default:""
Maximum string length: 200
letterDate
string | null

The letter's date, as YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$