PUT
Save the user's edit of the application's cover letter

Authorizations

x-api-key
string
header
required

An API key from Settings → Developers → API keys in Hiresweep.

Path Parameters

id
string
required

The ID of the application.

Minimum string length: 1

Body

application/json
text
string
required

The letter as plain text, or empty to remove it.

Maximum string length: 10000

Response

200 - application/json

The application with the saved cover letter.

id
string
required

The ID of the application.

clientId
string | null
required

The client this application is for; null for your own.

jobPostingId
string
required
resumeId
string | null
required
status
enum<string>
required

Where the application stands in the pipeline.

Available options:
saved,
reviewing,
reviewed,
tailoring,
ready,
applying,
needs_action,
submitted,
screening,
interview,
offer,
rejected,
withdrawn,
ghosted
statusChangedAt
string<date-time>
required
matchScore
integer | null
required

How well the chosen resume answers the posting.

Required range: 0 <= x <= 100
matchScorecard
object | null
required

The per-dimension breakdown behind the score.

tailoredResumeId
string | null
required

The copy of the chosen resume tailored to this posting, if any.

tailoring
object | null
required

What tailoring changed, what it refused, and how the copy scores.

tailorError
string | null
required

Why the last tailoring failed, if it did.

applySource
enum<string>
required

Whether an apply run attaches the tailored copy or the resume itself.

Available options:
tailored,
original
notes
string | null
required

The user's own notes about this application.

coverLetter
string | null
required

The application's cover letter as plain text, once there is one.

coverLetterTone
enum<string> | null
required

The tone the cover letter was last written in.

Available options:
neutral,
warm,
formal,
concise
coverLetterGeneratedAt
string<date-time> | null
required

When the cover letter was last written by AI.

submittedVia
enum<string> | null
required

Whether the application was sent by hand or assisted.

Available options:
manual,
assisted
submittedAt
string<date-time> | null
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
posting
object
required
resume
object | null
required