Update a candidate

curl --request PATCH \
  --url https://api.modernloop.io/v1/candidates/{candidateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recruiter_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "coordinator_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "sourcer_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "clear_preferred_email": true,
  "timezone": "<string>",
  "preferred_phone_number": "<string>",
  "locale": "<string>",
  "conflict_of_interest_employee_ids": [
    "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  ]
}
'

import requests

url = "https://api.modernloop.io/v1/candidates/{candidateId}"

payload = {
    "recruiter_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "coordinator_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "sourcer_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "clear_preferred_email": True,
    "timezone": "<string>",
    "preferred_phone_number": "<string>",
    "locale": "<string>",
    "conflict_of_interest_employee_ids": ["emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"]
}
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({
    recruiter_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    coordinator_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    sourcer_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    clear_preferred_email: true,
    timezone: '<string>',
    preferred_phone_number: '<string>',
    locale: '<string>',
    conflict_of_interest_employee_ids: ['emp_a1b2c3d4e5f64789a1b2c3d4e5f64789']
  })
};

fetch('https://api.modernloop.io/v1/candidates/{candidateId}', 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.modernloop.io/v1/candidates/{candidateId}",
  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([
    'recruiter_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'coordinator_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'sourcer_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'clear_preferred_email' => true,
    'timezone' => '<string>',
    'preferred_phone_number' => '<string>',
    'locale' => '<string>',
    'conflict_of_interest_employee_ids' => [
        'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789'
    ]
  ]),
  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.modernloop.io/v1/candidates/{candidateId}"

	payload := strings.NewReader("{\n  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\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.modernloop.io/v1/candidates/{candidateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modernloop.io/v1/candidates/{candidateId}")

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  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\n  ]\n}"

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

{
  "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "name": {
    "full": "<string>",
    "given": "<string>",
    "family": "<string>"
  },
  "primary_email": "jsmith@example.com",
  "additional_emails": [
    "jsmith@example.com"
  ],
  "phone_numbers": [
    "<string>"
  ],
  "timezone": "<string>",
  "linkedin_url": "<string>",
  "preferred_name": "<string>",
  "recruiter": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "name": "<string>"
  },
  "coordinator": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "name": "<string>"
  },
  "ats": {
    "id": "<string>"
  },
  "anonymized": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "app_url": "<string>"
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

PATCH

candidates

{candidateId}

Update a candidate

curl --request PATCH \
  --url https://api.modernloop.io/v1/candidates/{candidateId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "recruiter_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "coordinator_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "sourcer_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "clear_preferred_email": true,
  "timezone": "<string>",
  "preferred_phone_number": "<string>",
  "locale": "<string>",
  "conflict_of_interest_employee_ids": [
    "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"
  ]
}
'

import requests

url = "https://api.modernloop.io/v1/candidates/{candidateId}"

payload = {
    "recruiter_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "coordinator_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "sourcer_id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "clear_preferred_email": True,
    "timezone": "<string>",
    "preferred_phone_number": "<string>",
    "locale": "<string>",
    "conflict_of_interest_employee_ids": ["emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"]
}
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({
    recruiter_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    coordinator_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    sourcer_id: 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    clear_preferred_email: true,
    timezone: '<string>',
    preferred_phone_number: '<string>',
    locale: '<string>',
    conflict_of_interest_employee_ids: ['emp_a1b2c3d4e5f64789a1b2c3d4e5f64789']
  })
};

fetch('https://api.modernloop.io/v1/candidates/{candidateId}', 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.modernloop.io/v1/candidates/{candidateId}",
  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([
    'recruiter_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'coordinator_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'sourcer_id' => 'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789',
    'clear_preferred_email' => true,
    'timezone' => '<string>',
    'preferred_phone_number' => '<string>',
    'locale' => '<string>',
    'conflict_of_interest_employee_ids' => [
        'emp_a1b2c3d4e5f64789a1b2c3d4e5f64789'
    ]
  ]),
  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.modernloop.io/v1/candidates/{candidateId}"

	payload := strings.NewReader("{\n  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\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.modernloop.io/v1/candidates/{candidateId}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.modernloop.io/v1/candidates/{candidateId}")

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  \"recruiter_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"coordinator_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"sourcer_id\": \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\",\n  \"clear_preferred_email\": true,\n  \"timezone\": \"<string>\",\n  \"preferred_phone_number\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"conflict_of_interest_employee_ids\": [\n    \"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789\"\n  ]\n}"

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

{
  "id": "can_a1b2c3d4e5f64789a1b2c3d4e5f64789",
  "name": {
    "full": "<string>",
    "given": "<string>",
    "family": "<string>"
  },
  "primary_email": "jsmith@example.com",
  "additional_emails": [
    "jsmith@example.com"
  ],
  "phone_numbers": [
    "<string>"
  ],
  "timezone": "<string>",
  "linkedin_url": "<string>",
  "preferred_name": "<string>",
  "recruiter": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "name": "<string>"
  },
  "coordinator": {
    "id": "emp_a1b2c3d4e5f64789a1b2c3d4e5f64789",
    "name": "<string>"
  },
  "ats": {
    "id": "<string>"
  },
  "anonymized": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "app_url": "<string>"
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

{
  "error": {
    "message": "<string>",
    "docs_url": "<string>"
  }
}

Beta: this endpoint may change or be removed without notice while in beta. There is no compatibility promise until it reaches general availability.

Authorizations

Authorization

string

header

required

API tokens are passed as Bearer tokens.

Path Parameters

candidateId

string

required

a candidate ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:can_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example:

"can_a1b2c3d4e5f64789a1b2c3d4e5f64789"

Body

application/json

recruiter_id

string | null

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

coordinator_id

string | null

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

sourcer_id

string | null

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Example:

"emp_a1b2c3d4e5f64789a1b2c3d4e5f64789"

clear_preferred_email

boolean

True clears the preferred email; omit or false preserves it.

timezone

string

Replaces the timezone; omit to preserve.

preferred_phone_number

string

Replaces the preferred phone number; omit to preserve. Write-only.

locale

string

Replaces the locale; omit to preserve. Write-only.

conflict_of_interest_employee_ids

string[]

Replaces the full conflict-of-interest list; an empty array clears it and omission preserves it. Write-only.

an employee ID. Accepts the canonical prefixed compact UUID, a prefixed dashed UUID, a bare dashed UUID, or a bare compact UUID; input is case-insensitive.

Pattern: ^(?:emp_)?(?:[0-9a-fA-F]{32}|[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})$

Response

Success

string

required

Canonical candidate ID (can_ followed by 32 lowercase hexadecimal UUID characters).

Pattern: ^can_[0-9a-f]{32}$

Example:

"can_a1b2c3d4e5f64789a1b2c3d4e5f64789"

name

object

required

Show child attributes

primary_email

string<email> | null

required

additional_emails

string<email>[] | null

required

Additional candidate email addresses. Null means PII was redacted because the candidate is anonymized; an empty array means no additional email addresses.

phone_numbers

string[] | null

required

Candidate phone numbers. Null means PII was redacted because the candidate is anonymized; an empty array means no phone numbers.

timezone

string | null

required

linkedin_url

string<uri> | null

required

preferred_name

string | null

required

recruiter

object | null

required

Show child attributes

coordinator

object | null

required

Show child attributes

ats

object | null

required

Show child attributes

anonymized

boolean

required

created_at

string<date-time>

required

ISO 8601 timestamp.

updated_at

string<date-time>

required

ISO 8601 timestamp.

app_url

string<uri>

required

Get a candidate Search interview events

Application

Candidate

Interview Event

Interview Module

Interviewer

Job Stage

Job

Organization

Schedule

Task Queue

Scheduling Task

Template

Update a candidate

Authorizations

Path Parameters

Body

Response