MCP
A2AUpdate Candidate
curl --request PATCH \
--url https://api.stackone.com/unified/ats/candidates/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"passthrough": {
"other_known_names": "John Doe"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "sestier.romain123@gmail.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"phone": "+16178294093",
"phone_numbers": [
{
"phone": "+447700112233"
}
],
"company": "Company Inc.",
"title": "Software Engineer",
"application_ids": [
"123e4567-e89b-12d3-a456-426614174000",
"523e1234-e89b-fdd2-a456-762545121101"
],
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
}
'import requests
url = "https://api.stackone.com/unified/ats/candidates/{id}"
payload = {
"passthrough": { "other_known_names": "John Doe" },
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "sestier.romain123@gmail.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"phone": "+16178294093",
"phone_numbers": [{ "phone": "+447700112233" }],
"company": "Company Inc.",
"title": "Software Engineer",
"application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"],
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
passthrough: {other_known_names: 'John Doe'},
unified_custom_fields: {
my_project_custom_field_1: 'REF-1236',
my_project_custom_field_2: 'some other value'
},
name: 'Romain Sestier',
first_name: 'Romain',
last_name: 'Sestier',
email: 'sestier.romain123@gmail.com',
emails: [{type: 'personal', value: 'sestier.romain123@gmail.com'}],
social_links: [{type: 'linkedin', url: 'https://www.linkedin.com/in/romainsestier/'}],
phone: '+16178294093',
phone_numbers: [{phone: '+447700112233'}],
company: 'Company Inc.',
title: 'Software Engineer',
application_ids: ['123e4567-e89b-12d3-a456-426614174000', '523e1234-e89b-fdd2-a456-762545121101'],
hired_at: '2021-01-01T01:01:01.000Z',
country: 'United States',
custom_fields: [
{
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Training Completion Status',
value: 'Completed',
value_id: 'value_456',
remote_value_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
}
]
})
};
fetch('https://api.stackone.com/unified/ats/candidates/{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.stackone.com/unified/ats/candidates/{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([
'passthrough' => [
'other_known_names' => 'John Doe'
],
'unified_custom_fields' => [
'my_project_custom_field_1' => 'REF-1236',
'my_project_custom_field_2' => 'some other value'
],
'name' => 'Romain Sestier',
'first_name' => 'Romain',
'last_name' => 'Sestier',
'email' => 'sestier.romain123@gmail.com',
'emails' => [
[
'type' => 'personal',
'value' => 'sestier.romain123@gmail.com'
]
],
'social_links' => [
[
'type' => 'linkedin',
'url' => 'https://www.linkedin.com/in/romainsestier/'
]
],
'phone' => '+16178294093',
'phone_numbers' => [
[
'phone' => '+447700112233'
]
],
'company' => 'Company Inc.',
'title' => 'Software Engineer',
'application_ids' => [
'123e4567-e89b-12d3-a456-426614174000',
'523e1234-e89b-fdd2-a456-762545121101'
],
'hired_at' => '2021-01-01T01:01:01.000Z',
'country' => 'United States',
'custom_fields' => [
[
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Training Completion Status',
'value' => 'Completed',
'value_id' => 'value_456',
'remote_value_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$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.stackone.com/unified/ats/candidates/{id}"
payload := strings.NewReader("{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/unified/ats/candidates/{id}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/ats/candidates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Update Candidate
PATCH
/
unified
/
ats
/
candidates
/
{id}
Update Candidate
curl --request PATCH \
--url https://api.stackone.com/unified/ats/candidates/{id} \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--header 'x-account-id: <x-account-id>' \
--data '
{
"passthrough": {
"other_known_names": "John Doe"
},
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "sestier.romain123@gmail.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"phone": "+16178294093",
"phone_numbers": [
{
"phone": "+447700112233"
}
],
"company": "Company Inc.",
"title": "Software Engineer",
"application_ids": [
"123e4567-e89b-12d3-a456-426614174000",
"523e1234-e89b-fdd2-a456-762545121101"
],
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
}
'import requests
url = "https://api.stackone.com/unified/ats/candidates/{id}"
payload = {
"passthrough": { "other_known_names": "John Doe" },
"unified_custom_fields": {
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
},
"name": "Romain Sestier",
"first_name": "Romain",
"last_name": "Sestier",
"email": "sestier.romain123@gmail.com",
"emails": [
{
"type": "personal",
"value": "sestier.romain123@gmail.com"
}
],
"social_links": [
{
"type": "linkedin",
"url": "https://www.linkedin.com/in/romainsestier/"
}
],
"phone": "+16178294093",
"phone_numbers": [{ "phone": "+447700112233" }],
"company": "Company Inc.",
"title": "Software Engineer",
"application_ids": ["123e4567-e89b-12d3-a456-426614174000", "523e1234-e89b-fdd2-a456-762545121101"],
"hired_at": "2021-01-01T01:01:01.000Z",
"country": "United States",
"custom_fields": [
{
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"name": "Training Completion Status",
"value": "Completed",
"value_id": "value_456",
"remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
}
]
}
headers = {
"x-account-id": "<x-account-id>",
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {
'x-account-id': '<x-account-id>',
Authorization: 'Basic <encoded-value>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
passthrough: {other_known_names: 'John Doe'},
unified_custom_fields: {
my_project_custom_field_1: 'REF-1236',
my_project_custom_field_2: 'some other value'
},
name: 'Romain Sestier',
first_name: 'Romain',
last_name: 'Sestier',
email: 'sestier.romain123@gmail.com',
emails: [{type: 'personal', value: 'sestier.romain123@gmail.com'}],
social_links: [{type: 'linkedin', url: 'https://www.linkedin.com/in/romainsestier/'}],
phone: '+16178294093',
phone_numbers: [{phone: '+447700112233'}],
company: 'Company Inc.',
title: 'Software Engineer',
application_ids: ['123e4567-e89b-12d3-a456-426614174000', '523e1234-e89b-fdd2-a456-762545121101'],
hired_at: '2021-01-01T01:01:01.000Z',
country: 'United States',
custom_fields: [
{
id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
remote_id: '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
name: 'Training Completion Status',
value: 'Completed',
value_id: 'value_456',
remote_value_id: 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
}
]
})
};
fetch('https://api.stackone.com/unified/ats/candidates/{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.stackone.com/unified/ats/candidates/{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([
'passthrough' => [
'other_known_names' => 'John Doe'
],
'unified_custom_fields' => [
'my_project_custom_field_1' => 'REF-1236',
'my_project_custom_field_2' => 'some other value'
],
'name' => 'Romain Sestier',
'first_name' => 'Romain',
'last_name' => 'Sestier',
'email' => 'sestier.romain123@gmail.com',
'emails' => [
[
'type' => 'personal',
'value' => 'sestier.romain123@gmail.com'
]
],
'social_links' => [
[
'type' => 'linkedin',
'url' => 'https://www.linkedin.com/in/romainsestier/'
]
],
'phone' => '+16178294093',
'phone_numbers' => [
[
'phone' => '+447700112233'
]
],
'company' => 'Company Inc.',
'title' => 'Software Engineer',
'application_ids' => [
'123e4567-e89b-12d3-a456-426614174000',
'523e1234-e89b-fdd2-a456-762545121101'
],
'hired_at' => '2021-01-01T01:01:01.000Z',
'country' => 'United States',
'custom_fields' => [
[
'id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'remote_id' => '8187e5da-dc77-475e-9949-af0f1fa4e4e3',
'name' => 'Training Completion Status',
'value' => 'Completed',
'value_id' => 'value_456',
'remote_value_id' => 'e3cb75bf-aa84-466e-a6c1-b8322b257a48'
]
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json",
"x-account-id: <x-account-id>"
],
]);
$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.stackone.com/unified/ats/candidates/{id}"
payload := strings.NewReader("{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-account-id", "<x-account-id>")
req.Header.Add("Authorization", "Basic <encoded-value>")
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.stackone.com/unified/ats/candidates/{id}")
.header("x-account-id", "<x-account-id>")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.stackone.com/unified/ats/candidates/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-account-id"] = '<x-account-id>'
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"passthrough\": {\n \"other_known_names\": \"John Doe\"\n },\n \"unified_custom_fields\": {\n \"my_project_custom_field_1\": \"REF-1236\",\n \"my_project_custom_field_2\": \"some other value\"\n },\n \"name\": \"Romain Sestier\",\n \"first_name\": \"Romain\",\n \"last_name\": \"Sestier\",\n \"email\": \"sestier.romain123@gmail.com\",\n \"emails\": [\n {\n \"type\": \"personal\",\n \"value\": \"sestier.romain123@gmail.com\"\n }\n ],\n \"social_links\": [\n {\n \"type\": \"linkedin\",\n \"url\": \"https://www.linkedin.com/in/romainsestier/\"\n }\n ],\n \"phone\": \"+16178294093\",\n \"phone_numbers\": [\n {\n \"phone\": \"+447700112233\"\n }\n ],\n \"company\": \"Company Inc.\",\n \"title\": \"Software Engineer\",\n \"application_ids\": [\n \"123e4567-e89b-12d3-a456-426614174000\",\n \"523e1234-e89b-fdd2-a456-762545121101\"\n ],\n \"hired_at\": \"2021-01-01T01:01:01.000Z\",\n \"country\": \"United States\",\n \"custom_fields\": [\n {\n \"id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"remote_id\": \"8187e5da-dc77-475e-9949-af0f1fa4e4e3\",\n \"name\": \"Training Completion Status\",\n \"value\": \"Completed\",\n \"value_id\": \"value_456\",\n \"remote_value_id\": \"e3cb75bf-aa84-466e-a6c1-b8322b257a48\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"statusCode": 201,
"message": "Record created successfully.",
"timestamp": "2021-01-01T01:01:01.000Z",
"data": {
"id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
"remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
}
}{
"statusCode": 400,
"message": "Bad Request",
"timestamp": "2023-05-30T00:00:00.000Z",
"data": {
"statusCode": 400,
"message": "Bad Request",
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
},
"provider_errors": [
{
"status": 400,
"url": "https://api.provider.com/v1/resource",
"raw": {
"message": "Invalid input parameters"
},
"headers": {
"content-type": "application/json",
"x-request-id": "5678c28b211dace4e0a0f9171e6b88c5"
}
}
]
}{
"statusCode": 401,
"message": "Unauthorized",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 403,
"message": "Forbidden resource",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 404,
"message": "Not Found",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 408,
"message": "Request timed out",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 409,
"message": "Conflict",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 412,
"message": "Precondition failed",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 422,
"message": "Unprocessable Entity",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 429,
"message": "Too many requests",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 500,
"message": "Internal server error",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 501,
"message": "Not Implemented",
"timestamp": "2023-05-30T00:00:00.000Z"
}{
"statusCode": 502,
"message": "Bad Gateway",
"timestamp": "2023-05-30T00:00:00.000Z"
}Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Headers
The account identifier
Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)
Example:
"heartbeat"
Path Parameters
Body
application/json
Value to pass through to the provider
Example:
{ "other_known_names": "John Doe" }
Custom Unified Fields configured in your StackOne project
Example:
{
"my_project_custom_field_1": "REF-1236",
"my_project_custom_field_2": "some other value"
}
Candidate name
Example:
"Romain Sestier"
Candidate first name
Example:
"Romain"
Candidate last name
Example:
"Sestier"
Candidate email
Example:
"sestier.romain123@gmail.com"
List of candidate emails
Show child attributes
Show child attributes
List of candidate social links
Show child attributes
Show child attributes
Candidate phone number
Example:
"+16178294093"
List of candidate phone numbers including the type of the number when available
Show child attributes
Show child attributes
Candidate company
Example:
"Company Inc."
Candidate title
Example:
"Software Engineer"
List of candidate application IDs
Example:
[
"123e4567-e89b-12d3-a456-426614174000",
"523e1234-e89b-fdd2-a456-762545121101"
]
Candidate hired date
Example:
"2021-01-01T01:01:01.000Z"
Candidate country
Example:
"United States"
The candidate custom fields
Show child attributes
Show child attributes
Was this page helpful?
⌘I