Skip to main content
PATCH
/
job-types
/
{JOB_TYPE_ID}
Update a job type
curl --request PATCH \
  --url https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Store Manager",
  "job_description": "<job_description>",
  "ai_interviewer_guidance": "Be friendly and professional",
  "resume_collection_type": "before_interview",
  "should_force_fullscreen": true,
  "should_record_video": true
}
'
{
  "data": {
    "job_type": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "job_description": "<string>",
      "ai_interviewer_guidance": "<string>",
      "qualifications": [
        "<string>"
      ],
      "should_force_fullscreen": true,
      "should_record_video": true
    }
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
JOB_TYPE_ID
string<uuid>
required

The ID of the job type to update.

Body

application/json

Job type fields to update. Only the fields included in the request are updated.

​
name
string

Name of the job type. Must be unique across the company's other job types.

Required string length: 3 - 150
​
job_description
string

Detailed description of the job

Required string length: 20 - 15000
​
ai_interviewer_guidance
string | null

Guidance for the AI interviewer. Set to null to clear it.

Required string length: 15 - 3000
​
resume_collection_type
enum<string> | null

Resume collection configuration. Set to null to disable resume collection.

Available options:
after_interview,
before_interview
​
should_force_fullscreen
boolean

Whether to force fullscreen mode

​
should_record_video
boolean

Whether to record video

Response

Job type updated successfully

​
data
object
required