Skip to main content
PATCH
Update Cover Letter

Overview

Update any field on a cover letter. Only fields you include in the request are modified.
Plus plan only. Returns 403 with { requiresUpgrade: true } if the user is on the free plan.
Scope required: cover-letter:write | Rate limit: 20 requests/min

Request

Path Parameters

string
required
Cover letter id

Body Parameters

All fields are optional. At least one must be provided.
string
Cover letter title.
string
Body text.
string
Cover letter template id. Pass null to clear.
boolean
Promote to default cover letter (unsets any existing default).
object
Template-variable map. Pass null to clear all variables.
boolean
Header: show name.
boolean
Header: show email.
boolean
Header: show phone.
boolean
Header: show address.
string
left | center | right.
string
Font family.
number
Font size in pt.
number
Line spacing.

Example

Response

boolean
Whether the update succeeded.
string
The cover letter ID.