Upserts candidate
curl --request POST \
--url https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"primaryEmail": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"emails": [
"jsmith@example.com"
],
"phone": "<string>",
"links": {},
"education": "<string>",
"experienceYears": 1073741823.5,
"resumeUrl": "<string>",
"noticeWeeks": 1073741823.5,
"earliestStartDate": "<string>",
"currentSalary": 1073741823.5,
"expectedSalary": 1073741823.5,
"expectedSalaryMax": 1073741823.5,
"isVeteran": true,
"creatorId": "<string>",
"countryIso3": "<string>",
"zipCode": "<string>",
"address": "<string>",
"city": "<string>",
"notes": "<string>",
"jobId": "<string>"
}
'import requests
url = "https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate"
payload = {
"workspaceId": "<string>",
"primaryEmail": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"emails": ["jsmith@example.com"],
"phone": "<string>",
"links": {},
"education": "<string>",
"experienceYears": 1073741823.5,
"resumeUrl": "<string>",
"noticeWeeks": 1073741823.5,
"earliestStartDate": "<string>",
"currentSalary": 1073741823.5,
"expectedSalary": 1073741823.5,
"expectedSalaryMax": 1073741823.5,
"isVeteran": True,
"creatorId": "<string>",
"countryIso3": "<string>",
"zipCode": "<string>",
"address": "<string>",
"city": "<string>",
"notes": "<string>",
"jobId": "<string>"
}
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({
workspaceId: '<string>',
primaryEmail: 'jsmith@example.com',
name: '<string>',
title: '<string>',
emails: ['jsmith@example.com'],
phone: '<string>',
links: {},
education: '<string>',
experienceYears: 1073741823.5,
resumeUrl: '<string>',
noticeWeeks: 1073741823.5,
earliestStartDate: '<string>',
currentSalary: 1073741823.5,
expectedSalary: 1073741823.5,
expectedSalaryMax: 1073741823.5,
isVeteran: true,
creatorId: '<string>',
countryIso3: '<string>',
zipCode: '<string>',
address: '<string>',
city: '<string>',
notes: '<string>',
jobId: '<string>'
})
};
fetch('https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate', 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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate",
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([
'workspaceId' => '<string>',
'primaryEmail' => 'jsmith@example.com',
'name' => '<string>',
'title' => '<string>',
'emails' => [
'jsmith@example.com'
],
'phone' => '<string>',
'links' => [
],
'education' => '<string>',
'experienceYears' => 1073741823.5,
'resumeUrl' => '<string>',
'noticeWeeks' => 1073741823.5,
'earliestStartDate' => '<string>',
'currentSalary' => 1073741823.5,
'expectedSalary' => 1073741823.5,
'expectedSalaryMax' => 1073741823.5,
'isVeteran' => true,
'creatorId' => '<string>',
'countryIso3' => '<string>',
'zipCode' => '<string>',
'address' => '<string>',
'city' => '<string>',
'notes' => '<string>',
'jobId' => '<string>'
]),
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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate")
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 \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}zapier
Upserts candidate
Upserts candidate based on email, and optionally applies to a job
POST
/
zapier
/
create-candidate
Upserts candidate
curl --request POST \
--url https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"workspaceId": "<string>",
"primaryEmail": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"emails": [
"jsmith@example.com"
],
"phone": "<string>",
"links": {},
"education": "<string>",
"experienceYears": 1073741823.5,
"resumeUrl": "<string>",
"noticeWeeks": 1073741823.5,
"earliestStartDate": "<string>",
"currentSalary": 1073741823.5,
"expectedSalary": 1073741823.5,
"expectedSalaryMax": 1073741823.5,
"isVeteran": true,
"creatorId": "<string>",
"countryIso3": "<string>",
"zipCode": "<string>",
"address": "<string>",
"city": "<string>",
"notes": "<string>",
"jobId": "<string>"
}
'import requests
url = "https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate"
payload = {
"workspaceId": "<string>",
"primaryEmail": "jsmith@example.com",
"name": "<string>",
"title": "<string>",
"emails": ["jsmith@example.com"],
"phone": "<string>",
"links": {},
"education": "<string>",
"experienceYears": 1073741823.5,
"resumeUrl": "<string>",
"noticeWeeks": 1073741823.5,
"earliestStartDate": "<string>",
"currentSalary": 1073741823.5,
"expectedSalary": 1073741823.5,
"expectedSalaryMax": 1073741823.5,
"isVeteran": True,
"creatorId": "<string>",
"countryIso3": "<string>",
"zipCode": "<string>",
"address": "<string>",
"city": "<string>",
"notes": "<string>",
"jobId": "<string>"
}
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({
workspaceId: '<string>',
primaryEmail: 'jsmith@example.com',
name: '<string>',
title: '<string>',
emails: ['jsmith@example.com'],
phone: '<string>',
links: {},
education: '<string>',
experienceYears: 1073741823.5,
resumeUrl: '<string>',
noticeWeeks: 1073741823.5,
earliestStartDate: '<string>',
currentSalary: 1073741823.5,
expectedSalary: 1073741823.5,
expectedSalaryMax: 1073741823.5,
isVeteran: true,
creatorId: '<string>',
countryIso3: '<string>',
zipCode: '<string>',
address: '<string>',
city: '<string>',
notes: '<string>',
jobId: '<string>'
})
};
fetch('https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate', 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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate",
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([
'workspaceId' => '<string>',
'primaryEmail' => 'jsmith@example.com',
'name' => '<string>',
'title' => '<string>',
'emails' => [
'jsmith@example.com'
],
'phone' => '<string>',
'links' => [
],
'education' => '<string>',
'experienceYears' => 1073741823.5,
'resumeUrl' => '<string>',
'noticeWeeks' => 1073741823.5,
'earliestStartDate' => '<string>',
'currentSalary' => 1073741823.5,
'expectedSalary' => 1073741823.5,
'expectedSalaryMax' => 1073741823.5,
'isVeteran' => true,
'creatorId' => '<string>',
'countryIso3' => '<string>',
'zipCode' => '<string>',
'address' => '<string>',
'city' => '<string>',
'notes' => '<string>',
'jobId' => '<string>'
]),
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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate"
payload := strings.NewReader("{\n \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\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://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://mgnmzef4kd.us-east-1.awsapprunner.com/api/v1/zapier/create-candidate")
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 \"workspaceId\": \"<string>\",\n \"primaryEmail\": \"jsmith@example.com\",\n \"name\": \"<string>\",\n \"title\": \"<string>\",\n \"emails\": [\n \"jsmith@example.com\"\n ],\n \"phone\": \"<string>\",\n \"links\": {},\n \"education\": \"<string>\",\n \"experienceYears\": 1073741823.5,\n \"resumeUrl\": \"<string>\",\n \"noticeWeeks\": 1073741823.5,\n \"earliestStartDate\": \"<string>\",\n \"currentSalary\": 1073741823.5,\n \"expectedSalary\": 1073741823.5,\n \"expectedSalaryMax\": 1073741823.5,\n \"isVeteran\": true,\n \"creatorId\": \"<string>\",\n \"countryIso3\": \"<string>\",\n \"zipCode\": \"<string>\",\n \"address\": \"<string>\",\n \"city\": \"<string>\",\n \"notes\": \"<string>\",\n \"jobId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>"
}Authorizations
API key for authentication
Body
application/json
Show child attributes
Show child attributes
Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Available options:
USD, EUR, GBP, EGP, AED, SAR Required range:
0 <= x <= 2147483647Required range:
0 <= x <= 2147483647Available options:
USD, EUR, GBP, EGP, AED, SAR Response
Successfully upserted the candidate
⌘I