Create a placement
curl --request POST \
--url https://api.readyhealth.com/placement \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalId": "<string>",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"candidateName": "<string>",
"candidateEmail": "<string>",
"candidatePhone": "<string>",
"startDate": "2023-12-25"
}
'import requests
url = "https://api.readyhealth.com/placement"
payload = {
"externalId": "<string>",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"candidateName": "<string>",
"candidateEmail": "<string>",
"candidatePhone": "<string>",
"startDate": "2023-12-25"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
jobId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
atsPlacementRefId: '<string>',
vmsPlacementRefId: '<string>',
candidateName: '<string>',
candidateEmail: '<string>',
candidatePhone: '<string>',
startDate: '2023-12-25'
})
};
fetch('https://api.readyhealth.com/placement', 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.readyhealth.com/placement",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'jobId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'atsPlacementRefId' => '<string>',
'vmsPlacementRefId' => '<string>',
'candidateName' => '<string>',
'candidateEmail' => '<string>',
'candidatePhone' => '<string>',
'startDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.readyhealth.com/placement"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.readyhealth.com/placement")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/placement")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"vmsJobRefId": "<string>"
},
"candidate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
},
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"packets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packetGroup": "<string>",
"status": "INCOMPLETE"
}
],
"requirementCount": 123,
"fulfilledCount": 123,
"requirements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vmsRequirementName": "<string>",
"packetGroup": "<string>",
"fulfillmentType": "DOCUMENT",
"documentCategory": "<string>",
"documentType": "<string>",
"requirementKey": "<string>",
"status": "PENDING",
"isMapped": true,
"sortOrder": 123
}
]
}Placements
Create a Placement
Bind a candidate to a job. Idempotent on (jobId, externalUser) — a repeat call returns the existing placement.
POST
/
placement
Create a placement
curl --request POST \
--url https://api.readyhealth.com/placement \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"externalId": "<string>",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"candidateName": "<string>",
"candidateEmail": "<string>",
"candidatePhone": "<string>",
"startDate": "2023-12-25"
}
'import requests
url = "https://api.readyhealth.com/placement"
payload = {
"externalId": "<string>",
"jobId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"candidateName": "<string>",
"candidateEmail": "<string>",
"candidatePhone": "<string>",
"startDate": "2023-12-25"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
externalId: '<string>',
jobId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
atsPlacementRefId: '<string>',
vmsPlacementRefId: '<string>',
candidateName: '<string>',
candidateEmail: '<string>',
candidatePhone: '<string>',
startDate: '2023-12-25'
})
};
fetch('https://api.readyhealth.com/placement', 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.readyhealth.com/placement",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'externalId' => '<string>',
'jobId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'atsPlacementRefId' => '<string>',
'vmsPlacementRefId' => '<string>',
'candidateName' => '<string>',
'candidateEmail' => '<string>',
'candidatePhone' => '<string>',
'startDate' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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.readyhealth.com/placement"
payload := strings.NewReader("{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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.post("https://api.readyhealth.com/placement")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.readyhealth.com/placement")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"externalId\": \"<string>\",\n \"jobId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"atsPlacementRefId\": \"<string>\",\n \"vmsPlacementRefId\": \"<string>\",\n \"candidateName\": \"<string>\",\n \"candidateEmail\": \"<string>\",\n \"candidatePhone\": \"<string>\",\n \"startDate\": \"2023-12-25\"\n}"
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "ACTIVE",
"job": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"title": "<string>",
"vmsJobRefId": "<string>"
},
"candidate": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"externalId": "<string>"
},
"atsPlacementRefId": "<string>",
"vmsPlacementRefId": "<string>",
"packets": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"packetGroup": "<string>",
"status": "INCOMPLETE"
}
],
"requirementCount": 123,
"fulfilledCount": 123,
"requirements": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"vmsRequirementName": "<string>",
"packetGroup": "<string>",
"fulfillmentType": "DOCUMENT",
"documentCategory": "<string>",
"documentType": "<string>",
"requirementKey": "<string>",
"status": "PENDING",
"isMapped": true,
"sortOrder": 123
}
]
}Authorizations
Body
application/json
Candidate ID in your system.
Ready Health job ID (POST /job / GET /job/{id}).
Placement ID in the ATS.
Assignment start date (YYYY-MM-DD or ISO).
Response
201 - application/json
Placement. Same shape as GET /placement/{id}.
Available options:
ACTIVE, COMPLETED, CANCELLED Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes