Skip to main content
PUT
/
applications
/
{id}
Update a job application
curl --request PUT \
  --url http://localhost:3000/api/openapi/applications/{id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "company": "<string>",
  "role": "<string>",
  "location": "<string>",
  "salary": "<string>",
  "source": "<string>",
  "sourceUrl": "<string>",
  "jobDescription": "<string>",
  "notes": "<string>",
  "resumeFileUrl": "<string>",
  "resumeFileName": "<string>",
  "coverLetterUrl": "<string>",
  "coverLetterName": "<string>",
  "followUpAt": "2023-11-07T05:31:56Z",
  "followUpNote": "<string>",
  "contacts": [
    {
      "name": "<string>",
      "role": "",
      "type": ""
    }
  ],
  "resumeId": "<string>",
  "tags": [
    "<string>"
  ],
  "archived": true
}
'
{
  "id": "<string>",
  "company": "<string>",
  "role": "<string>",
  "location": "<string>",
  "salary": "<string>",
  "archived": true,
  "resumeId": "<string>",
  "source": "<string>",
  "tags": [
    "<string>"
  ],
  "sourceUrl": "<string>",
  "jobDescription": "<string>",
  "matchScore": 50,
  "aiMetadata": {},
  "notes": "<string>",
  "resumeFileUrl": "<string>",
  "resumeFileName": "<string>",
  "coverLetterUrl": "<string>",
  "coverLetterName": "<string>",
  "followUpAt": "2023-11-07T05:31:56Z",
  "followUpNote": "<string>",
  "contacts": [
    {
      "name": "<string>",
      "role": "",
      "type": ""
    }
  ],
  "activity": [
    {
      "id": "<string>",
      "text": "<string>",
      "at": "2023-11-07T05:31:56Z"
    }
  ],
  "appliedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key
string
header
required

The API key to authenticate requests.

Path Parameters

id
string
required

Body

application/json
company
string

The company applied to.

Minimum string length: 1
role
string

The role / job title.

Minimum string length: 1
location
string | null
salary
string | null
source
string | null
sourceUrl
string | null
jobDescription
string | null
Maximum string length: 20000
notes
string | null
resumeFileUrl
string | null
resumeFileName
string | null
coverLetterUrl
string | null
coverLetterName
string | null
followUpAt
string<date-time> | null
followUpNote
string | null
contacts
object[]
resumeId
string | null

The linked Reactive Resume, if any.

tags
string[]
status
enum<string>
Available options:
saved,
applied,
screening,
interview,
offer,
rejected
archived
boolean

Response

200 - application/json

The updated application.

id
string
required

The ID of the application.

company
string
required

The company applied to.

Minimum string length: 1
role
string
required

The role / job title.

Minimum string length: 1
location
string | null
required
salary
string | null
required
status
enum<string>
required

The current pipeline stage.

Available options:
saved,
applied,
screening,
interview,
offer,
rejected
archived
boolean
required
resumeId
string | null
required

The linked Reactive Resume, if any.

source
string | null
required
tags
string[]
required
sourceUrl
string | null
required
jobDescription
string | null
required
Maximum string length: 20000
matchScore
integer | null
required
Required range: 0 <= x <= 100
aiMetadata
object | null
required
notes
string | null
required
resumeFileUrl
string | null
required
resumeFileName
string | null
required
coverLetterUrl
string | null
required
coverLetterName
string | null
required
followUpAt
string<date-time> | null
required
followUpNote
string | null
required
contacts
object[]
required
activity
object[]
required
appliedAt
string<date-time>
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required