Skip to main content
PATCH
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required

Body

application/json
name
string

The name of the resume.

Minimum string length: 1
slug
string

The slug of the resume.

tags
string[]

The tags of the resume.

data
object
isPublic
boolean

Whether the resume is public.

showDownloadButtons
boolean

Whether visitors may download the public PDF.

allowWordDownload
boolean
showInSearchEngines
boolean

Whether search engines may list the resume's public web page. Off unless the owner turns it on.

hideContactDetails
boolean

Whether the public web page, its PDF and this API leave out the email, phone, location, custom header fields and references' phone numbers.

isPrimary
boolean

Whether this is the account's primary resume, opened by its short link and custom domain.

aiOperationIds
string[]
Maximum array length: 1000
Required string length: 1 - 64
expectedUpdatedAt
string<date-time>

If provided, the update only applies when the resume version still matches this timestamp.

proposalApplications
object

Assistant edit decisions saved with this change, by edit id: false takes an edit back; the edit's current after (the wording you applied), or snapshot: for an immutable structural proposal, records it as accepted, refined or not. Structural summaries from prior clients remain accepted within the 20000-character receipt limit. true records acceptance only when the saved document holds the edit exactly as proposed (a structural change: its whole snapshot.after). Tailoring the document can't take is refused either way.

proposalSafety
any

Send "v1" when your client applies assistant edits only through proposalApplications or after checking tailoredFor and the edit's current after. Documents with tailored or reworded assistant edits refuse content changes without it (RESUME_VERSION_CONFLICT, or CONFLICT for letters).

sessionId
string

Identifies one editing session. Saves that share it keep one autosave version, refreshed at most every two minutes.

Maximum string length: 64

Response

The updated resume with its full data.

id
string
required

The ID of the resume.

name
string
required

The name of the resume.

Minimum string length: 1
slug
string
required

The slug of the resume.

Minimum string length: 1
tags
string[]
required

The tags of the resume.

isPublic
boolean
required

Whether the resume is public.

showDownloadButtons
boolean
required

Whether visitors may download the public PDF.

showInSearchEngines
boolean
required

Whether search engines may list the resume's public web page. Off unless the owner turns it on.

hideContactDetails
boolean
required

Whether the public web page, its PDF and this API leave out the email, phone, location, custom header fields and references' phone numbers.

isPrimary
boolean
required

Whether this is the account's primary resume, opened by its short link and custom domain.

isLocked
boolean
required

Whether the resume is locked.

data
object
required
createdAt
string<date-time>
required

The date and time the resume was created.

updatedAt
string<date-time>
required

The date and time the resume was last updated.

hasPassword
boolean
required
allowWordDownload
boolean
default:false

Whether visitors may download the public Word file. Off unless the owner opts in.

aiOperationIds
string[]
Maximum array length: 1000
Required string length: 1 - 64
aiUsage
object | null