Skip to main content
POST
Restore a cover letter version

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required
Minimum string length: 1
versionId
string
required
Minimum string length: 1

Response

The restored letter.

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
id
string
required
sourceResumeId
string | null
required
sourceApplicationId
string | null
required
senderLinked
boolean
required

The sender's details come live from the source resume, instead of the copy in style.

designLinked
boolean
required

The design comes live from the source resume, instead of the copy in style.

isLocked
boolean
required

Locked letters can't be edited or moved to Trash until they're unlocked.

revision
integer
required
Required range: 1 <= x <= 9007199254740991
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
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}$