Create candidate
curl --request POST \
--url https://{instance}/api/v1/candidates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
{
"id": "<string>",
"school": "<string>",
"degree": "<string>",
"field": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"description": "<string>"
}
],
"experienceEntries": [
{
"id": "<string>",
"company": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"current": true,
"location": "<string>",
"description": "<string>"
}
]
}
'import requests
url = "https://{instance}/api/v1/candidates"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
{
"id": "<string>",
"school": "<string>",
"degree": "<string>",
"field": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"description": "<string>"
}
],
"experienceEntries": [
{
"id": "<string>",
"company": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"current": True,
"location": "<string>",
"description": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
address: '<string>',
location: '<string>',
headline: '<string>',
summary: '<string>',
linkedinUrl: '<string>',
githubUrl: '<string>',
websiteUrl: '<string>',
educationEntries: [
{
id: '<string>',
school: '<string>',
degree: '<string>',
field: '<string>',
startDate: '<string>',
endDate: '<string>',
description: '<string>'
}
],
experienceEntries: [
{
id: '<string>',
company: '<string>',
title: '<string>',
startDate: '<string>',
endDate: '<string>',
current: true,
location: '<string>',
description: '<string>'
}
]
})
};
fetch('https://{instance}/api/v1/candidates', 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://{instance}/api/v1/candidates",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address' => '<string>',
'location' => '<string>',
'headline' => '<string>',
'summary' => '<string>',
'linkedinUrl' => '<string>',
'githubUrl' => '<string>',
'websiteUrl' => '<string>',
'educationEntries' => [
[
'id' => '<string>',
'school' => '<string>',
'degree' => '<string>',
'field' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'description' => '<string>'
]
],
'experienceEntries' => [
[
'id' => '<string>',
'company' => '<string>',
'title' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'current' => true,
'location' => '<string>',
'description' => '<string>'
]
]
]),
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://{instance}/api/v1/candidates"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{instance}/api/v1/candidates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/v1/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
"<unknown>"
],
"experienceEntries": [
"<unknown>"
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"meta": {
"pagination": {
"nextCursor": "<string>",
"hasMore": true,
"limit": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Candidates
Create candidate
POST
/
api
/
v1
/
candidates
Create candidate
curl --request POST \
--url https://{instance}/api/v1/candidates \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
{
"id": "<string>",
"school": "<string>",
"degree": "<string>",
"field": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"description": "<string>"
}
],
"experienceEntries": [
{
"id": "<string>",
"company": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"current": true,
"location": "<string>",
"description": "<string>"
}
]
}
'import requests
url = "https://{instance}/api/v1/candidates"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
{
"id": "<string>",
"school": "<string>",
"degree": "<string>",
"field": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"description": "<string>"
}
],
"experienceEntries": [
{
"id": "<string>",
"company": "<string>",
"title": "<string>",
"startDate": "<string>",
"endDate": "<string>",
"current": True,
"location": "<string>",
"description": "<string>"
}
]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
firstName: '<string>',
lastName: '<string>',
email: 'jsmith@example.com',
phone: '<string>',
address: '<string>',
location: '<string>',
headline: '<string>',
summary: '<string>',
linkedinUrl: '<string>',
githubUrl: '<string>',
websiteUrl: '<string>',
educationEntries: [
{
id: '<string>',
school: '<string>',
degree: '<string>',
field: '<string>',
startDate: '<string>',
endDate: '<string>',
description: '<string>'
}
],
experienceEntries: [
{
id: '<string>',
company: '<string>',
title: '<string>',
startDate: '<string>',
endDate: '<string>',
current: true,
location: '<string>',
description: '<string>'
}
]
})
};
fetch('https://{instance}/api/v1/candidates', 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://{instance}/api/v1/candidates",
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([
'firstName' => '<string>',
'lastName' => '<string>',
'email' => 'jsmith@example.com',
'phone' => '<string>',
'address' => '<string>',
'location' => '<string>',
'headline' => '<string>',
'summary' => '<string>',
'linkedinUrl' => '<string>',
'githubUrl' => '<string>',
'websiteUrl' => '<string>',
'educationEntries' => [
[
'id' => '<string>',
'school' => '<string>',
'degree' => '<string>',
'field' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'description' => '<string>'
]
],
'experienceEntries' => [
[
'id' => '<string>',
'company' => '<string>',
'title' => '<string>',
'startDate' => '<string>',
'endDate' => '<string>',
'current' => true,
'location' => '<string>',
'description' => '<string>'
]
]
]),
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://{instance}/api/v1/candidates"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
req, _ := http.NewRequest("POST", 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.post("https://{instance}/api/v1/candidates")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://{instance}/api/v1/candidates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"address\": \"<string>\",\n \"location\": \"<string>\",\n \"headline\": \"<string>\",\n \"summary\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"websiteUrl\": \"<string>\",\n \"educationEntries\": [\n {\n \"id\": \"<string>\",\n \"school\": \"<string>\",\n \"degree\": \"<string>\",\n \"field\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"description\": \"<string>\"\n }\n ],\n \"experienceEntries\": [\n {\n \"id\": \"<string>\",\n \"company\": \"<string>\",\n \"title\": \"<string>\",\n \"startDate\": \"<string>\",\n \"endDate\": \"<string>\",\n \"current\": true,\n \"location\": \"<string>\",\n \"description\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"firstName": "<string>",
"lastName": "<string>",
"email": "jsmith@example.com",
"phone": "<string>",
"address": "<string>",
"location": "<string>",
"headline": "<string>",
"summary": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"websiteUrl": "<string>",
"educationEntries": [
"<unknown>"
],
"experienceEntries": [
"<unknown>"
],
"createdAt": "<string>",
"updatedAt": "<string>"
},
"meta": {
"pagination": {
"nextCursor": "<string>",
"hasMore": true,
"limit": 123
}
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}{
"error": {
"code": "<string>",
"message": "<string>",
"details": "<unknown>"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
Required string length:
1 - 120Required string length:
1 - 120Maximum string length:
320Pattern:
^(?!\.)(?!.*\.\.)([A-Za-z0-9_'+\-\.]*)[A-Za-z0-9_+-]@([A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$Maximum string length:
20000Maximum string length:
20000Maximum string length:
20000Maximum string length:
20000Maximum string length:
20000Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
⌘I