Create candidate
curl --request POST \
--url https://api.gospott.com/candidate-portal/open-application \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"cvAttachmentId": "<string>",
"email": {
"email": "jsmith@example.com",
"isPrimary": true
},
"phoneNumber": {
"phoneNumber": "<string>",
"isPrimary": true
}
}
'import requests
url = "https://api.gospott.com/candidate-portal/open-application"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"cvAttachmentId": "<string>",
"email": {
"email": "jsmith@example.com",
"isPrimary": True
},
"phoneNumber": {
"phoneNumber": "<string>",
"isPrimary": True
}
}
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({
firstName: '<string>',
lastName: '<string>',
cvAttachmentId: '<string>',
email: {email: 'jsmith@example.com', isPrimary: true},
phoneNumber: {phoneNumber: '<string>', isPrimary: true}
})
};
fetch('https://api.gospott.com/candidate-portal/open-application', 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.gospott.com/candidate-portal/open-application",
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>',
'cvAttachmentId' => '<string>',
'email' => [
'email' => 'jsmith@example.com',
'isPrimary' => true
],
'phoneNumber' => [
'phoneNumber' => '<string>',
'isPrimary' => true
]
]),
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.gospott.com/candidate-portal/open-application"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\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.gospott.com/candidate-portal/open-application")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidate-portal/open-application")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "Invalid email format",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Candidate Portal
Create candidate
Create a new candidate from CV and form details. Used by the candidate portal when a candidate submits their application.
POST
/
candidate-portal
/
open-application
Create candidate
curl --request POST \
--url https://api.gospott.com/candidate-portal/open-application \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"cvAttachmentId": "<string>",
"email": {
"email": "jsmith@example.com",
"isPrimary": true
},
"phoneNumber": {
"phoneNumber": "<string>",
"isPrimary": true
}
}
'import requests
url = "https://api.gospott.com/candidate-portal/open-application"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"cvAttachmentId": "<string>",
"email": {
"email": "jsmith@example.com",
"isPrimary": True
},
"phoneNumber": {
"phoneNumber": "<string>",
"isPrimary": True
}
}
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({
firstName: '<string>',
lastName: '<string>',
cvAttachmentId: '<string>',
email: {email: 'jsmith@example.com', isPrimary: true},
phoneNumber: {phoneNumber: '<string>', isPrimary: true}
})
};
fetch('https://api.gospott.com/candidate-portal/open-application', 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.gospott.com/candidate-portal/open-application",
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>',
'cvAttachmentId' => '<string>',
'email' => [
'email' => 'jsmith@example.com',
'isPrimary' => true
],
'phoneNumber' => [
'phoneNumber' => '<string>',
'isPrimary' => true
]
]),
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.gospott.com/candidate-portal/open-application"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\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.gospott.com/candidate-portal/open-application")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/candidate-portal/open-application")
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 \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"cvAttachmentId\": \"<string>\",\n \"email\": {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n },\n \"phoneNumber\": {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n}"
response = http.request(request)
puts response.read_body{
"status": 0,
"message": "Invalid email format",
"requestId": "<string>",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Body
application/json
Required string length:
1 - 100Pattern:
^(?=.*\p{L})[\p{L}\p{M} '’.-]+$Required string length:
1 - 100Pattern:
^(?=.*\p{L})[\p{L}\p{M} '’.-]+$Required string length:
1 - 100Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Response
Candidate created successfully
Was this page helpful?
⌘I

