Update a cover letter
Updates the supplied fields of a saved cover letter using its expected revision.
1 min read
patch/cover-letters/{id}
Request example
curl --request PATCH "https://rxresu.me/api/openapi/cover-letters/<id>" --header "x-api-key: <api-key>" --header "Content-Type: application/json" --data '{
"expectedRevision": 123
}'Response
{
"name": "<string>",
"recipient": "<string>",
"content": "<string>",
"greeting": null,
"signOff": null,
"style": {
"basics": {
"name": "<string>",
"headline": "<string>",
"email": "<string>",
"phone": "<string>",
"location": "<string>",
"website": {
"url": "<string>",
"label": "<string>"
},
"customFields": [
{
"id": "<string>",
"icon": "<string>",
"text": "<string>",
"link": "<string>"
}
]
},
"picture": {
"hidden": true,
"fit": "cover",
"url": "<string>",
"size": 32,
"rotation": 0,
"aspectRatio": 0.5,
"borderRadius": 0,
"borderColor": "<string>",
"borderWidth": 0,
"shadowColor": "<string>",
"shadowWidth": 0
},
"metadata": {
"template": "azurill",
"page": {
"gapX": 0,
"gapY": 0,
"marginX": 0,
"marginY": 0,
"format": "a4",
"locale": "<string>",
"dateFormat": "short",
"hideLinkUnderline": true,
"hideIcons": true,
"hideSectionIcons": true
},
"design": {
"level": {
"icon": "<string>",
"type": "hidden"
},
"colors": {
"primary": "<string>",
"text": "<string>",
"background": "<string>"
},
"entry": {
"layout": "stacked",
"lead": "organization",
"accent": "none"
}
},
"typography": {
"body": {
"fontFamily": "<string>",
"fontWeights": [
"100"
],
"fontSize": 6,
"lineHeight": 0.5
},
"heading": {
"fontFamily": "<string>",
"fontWeights": [
"100"
],
"fontSize": 6,
"lineHeight": 0.5
},
"hyphenation": true
},
"styleRules": null,
"stylesheet": {
"mode": "legacy",
"source": {
"languageVersion": -9007199254740991,
"text": "<string>"
}
},
"web": {
"showCredit": true
},
"check": {
"ignored": [
"<string>"
],
"hiddenTerms": [
"<string>"
]
}
},
"sectionId": "<string>",
"itemId": "<string>"
},
"layout": "freeform",
"recipientName": "",
"recipientCompany": "",
"letterDate": null,
"id": "<string>",
"sourceResumeId": "<string>",
"sourceApplicationId": "<string>",
"senderLinked": true,
"designLinked": true,
"isLocked": true,
"revision": 1,
"createdAt": "2026-08-10T12:00:00Z",
"updatedAt": "2026-08-10T12:00:00Z"
}{
"defined": true,
"code": "<string>",
"status": 1,
"message": "<string>",
"data": null
}patch/cover-letters/{id}
Authorization
The API key to authenticate requests.
2 alternative authorization methods available — see the spec for details.
Path parameters
Length: min 1
Body
application/jsonRange: 1–9007199254740991
Length: 1–100
Length: max 20000
Length: max 100000
Sets the letter's own template, which unlinks its design.
Options:
azurillbronzorchikoritaditgardittogengarglaliekakunalaprasleafishmeowthonyxpersianpikachuporygonrhyhornscizorsmeargleSets the letter's own type, colors and page settings, which unlinks its design.
Show child attributesHide child attributes
The typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume.
Show child attributesHide child attributes
The typography for the body of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
The typography for the headings of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
Enable automatic PDF hyphenation using the resume language. Defaults to false.
The design settings of the resume. Determines the colors, level designs, and typography of the resume.
Show child attributesHide child attributes
Show child attributesHide child attributes
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field.
Options:
hiddencirclesquarerectanglerectangle-fullprogress-bariconShow child attributesHide child attributes
The primary color of the design, defined as rgba(r, g, b, a).
The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1).
The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1).
How entry headers are arranged and decorated. When missing, entries use the stacked layout.
Show child attributesHide child attributes
How the header of each Experience, Education and Volunteer entry is arranged. 'stacked' is two rows (name and location, then role and date), 'inline' puts everything on one row, 'compact' puts the lead and the date on top with the rest grouped below, 'date-column' sets dates in a column on the left, and 'eyebrow' puts a small line above a larger lead. Dates also move to the left column for Projects, Awards, Certifications and Publications with 'date-column'.
Options:
stackedinlinecompactdate-columneyebrowWhich comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study).
Options:
organizationroleDecoration in the accent color around each entry header: 'none', 'rule' (a line under it), 'bar' (a bar beside it) or 'band' (a tinted background).
Options:
nonerulebarbandThe page settings of the resume. Determines the margins, format, and locale of the resume.
Show child attributesHide child attributes
The horizontal gap between the sections of the page, defined in points (pt).
Range: >= 0
The vertical gap between the sections of the page, defined in points (pt).
Range: >= 0
The format of the page. Can be 'a4', 'letter', or 'free-form'.
Options:
a4letterfree-formThe locale of the page. Used for displaying pre-translated section headings, if not overridden.
How dates print: 'short' (Mar 2022), 'long' (March 2022), 'numeric' (03/2022) or 'iso' (2022-03). When missing, it's read from how the dates were typed.
Options:
shortlongnumericisoWhether to hide the underlines of the links.
Whether to hide the item-level icons (skills, profiles, interests).
Whether to hide the section heading icons displayed before section titles.
Length: max 200
Length: max 200
The resume the letter goes with.
The job the letter is for.
Take the sender's details live from the resume.
Take the design live from the resume.
The editing session; its saves share one History version, refreshed every two minutes.
Length: 1–64
Responses
application/json
The updated cover letter.
Length: 1–100
Length: max 20000
Length: max 100000
Custom greeting; null uses the document language default, empty omits it.
Default: null
Custom signature including name and optional contact details; null uses the document language default with the sender's name, empty omits it.
Default: null
Show child attributesHide child attributes
Show child attributesHide child attributes
The full name of the author of the resume.
The headline of the author of the resume.
The email address of the author of the resume.
The phone number of the author of the resume.
The location of the author of the resume.
The website of the author of the resume.
The custom fields to display on the resume.
Show child attributesHide child attributes
The unique identifier for the custom field. Usually generated as a UUID.
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
The text to display for the custom field.
If the custom field should be a link, the URL to link to.
Show child attributesHide child attributes
Whether to hide the picture from the resume.
How the picture fits its frame: cover crops overflow, while contain preserves the whole image.
Options:
covercontainThe URL to the picture to display on the resume. Prefer local app-served paths (for example /uploads/...) populated via upload.
The size of the picture to display on the resume, defined in points (pt).
Range: 32–512
The rotation of the picture to display on the resume, defined in degrees (°).
Range: 0–360
The aspect ratio of the picture to display on the resume, defined as width / height (e.g. 1.5 for 1.5:1 or 0.5 for 1:2).
Range: 0.5–2.5
The border radius of the picture to display on the resume, defined in points (pt).
Range: 0–100
The color of the border of the picture to display on the resume, defined as rgba(r, g, b, a).
The width of the border of the picture to display on the resume, defined in points (pt).
Range: >= 0
The color of the shadow of the picture to display on the resume, defined as rgba(r, g, b, a).
The width of the shadow of the picture to display on the resume, defined in points (pt).
Range: >= 0
Show child attributesHide child attributes
The template to use for the resume. Determines the overall design and appearance of the resume.
Options:
azurillbronzorchikoritaditgardittogengarglaliekakunalaprasleafishmeowthonyxpersianpikachuporygonrhyhornscizorsmeargleThe page settings of the resume. Determines the margins, format, and locale of the resume.
Show child attributesHide child attributes
The horizontal gap between the sections of the page, defined in points (pt).
Range: >= 0
The vertical gap between the sections of the page, defined in points (pt).
Range: >= 0
The format of the page. Can be 'a4', 'letter', or 'free-form'.
Options:
a4letterfree-formThe locale of the page. Used for displaying pre-translated section headings, if not overridden.
How dates print: 'short' (Mar 2022), 'long' (March 2022), 'numeric' (03/2022) or 'iso' (2022-03). When missing, it's read from how the dates were typed.
Options:
shortlongnumericisoWhether to hide the underlines of the links.
Whether to hide the item-level icons (skills, profiles, interests).
Whether to hide the section heading icons displayed before section titles.
The design settings of the resume. Determines the colors, level designs, and typography of the resume.
Show child attributesHide child attributes
Show child attributesHide child attributes
The icon to display for the custom field. Must be a valid icon name from @phosphor-icons/web icon set, or an empty string to hide. Default to '' (empty string) when unsure which icons are available.
The type of the level design. 'hidden' will hide the level design, 'circle' will display a circle, 'square' will display a square, 'rectangle' will display a rectangle, 'rectangle-full' will display a full rectangle, 'progress-bar' will display a progress bar, and 'icon' will display an icon. If 'icon' is selected, the icon to display should be specified in the 'icon' field.
Options:
hiddencirclesquarerectanglerectangle-fullprogress-bariconShow child attributesHide child attributes
The primary color of the design, defined as rgba(r, g, b, a).
The text color of the design, defined as rgba(r, g, b, a). Usually set to black: rgba(0, 0, 0, 1).
The background color of the design, defined as rgba(r, g, b, a). Usually set to white: rgba(255, 255, 255, 1).
How entry headers are arranged and decorated. When missing, entries use the stacked layout.
Show child attributesHide child attributes
How the header of each Experience, Education and Volunteer entry is arranged. 'stacked' is two rows (name and location, then role and date), 'inline' puts everything on one row, 'compact' puts the lead and the date on top with the rest grouped below, 'date-column' sets dates in a column on the left, and 'eyebrow' puts a small line above a larger lead. Dates also move to the left column for Projects, Awards, Certifications and Publications with 'date-column'.
Options:
stackedinlinecompactdate-columneyebrowWhich comes first in Experience and Education entries: the organization (company, school) or the role (position, field of study).
Options:
organizationroleDecoration in the accent color around each entry header: 'none', 'rule' (a line under it), 'bar' (a bar beside it) or 'band' (a tinted background).
Options:
nonerulebarbandThe typography settings of the resume. Determines the fonts and sizes of the body and headings of the resume.
Show child attributesHide child attributes
The typography for the body of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
The typography for the headings of the resume.
Show child attributesHide child attributes
The family of the font to use. Must be a supported resume font.
The weight of the font, defined as a number between 100 and 900. Default to 400 when unsure if the weight is available in the font.
The line height of the font to use, defined as a multiplier of the font size (e.g. 1.5 for 1.5x).
Range: 0.5–4
Enable automatic PDF hyphenation using the resume language. Defaults to false.
Structured style rules that target semantic resume sections and slots for PDF rendering.
Settings for the resume's public web page, which uses the resume's template. Missing until the author changes them in Share.
Show child attributesHide child attributes
Whether the web page shows the small 'Made with Reactive Resume' footer.
The author's Check choices for this resume. Not printed; missing until a choice is made.
Length: min 1
Length: min 1
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).
Default: "freeform"
Options:
structuredfreeformThe sender's details come live from the source resume, instead of the copy in
style.The design comes live from the source resume, instead of the copy in
style.Locked letters can't be edited or moved to Trash until they're unlocked.
Range: 1–9007199254740991