Skip to main content
POST
cURL

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Body

application/json
resumeId
string
required

The resume to share. Its current content is saved with the link.

Minimum string length: 1
label
string
required

Who the link is for, such as a coach's name.

Required string length: 1 - 80
allowComments
boolean
default:true

Whether the reviewer can leave comments.

applicationIds
string[]

Applications whose stage and dates the reviewer can follow. Notes, contacts and salary stay private.

Maximum array length: 20
Minimum string length: 1
expiresAt
string<date-time> | null

When the link stops working; null for no expiry.

Response

The new feedback link, with the URL to send.

id
string
required
resumeId
string
required
resumeName
string
required

The resume's name when the link was made.

label
string
required

Who the link is for, in the owner's words. Only the owner sees it.

url
string
required

The link to send. Anyone with it can open what it shares until it expires or is revoked.

status
enum<string>
required

Whether the link opens: active, past its expiry, or turned off by the owner.

Available options:
active,
expired,
revoked
allowComments
boolean
required
applicationIds
string[]
required

Applications whose stage and dates the reviewer can follow.

expiresAt
string<date-time> | null
required
revokedAt
string<date-time> | null
required
lastViewedAt
string<date-time> | null
required
createdAt
string<date-time>
required

When the link was made, which is also when its resume version was saved.

commentCount
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
openCommentCount
integer
required

Comments the owner hasn't marked done.

Required range: -9007199254740991 <= x <= 9007199254740991