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
}
'import requests
url = "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}"
payload := strings.NewReader("{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Hiring
Update Job Type
Updates the job type referenced by the provided job type ID.
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
}
'import requests
url = "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}"
payload = {
"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
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
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
})
};
fetch('https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'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
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}"
payload := strings.NewReader("{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/job-types/{JOB_TYPE_ID}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"Store Manager\",\n \"job_description\": \"<job_description>\",\n \"ai_interviewer_guidance\": \"Be friendly and professional\",\n \"resume_collection_type\": \"before_interview\",\n \"should_force_fullscreen\": true,\n \"should_record_video\": true\n}"
response = http.request(request)
puts response.read_body{
"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
}
}
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}{
"error": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
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 of the job type. Must be unique across the company's other job types.
Required string length:
3 - 150Detailed description of the job
Required string length:
20 - 15000Guidance for the AI interviewer. Set to null to clear it.
Required string length:
15 - 3000Resume collection configuration. Set to null to disable resume collection.
Available options:
after_interview, before_interview Whether to force fullscreen mode
Whether to record video
Response
Job type updated successfully
Show child attributes
Show child attributes
⌘I