Save the apply profile
curl --request PUT \
--url https://hiresweep.com/api/openapi/apply-profile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": true,
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"workAuthorizations": [
{
"country": "<string>"
}
],
"willingToRelocate": true,
"earliestStartDate": "",
"references": [],
"securityClearance": "",
"driversLicense": true,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"autoSubmitMinScore": 80,
"autoSubmit": true,
"clientId": "<string>"
}
'import requests
url = "https://hiresweep.com/api/openapi/apply-profile"
payload = {
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": True,
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"workAuthorizations": [{ "country": "<string>" }],
"willingToRelocate": True,
"earliestStartDate": "",
"references": [],
"securityClearance": "",
"driversLicense": True,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"autoSubmitMinScore": 80,
"autoSubmit": True,
"clientId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
location: '<string>',
workAuthorization: '<string>',
requiresSponsorship: true,
salaryExpectation: '<string>',
noticePeriod: '<string>',
linkedinUrl: '<string>',
githubUrl: '<string>',
portfolioUrl: '<string>',
answers: [{question: '<string>', answer: '<string>'}],
workAuthorizations: [{country: '<string>'}],
willingToRelocate: true,
earliestStartDate: '',
references: [],
securityClearance: '',
driversLicense: true,
selfIdentification: {
gender: 'decline',
raceEthnicity: 'decline',
veteranStatus: 'decline',
disabilityStatus: 'decline'
},
autoSubmitMinScore: 80,
autoSubmit: true,
clientId: '<string>'
})
};
fetch('https://hiresweep.com/api/openapi/apply-profile', 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://hiresweep.com/api/openapi/apply-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '<string>',
'location' => '<string>',
'workAuthorization' => '<string>',
'requiresSponsorship' => true,
'salaryExpectation' => '<string>',
'noticePeriod' => '<string>',
'linkedinUrl' => '<string>',
'githubUrl' => '<string>',
'portfolioUrl' => '<string>',
'answers' => [
[
'question' => '<string>',
'answer' => '<string>'
]
],
'workAuthorizations' => [
[
'country' => '<string>'
]
],
'willingToRelocate' => true,
'earliestStartDate' => '',
'references' => [
],
'securityClearance' => '',
'driversLicense' => true,
'selfIdentification' => [
'gender' => 'decline',
'raceEthnicity' => 'decline',
'veteranStatus' => 'decline',
'disabilityStatus' => 'decline'
],
'autoSubmitMinScore' => 80,
'autoSubmit' => true,
'clientId' => '<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://hiresweep.com/api/openapi/apply-profile"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://hiresweep.com/api/openapi/apply-profile")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/apply-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": true,
"workAuthorizations": [
{
"country": "<string>",
"status": "citizen"
}
],
"willingToRelocate": true,
"earliestStartDate": "<string>",
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"references": [
{
"name": "<string>",
"relationship": "<string>",
"company": "<string>",
"email": "",
"phone": "<string>"
}
],
"securityClearance": "<string>",
"driversLicense": true,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"submitMode": "review",
"autoSubmitMinScore": 75
}Applications
Save the apply profile
Replaces the apply profile, or one client’s with clientId. Fields added after a caller was written may be left out and take their empty value; a caller’s deprecated autoSubmit stands for the submit mode it leaves out. Requires authentication.
PUT
/
apply-profile
Save the apply profile
curl --request PUT \
--url https://hiresweep.com/api/openapi/apply-profile \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": true,
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"workAuthorizations": [
{
"country": "<string>"
}
],
"willingToRelocate": true,
"earliestStartDate": "",
"references": [],
"securityClearance": "",
"driversLicense": true,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"autoSubmitMinScore": 80,
"autoSubmit": true,
"clientId": "<string>"
}
'import requests
url = "https://hiresweep.com/api/openapi/apply-profile"
payload = {
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": True,
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"workAuthorizations": [{ "country": "<string>" }],
"willingToRelocate": True,
"earliestStartDate": "",
"references": [],
"securityClearance": "",
"driversLicense": True,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"autoSubmitMinScore": 80,
"autoSubmit": True,
"clientId": "<string>"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
phone: '<string>',
location: '<string>',
workAuthorization: '<string>',
requiresSponsorship: true,
salaryExpectation: '<string>',
noticePeriod: '<string>',
linkedinUrl: '<string>',
githubUrl: '<string>',
portfolioUrl: '<string>',
answers: [{question: '<string>', answer: '<string>'}],
workAuthorizations: [{country: '<string>'}],
willingToRelocate: true,
earliestStartDate: '',
references: [],
securityClearance: '',
driversLicense: true,
selfIdentification: {
gender: 'decline',
raceEthnicity: 'decline',
veteranStatus: 'decline',
disabilityStatus: 'decline'
},
autoSubmitMinScore: 80,
autoSubmit: true,
clientId: '<string>'
})
};
fetch('https://hiresweep.com/api/openapi/apply-profile', 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://hiresweep.com/api/openapi/apply-profile",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'phone' => '<string>',
'location' => '<string>',
'workAuthorization' => '<string>',
'requiresSponsorship' => true,
'salaryExpectation' => '<string>',
'noticePeriod' => '<string>',
'linkedinUrl' => '<string>',
'githubUrl' => '<string>',
'portfolioUrl' => '<string>',
'answers' => [
[
'question' => '<string>',
'answer' => '<string>'
]
],
'workAuthorizations' => [
[
'country' => '<string>'
]
],
'willingToRelocate' => true,
'earliestStartDate' => '',
'references' => [
],
'securityClearance' => '',
'driversLicense' => true,
'selfIdentification' => [
'gender' => 'decline',
'raceEthnicity' => 'decline',
'veteranStatus' => 'decline',
'disabilityStatus' => 'decline'
],
'autoSubmitMinScore' => 80,
'autoSubmit' => true,
'clientId' => '<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://hiresweep.com/api/openapi/apply-profile"
payload := strings.NewReader("{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}")
req, _ := http.NewRequest("PUT", 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.put("https://hiresweep.com/api/openapi/apply-profile")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://hiresweep.com/api/openapi/apply-profile")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"phone\": \"<string>\",\n \"location\": \"<string>\",\n \"workAuthorization\": \"<string>\",\n \"requiresSponsorship\": true,\n \"salaryExpectation\": \"<string>\",\n \"noticePeriod\": \"<string>\",\n \"linkedinUrl\": \"<string>\",\n \"githubUrl\": \"<string>\",\n \"portfolioUrl\": \"<string>\",\n \"answers\": [\n {\n \"question\": \"<string>\",\n \"answer\": \"<string>\"\n }\n ],\n \"workAuthorizations\": [\n {\n \"country\": \"<string>\"\n }\n ],\n \"willingToRelocate\": true,\n \"earliestStartDate\": \"\",\n \"references\": [],\n \"securityClearance\": \"\",\n \"driversLicense\": true,\n \"selfIdentification\": {\n \"gender\": \"decline\",\n \"raceEthnicity\": \"decline\",\n \"veteranStatus\": \"decline\",\n \"disabilityStatus\": \"decline\"\n },\n \"autoSubmitMinScore\": 80,\n \"autoSubmit\": true,\n \"clientId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"phone": "<string>",
"location": "<string>",
"workAuthorization": "<string>",
"requiresSponsorship": true,
"workAuthorizations": [
{
"country": "<string>",
"status": "citizen"
}
],
"willingToRelocate": true,
"earliestStartDate": "<string>",
"salaryExpectation": "<string>",
"noticePeriod": "<string>",
"address": {
"street": "<string>",
"city": "<string>",
"region": "<string>",
"postalCode": "<string>",
"country": "<string>"
},
"linkedinUrl": "<string>",
"githubUrl": "<string>",
"portfolioUrl": "<string>",
"references": [
{
"name": "<string>",
"relationship": "<string>",
"company": "<string>",
"email": "",
"phone": "<string>"
}
],
"securityClearance": "<string>",
"driversLicense": true,
"selfIdentification": {
"gender": "decline",
"raceEthnicity": "decline",
"veteranStatus": "decline",
"disabilityStatus": "decline"
},
"answers": [
{
"question": "<string>",
"answer": "<string>"
}
],
"submitMode": "review",
"autoSubmitMinScore": 75
}Authorizations
An API key from Settings → Developers → API keys in Hiresweep.
Body
application/json
Maximum string length:
64Maximum string length:
200Maximum string length:
500Maximum string length:
200Maximum string length:
200Maximum string length:
500Maximum string length:
500Maximum string length:
500Maximum array length:
200Show child attributes
Show child attributes
Maximum array length:
15Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
5Show child attributes
Show child attributes
Maximum string length:
200Show child attributes
Show child attributes
Available options:
review, hybrid, auto Required range:
50 <= x <= 100Deprecated: send submitMode instead. When submitMode is left out, true reads as auto, false as review.
The client whose data this is, for an operator applying on behalf of clients. Omit for your own.
Minimum string length:
1Response
200 - application/json
The saved apply profile.
Maximum string length:
64Maximum string length:
200Maximum string length:
500Maximum array length:
15Show child attributes
Show child attributes
Maximum string length:
200Maximum string length:
200Show child attributes
Show child attributes
Maximum string length:
500Maximum string length:
500Maximum string length:
500Maximum array length:
5Show child attributes
Show child attributes
Maximum string length:
200Show child attributes
Show child attributes
Maximum array length:
200Show child attributes
Show child attributes
Available options:
review, hybrid, auto Required range:
50 <= x <= 100