Update Job

Update job

curl --request PATCH \
  --url https://api.instaview.sk/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Senior TypeScript Developer",
  "description": "We are looking for an experienced TypeScript developer...",
  "requiredSkills": [
    "TypeScript",
    "React",
    "Node.js"
  ],
  "niceToHaveSkills": [
    "Docker",
    "AWS",
    "GraphQL"
  ],
  "languageRequirements": [
    {
      "language": "EN",
      "proficiency": "B2"
    },
    {
      "language": "SK",
      "proficiency": "C1"
    }
  ],
  "descriptionUrl": "https://example.com/jobs/senior-typescript-dev",
  "workMode": "REMOTE",
  "location": {
    "workMode": "REMOTE",
    "street": "Hlavná 123",
    "city": "Bratislava",
    "postalCode": "81101",
    "countryCode": "SK"
  },
  "status": "OPEN",
  "salary": {
    "min": 50000,
    "max": 80000,
    "currency": "USD",
    "period": "YEARLY"
  },
  "metadata": {
    "salaryRange": "80k-120k",
    "benefits": [
      "health insurance",
      "remote work"
    ]
  }
}
'

import requests

url = "https://api.instaview.sk/jobs/{id}"

payload = {
    "title": "Senior TypeScript Developer",
    "description": "We are looking for an experienced TypeScript developer...",
    "requiredSkills": ["TypeScript", "React", "Node.js"],
    "niceToHaveSkills": ["Docker", "AWS", "GraphQL"],
    "languageRequirements": [
        {
            "language": "EN",
            "proficiency": "B2"
        },
        {
            "language": "SK",
            "proficiency": "C1"
        }
    ],
    "descriptionUrl": "https://example.com/jobs/senior-typescript-dev",
    "workMode": "REMOTE",
    "location": {
        "workMode": "REMOTE",
        "street": "Hlavná 123",
        "city": "Bratislava",
        "postalCode": "81101",
        "countryCode": "SK"
    },
    "status": "OPEN",
    "salary": {
        "min": 50000,
        "max": 80000,
        "currency": "USD",
        "period": "YEARLY"
    },
    "metadata": {
        "salaryRange": "80k-120k",
        "benefits": ["health insurance", "remote work"]
    }
}
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({
    title: 'Senior TypeScript Developer',
    description: 'We are looking for an experienced TypeScript developer...',
    requiredSkills: ['TypeScript', 'React', 'Node.js'],
    niceToHaveSkills: ['Docker', 'AWS', 'GraphQL'],
    languageRequirements: [{language: 'EN', proficiency: 'B2'}, {language: 'SK', proficiency: 'C1'}],
    descriptionUrl: 'https://example.com/jobs/senior-typescript-dev',
    workMode: 'REMOTE',
    location: {
      workMode: 'REMOTE',
      street: 'Hlavná 123',
      city: 'Bratislava',
      postalCode: '81101',
      countryCode: 'SK'
    },
    status: 'OPEN',
    salary: {min: 50000, max: 80000, currency: 'USD', period: 'YEARLY'},
    metadata: {salaryRange: '80k-120k', benefits: ['health insurance', 'remote work']}
  })
};

fetch('https://api.instaview.sk/jobs/{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.instaview.sk/jobs/{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([
    'title' => 'Senior TypeScript Developer',
    'description' => 'We are looking for an experienced TypeScript developer...',
    'requiredSkills' => [
        'TypeScript',
        'React',
        'Node.js'
    ],
    'niceToHaveSkills' => [
        'Docker',
        'AWS',
        'GraphQL'
    ],
    'languageRequirements' => [
        [
                'language' => 'EN',
                'proficiency' => 'B2'
        ],
        [
                'language' => 'SK',
                'proficiency' => 'C1'
        ]
    ],
    'descriptionUrl' => 'https://example.com/jobs/senior-typescript-dev',
    'workMode' => 'REMOTE',
    'location' => [
        'workMode' => 'REMOTE',
        'street' => 'Hlavná 123',
        'city' => 'Bratislava',
        'postalCode' => '81101',
        'countryCode' => 'SK'
    ],
    'status' => 'OPEN',
    'salary' => [
        'min' => 50000,
        'max' => 80000,
        'currency' => 'USD',
        'period' => 'YEARLY'
    ],
    'metadata' => [
        'salaryRange' => '80k-120k',
        'benefits' => [
                'health insurance',
                'remote work'
        ]
    ]
  ]),
  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.instaview.sk/jobs/{id}"

	payload := strings.NewReader("{\n  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\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.instaview.sk/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.instaview.sk/jobs/{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  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "987e6543-e21b-12d3-a456-426614174000",
  "title": "Senior TypeScript Developer",
  "status": "OPEN",
  "createdAt": "2024-11-16T10:30:00Z",
  "updatedAt": "2024-11-16T10:30:00Z",
  "description": "We are looking for an experienced TypeScript developer...",
  "jobUrl": "https://company.com/careers/senior-typescript-dev",
  "benefits": "Health insurance, remote work, flexible hours",
  "requiredSkills": [
    "TypeScript",
    "React",
    "Node.js"
  ],
  "niceToHaveSkills": [
    "Docker",
    "AWS"
  ],
  "languageRequirements": [
    {
      "language": "EN",
      "proficiency": "B2"
    },
    {
      "language": "SK",
      "proficiency": "C1"
    }
  ],
  "education": [
    "BACHELORS"
  ],
  "experience": "SENIOR",
  "contractType": "FULL_TIME",
  "location": {
    "workMode": "REMOTE",
    "street": "Hlavná 123",
    "city": "Bratislava",
    "postalCode": "81101",
    "countryCode": "SK"
  },
  "salary": {
    "min": 50000,
    "max": 80000,
    "currency": "USD",
    "period": "YEARLY"
  },
  "metadata": {
    "externalJobId": "JOB-12345",
    "department": "Engineering"
  }
}

PATCH

jobs

{id}

Update job

curl --request PATCH \
  --url https://api.instaview.sk/jobs/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "Senior TypeScript Developer",
  "description": "We are looking for an experienced TypeScript developer...",
  "requiredSkills": [
    "TypeScript",
    "React",
    "Node.js"
  ],
  "niceToHaveSkills": [
    "Docker",
    "AWS",
    "GraphQL"
  ],
  "languageRequirements": [
    {
      "language": "EN",
      "proficiency": "B2"
    },
    {
      "language": "SK",
      "proficiency": "C1"
    }
  ],
  "descriptionUrl": "https://example.com/jobs/senior-typescript-dev",
  "workMode": "REMOTE",
  "location": {
    "workMode": "REMOTE",
    "street": "Hlavná 123",
    "city": "Bratislava",
    "postalCode": "81101",
    "countryCode": "SK"
  },
  "status": "OPEN",
  "salary": {
    "min": 50000,
    "max": 80000,
    "currency": "USD",
    "period": "YEARLY"
  },
  "metadata": {
    "salaryRange": "80k-120k",
    "benefits": [
      "health insurance",
      "remote work"
    ]
  }
}
'

import requests

url = "https://api.instaview.sk/jobs/{id}"

payload = {
    "title": "Senior TypeScript Developer",
    "description": "We are looking for an experienced TypeScript developer...",
    "requiredSkills": ["TypeScript", "React", "Node.js"],
    "niceToHaveSkills": ["Docker", "AWS", "GraphQL"],
    "languageRequirements": [
        {
            "language": "EN",
            "proficiency": "B2"
        },
        {
            "language": "SK",
            "proficiency": "C1"
        }
    ],
    "descriptionUrl": "https://example.com/jobs/senior-typescript-dev",
    "workMode": "REMOTE",
    "location": {
        "workMode": "REMOTE",
        "street": "Hlavná 123",
        "city": "Bratislava",
        "postalCode": "81101",
        "countryCode": "SK"
    },
    "status": "OPEN",
    "salary": {
        "min": 50000,
        "max": 80000,
        "currency": "USD",
        "period": "YEARLY"
    },
    "metadata": {
        "salaryRange": "80k-120k",
        "benefits": ["health insurance", "remote work"]
    }
}
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({
    title: 'Senior TypeScript Developer',
    description: 'We are looking for an experienced TypeScript developer...',
    requiredSkills: ['TypeScript', 'React', 'Node.js'],
    niceToHaveSkills: ['Docker', 'AWS', 'GraphQL'],
    languageRequirements: [{language: 'EN', proficiency: 'B2'}, {language: 'SK', proficiency: 'C1'}],
    descriptionUrl: 'https://example.com/jobs/senior-typescript-dev',
    workMode: 'REMOTE',
    location: {
      workMode: 'REMOTE',
      street: 'Hlavná 123',
      city: 'Bratislava',
      postalCode: '81101',
      countryCode: 'SK'
    },
    status: 'OPEN',
    salary: {min: 50000, max: 80000, currency: 'USD', period: 'YEARLY'},
    metadata: {salaryRange: '80k-120k', benefits: ['health insurance', 'remote work']}
  })
};

fetch('https://api.instaview.sk/jobs/{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.instaview.sk/jobs/{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([
    'title' => 'Senior TypeScript Developer',
    'description' => 'We are looking for an experienced TypeScript developer...',
    'requiredSkills' => [
        'TypeScript',
        'React',
        'Node.js'
    ],
    'niceToHaveSkills' => [
        'Docker',
        'AWS',
        'GraphQL'
    ],
    'languageRequirements' => [
        [
                'language' => 'EN',
                'proficiency' => 'B2'
        ],
        [
                'language' => 'SK',
                'proficiency' => 'C1'
        ]
    ],
    'descriptionUrl' => 'https://example.com/jobs/senior-typescript-dev',
    'workMode' => 'REMOTE',
    'location' => [
        'workMode' => 'REMOTE',
        'street' => 'Hlavná 123',
        'city' => 'Bratislava',
        'postalCode' => '81101',
        'countryCode' => 'SK'
    ],
    'status' => 'OPEN',
    'salary' => [
        'min' => 50000,
        'max' => 80000,
        'currency' => 'USD',
        'period' => 'YEARLY'
    ],
    'metadata' => [
        'salaryRange' => '80k-120k',
        'benefits' => [
                'health insurance',
                'remote work'
        ]
    ]
  ]),
  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.instaview.sk/jobs/{id}"

	payload := strings.NewReader("{\n  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\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.instaview.sk/jobs/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.instaview.sk/jobs/{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  \"title\": \"Senior TypeScript Developer\",\n  \"description\": \"We are looking for an experienced TypeScript developer...\",\n  \"requiredSkills\": [\n    \"TypeScript\",\n    \"React\",\n    \"Node.js\"\n  ],\n  \"niceToHaveSkills\": [\n    \"Docker\",\n    \"AWS\",\n    \"GraphQL\"\n  ],\n  \"languageRequirements\": [\n    {\n      \"language\": \"EN\",\n      \"proficiency\": \"B2\"\n    },\n    {\n      \"language\": \"SK\",\n      \"proficiency\": \"C1\"\n    }\n  ],\n  \"descriptionUrl\": \"https://example.com/jobs/senior-typescript-dev\",\n  \"workMode\": \"REMOTE\",\n  \"location\": {\n    \"workMode\": \"REMOTE\",\n    \"street\": \"Hlavná 123\",\n    \"city\": \"Bratislava\",\n    \"postalCode\": \"81101\",\n    \"countryCode\": \"SK\"\n  },\n  \"status\": \"OPEN\",\n  \"salary\": {\n    \"min\": 50000,\n    \"max\": 80000,\n    \"currency\": \"USD\",\n    \"period\": \"YEARLY\"\n  },\n  \"metadata\": {\n    \"salaryRange\": \"80k-120k\",\n    \"benefits\": [\n      \"health insurance\",\n      \"remote work\"\n    ]\n  }\n}"

response = http.request(request)
puts response.read_body

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "companyId": "987e6543-e21b-12d3-a456-426614174000",
  "title": "Senior TypeScript Developer",
  "status": "OPEN",
  "createdAt": "2024-11-16T10:30:00Z",
  "updatedAt": "2024-11-16T10:30:00Z",
  "description": "We are looking for an experienced TypeScript developer...",
  "jobUrl": "https://company.com/careers/senior-typescript-dev",
  "benefits": "Health insurance, remote work, flexible hours",
  "requiredSkills": [
    "TypeScript",
    "React",
    "Node.js"
  ],
  "niceToHaveSkills": [
    "Docker",
    "AWS"
  ],
  "languageRequirements": [
    {
      "language": "EN",
      "proficiency": "B2"
    },
    {
      "language": "SK",
      "proficiency": "C1"
    }
  ],
  "education": [
    "BACHELORS"
  ],
  "experience": "SENIOR",
  "contractType": "FULL_TIME",
  "location": {
    "workMode": "REMOTE",
    "street": "Hlavná 123",
    "city": "Bratislava",
    "postalCode": "81101",
    "countryCode": "SK"
  },
  "salary": {
    "min": 50000,
    "max": 80000,
    "currency": "USD",
    "period": "YEARLY"
  },
  "metadata": {
    "externalJobId": "JOB-12345",
    "department": "Engineering"
  }
}

Updates an existing job posting using partial updates. Only provided fields will be updated; omitted fields remain unchanged.

Overview

The update job endpoint allows you to modify job details without recreating the job. This supports partial updates, meaning you only need to provide the fields you want to change. Useful for updating job descriptions, changing status, adjusting salary, or modifying skills requirements.

Use Cases

Status Updates: Change job status (OPEN to CLOSED, etc.)
Content Updates: Update job description or requirements
Salary Adjustments: Modify salary ranges as needed
Skills Refinement: Update required or nice-to-have skills

Partial Updates

You can update any combination of fields:

// Update only status
PATCH /jobs/{id}
{
  "status": "CLOSED"
}

// Update multiple fields
PATCH /jobs/{id}
{
  "title": "Updated Job Title",
  "description": "Updated description",
  "requiredSkills": ["New", "Skills", "List"]
}

Status Transitions

Jobs can transition between statuses:

OPEN → CLOSED: Position filled or paused
CLOSED → OPEN: Reopening a position

Status changes affect nothing else. Contacts stay associated with the job whatever its status, and their conversations are untouched. Closing a job is the safe way to retire it — unlike deleting it, which takes its contacts and conversations with it.

Company Isolation

You can only update jobs that belong to your API key’s company. A job from another company answers 404 Not Found — the same status and the same body as an id that exists nowhere, so the response never confirms that an id exists somewhere else.

Error Scenarios

404 Not Found: No job with that id is available to your API key. It does not exist, it has been deleted, or it belongs to another company — the three are deliberately indistinguishable, so do not branch on this status to detect a permission problem.
400 Bad Request: Invalid field values or validation errors

Jobs Resource Guide

Learn about job management and status workflows

Get Job

Retrieve current job configuration

Create Job

Create new job postings

Authorizations

Authorization

string

header

required

API key for authentication using Bearer scheme

Path Parameters

string<uuid>

required

Query Parameters

companyId

string

Required for ATS API keys to specify which company to access. Ignored for standard company API keys.

Body

application/json

title

string

Job title

Required string length: 5 - 200

Example:

"Senior TypeScript Developer"

description

string

Job description

Required string length: 10 - 5000

Example:

"We are looking for an experienced TypeScript developer..."

requiredSkills

string[]

Required skills

Maximum array length: 10

Example:

["TypeScript", "React", "Node.js"]

niceToHaveSkills

string[]

Nice-to-have skills

Maximum array length: 10

Example:

["Docker", "AWS", "GraphQL"]

languageRequirements

object[]

Language requirements with proficiency levels

Maximum array length: 5

Show child attributes

Example:

[
  { "language": "EN", "proficiency": "B2" },
  { "language": "SK", "proficiency": "C1" }
]

descriptionUrl

string

URL to full job description

Example:

"https://example.com/jobs/senior-typescript-dev"

workMode

enum<string>

Work mode

Available options:

UNDEFINED,

ONSITE,

REMOTE,

HYBRID

Example:

"REMOTE"

location

object

Job location details

Show child attributes

status

enum<string>

Job status

Available options:

UNDEFINED,

OPEN,

CLOSED

Example:

"OPEN"

salary

object

Salary range with comprehensive validation: min and max must be >= 0, min < max, currency and period are required if min or max is provided, at least one of min or max must be provided if any salary field is present

Show child attributes

Example:

{
  "min": 50000,
  "max": 80000,
  "currency": "USD",
  "period": "YEARLY"
}

metadata

object

Custom metadata (merged with existing metadata, max 10KB, 5 levels deep, 50 keys)

Example:

{
  "salaryRange": "80k-120k",
  "benefits": ["health insurance", "remote work"]
}

Response

string

required

Job ID

Example:

"123e4567-e89b-12d3-a456-426614174000"

companyId

string

required

Company ID

Example:

"987e6543-e21b-12d3-a456-426614174000"

title

string

required

Job title

Example:

"Senior TypeScript Developer"

status

enum<string>

required

Job status

Available options:

UNDEFINED,

OPEN,

CLOSED

Example:

"OPEN"

createdAt

string

required

Created timestamp

Example:

"2024-11-16T10:30:00Z"

updatedAt

string

required

Updated timestamp

Example:

"2024-11-16T10:30:00Z"

description

string | null

Job description

Example:

"We are looking for an experienced TypeScript developer..."

jobUrl

string

Job URL

Example:

"https://company.com/careers/senior-typescript-dev"

benefits

string

Benefits

Example:

"Health insurance, remote work, flexible hours"

requiredSkills

string[]

Required skills

Example:

["TypeScript", "React", "Node.js"]

niceToHaveSkills

string[]

Nice-to-have skills

Example:

["Docker", "AWS"]

languageRequirements

object[]

Language requirements with proficiency levels

Show child attributes

Example:

[
  { "language": "EN", "proficiency": "B2" },
  { "language": "SK", "proficiency": "C1" }
]

education

string[]

Education requirements

Example:

["BACHELORS"]

experience

string

Experience level

Example:

"SENIOR"

contractType

string

Contract type

Example:

"FULL_TIME"

location

object

Location information

Show child attributes

salary

object

Salary range

Show child attributes

Example:

{
  "min": 50000,
  "max": 80000,
  "currency": "USD",
  "period": "YEARLY"
}

metadata

object

Custom metadata

Example:

{
  "externalJobId": "JOB-12345",
  "department": "Engineering"
}

Overview

Agents

Agent Knowledge Base

Jobs

Contacts

Contact Documents

Contact Fields

Companies

Conversations

Runs

Billing

Voice

Webhooks

Sourcing

Phone Numbers

Overview

Use Cases

Partial Updates

Status Transitions

Company Isolation

Error Scenarios

Jobs Resource Guide

Get Job

Create Job

Authorizations

Path Parameters

Query Parameters

Body

Response

​Overview

​Use Cases

​Partial Updates

​Status Transitions

​Company Isolation

​Error Scenarios

​Related Resources

Jobs Resource Guide

Get Job

Create Job

Authorizations

Path Parameters

Query Parameters

Body

Response

Overview

Use Cases

Partial Updates

Status Transitions

Company Isolation

Error Scenarios

Related Resources