Create client contact
curl --request POST \
--url https://api.gospott.com/clients/contacts/{clientId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"nationality": [],
"status": [],
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"phoneNumber": "<string>",
"isPrimary": true
}
],
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
}
],
"dateOfBirth": "2023-11-07T05:31:56Z",
"socialMedia": [
{
"url": "<string>",
"isPrimary": true
}
],
"education": [
{
"fieldOfStudy": "<string>",
"grade": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"workExperiences": [
{
"jobTitle": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
},
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"customAttributes": [
{
"attributeDefinitionId": "<string>",
"value": {
"viewType": "customText",
"text": "<string>"
}
}
],
"mainContact": {
"userId": "<string>"
},
"languages": [
{
"id": "<string>"
}
],
"compensation": {
"id": "<string>",
"totalCompensation": 123,
"baseCompensation": 123
},
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"stageId": "<string>",
"keepShowingAsCandidate": true
}
'import requests
url = "https://api.gospott.com/clients/contacts/{clientId}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"nationality": [],
"status": [],
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": True
}
],
"phoneNumbers": [
{
"phoneNumber": "<string>",
"isPrimary": True
}
],
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
}
],
"dateOfBirth": "2023-11-07T05:31:56Z",
"socialMedia": [
{
"url": "<string>",
"isPrimary": True
}
],
"education": [
{
"fieldOfStudy": "<string>",
"grade": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"workExperiences": [
{
"jobTitle": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
},
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"customAttributes": [
{
"attributeDefinitionId": "<string>",
"value": {
"viewType": "customText",
"text": "<string>"
}
}
],
"mainContact": { "userId": "<string>" },
"languages": [{ "id": "<string>" }],
"compensation": {
"id": "<string>",
"totalCompensation": 123,
"baseCompensation": 123
},
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"stageId": "<string>",
"keepShowingAsCandidate": 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>',
avatarUrl: '<string>',
nationality: [],
status: [],
emails: [{email: 'jsmith@example.com', isPrimary: true}],
phoneNumbers: [{phoneNumber: '<string>', isPrimary: true}],
locations: [
{
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0,
rawCityCountry: '<string>',
formattedAddress: '<string>'
}
],
dateOfBirth: '2023-11-07T05:31:56Z',
socialMedia: [{url: '<string>', isPrimary: true}],
education: [
{
fieldOfStudy: '<string>',
grade: '<string>',
description: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
companyId: '<string>'
}
],
workExperiences: [
{
jobTitle: '<string>',
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0,
rawCityCountry: '<string>',
formattedAddress: '<string>'
},
description: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
companyId: '<string>'
}
],
customAttributes: [
{
attributeDefinitionId: '<string>',
value: {viewType: 'customText', text: '<string>'}
}
],
mainContact: {userId: '<string>'},
languages: [{id: '<string>'}],
compensation: {id: '<string>', totalCompensation: 123, baseCompensation: 123},
role: '<string>',
department: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
stageId: '<string>',
keepShowingAsCandidate: true
})
};
fetch('https://api.gospott.com/clients/contacts/{clientId}', 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/clients/contacts/{clientId}",
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>',
'avatarUrl' => '<string>',
'nationality' => [
],
'status' => [
],
'emails' => [
[
'email' => 'jsmith@example.com',
'isPrimary' => true
]
],
'phoneNumbers' => [
[
'phoneNumber' => '<string>',
'isPrimary' => true
]
],
'locations' => [
[
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0,
'rawCityCountry' => '<string>',
'formattedAddress' => '<string>'
]
],
'dateOfBirth' => '2023-11-07T05:31:56Z',
'socialMedia' => [
[
'url' => '<string>',
'isPrimary' => true
]
],
'education' => [
[
'fieldOfStudy' => '<string>',
'grade' => '<string>',
'description' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'companyId' => '<string>'
]
],
'workExperiences' => [
[
'jobTitle' => '<string>',
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0,
'rawCityCountry' => '<string>',
'formattedAddress' => '<string>'
],
'description' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'companyId' => '<string>'
]
],
'customAttributes' => [
[
'attributeDefinitionId' => '<string>',
'value' => [
'viewType' => 'customText',
'text' => '<string>'
]
]
],
'mainContact' => [
'userId' => '<string>'
],
'languages' => [
[
'id' => '<string>'
]
],
'compensation' => [
'id' => '<string>',
'totalCompensation' => 123,
'baseCompensation' => 123
],
'role' => '<string>',
'department' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'stageId' => '<string>',
'keepShowingAsCandidate' => 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/clients/contacts/{clientId}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\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/clients/contacts/{clientId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/clients/contacts/{clientId}")
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 \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidateId": "<string>"
}{
"status": 0,
"message": "ONLY_ONE_PRIMARY_EMAIL_ALLOWED",
"requestId": "<string>",
"category": "MALFORMED_REQUEST",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 404,
"category": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"requestId": "<string>"
}{
"status": 409,
"category": "RESOURCE_ALREADY_EXISTS",
"message": "Resource already exists",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 500,
"category": "INTERNAL_ERROR",
"message": "Internal server error",
"requestId": "<string>"
}Client Contacts
Create client contact
Create a new client contact for a specific client and create the linked candidate record. Includes personal information such as name, emails, phone numbers, role, department, and custom attribute values, which are stored on the client contact.
POST
/
clients
/
contacts
/
{clientId}
Create client contact
curl --request POST \
--url https://api.gospott.com/clients/contacts/{clientId} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"nationality": [],
"status": [],
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": true
}
],
"phoneNumbers": [
{
"phoneNumber": "<string>",
"isPrimary": true
}
],
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
}
],
"dateOfBirth": "2023-11-07T05:31:56Z",
"socialMedia": [
{
"url": "<string>",
"isPrimary": true
}
],
"education": [
{
"fieldOfStudy": "<string>",
"grade": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"workExperiences": [
{
"jobTitle": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
},
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"customAttributes": [
{
"attributeDefinitionId": "<string>",
"value": {
"viewType": "customText",
"text": "<string>"
}
}
],
"mainContact": {
"userId": "<string>"
},
"languages": [
{
"id": "<string>"
}
],
"compensation": {
"id": "<string>",
"totalCompensation": 123,
"baseCompensation": 123
},
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"stageId": "<string>",
"keepShowingAsCandidate": true
}
'import requests
url = "https://api.gospott.com/clients/contacts/{clientId}"
payload = {
"firstName": "<string>",
"lastName": "<string>",
"avatarUrl": "<string>",
"nationality": [],
"status": [],
"emails": [
{
"email": "jsmith@example.com",
"isPrimary": True
}
],
"phoneNumbers": [
{
"phoneNumber": "<string>",
"isPrimary": True
}
],
"locations": [
{
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
}
],
"dateOfBirth": "2023-11-07T05:31:56Z",
"socialMedia": [
{
"url": "<string>",
"isPrimary": True
}
],
"education": [
{
"fieldOfStudy": "<string>",
"grade": "<string>",
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"workExperiences": [
{
"jobTitle": "<string>",
"location": {
"street1": "<string>",
"street2": "<string>",
"postalCode": "<string>",
"city": "<string>",
"region": "<string>",
"state": "<string>",
"country": "<string>",
"latitude": 0,
"longitude": 0,
"rawCityCountry": "<string>",
"formattedAddress": "<string>"
},
"description": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"companyId": "<string>"
}
],
"customAttributes": [
{
"attributeDefinitionId": "<string>",
"value": {
"viewType": "customText",
"text": "<string>"
}
}
],
"mainContact": { "userId": "<string>" },
"languages": [{ "id": "<string>" }],
"compensation": {
"id": "<string>",
"totalCompensation": 123,
"baseCompensation": 123
},
"role": "<string>",
"department": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"endDate": "2023-11-07T05:31:56Z",
"stageId": "<string>",
"keepShowingAsCandidate": 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>',
avatarUrl: '<string>',
nationality: [],
status: [],
emails: [{email: 'jsmith@example.com', isPrimary: true}],
phoneNumbers: [{phoneNumber: '<string>', isPrimary: true}],
locations: [
{
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0,
rawCityCountry: '<string>',
formattedAddress: '<string>'
}
],
dateOfBirth: '2023-11-07T05:31:56Z',
socialMedia: [{url: '<string>', isPrimary: true}],
education: [
{
fieldOfStudy: '<string>',
grade: '<string>',
description: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
companyId: '<string>'
}
],
workExperiences: [
{
jobTitle: '<string>',
location: {
street1: '<string>',
street2: '<string>',
postalCode: '<string>',
city: '<string>',
region: '<string>',
state: '<string>',
country: '<string>',
latitude: 0,
longitude: 0,
rawCityCountry: '<string>',
formattedAddress: '<string>'
},
description: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
companyId: '<string>'
}
],
customAttributes: [
{
attributeDefinitionId: '<string>',
value: {viewType: 'customText', text: '<string>'}
}
],
mainContact: {userId: '<string>'},
languages: [{id: '<string>'}],
compensation: {id: '<string>', totalCompensation: 123, baseCompensation: 123},
role: '<string>',
department: '<string>',
startDate: '2023-11-07T05:31:56Z',
endDate: '2023-11-07T05:31:56Z',
stageId: '<string>',
keepShowingAsCandidate: true
})
};
fetch('https://api.gospott.com/clients/contacts/{clientId}', 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/clients/contacts/{clientId}",
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>',
'avatarUrl' => '<string>',
'nationality' => [
],
'status' => [
],
'emails' => [
[
'email' => 'jsmith@example.com',
'isPrimary' => true
]
],
'phoneNumbers' => [
[
'phoneNumber' => '<string>',
'isPrimary' => true
]
],
'locations' => [
[
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0,
'rawCityCountry' => '<string>',
'formattedAddress' => '<string>'
]
],
'dateOfBirth' => '2023-11-07T05:31:56Z',
'socialMedia' => [
[
'url' => '<string>',
'isPrimary' => true
]
],
'education' => [
[
'fieldOfStudy' => '<string>',
'grade' => '<string>',
'description' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'companyId' => '<string>'
]
],
'workExperiences' => [
[
'jobTitle' => '<string>',
'location' => [
'street1' => '<string>',
'street2' => '<string>',
'postalCode' => '<string>',
'city' => '<string>',
'region' => '<string>',
'state' => '<string>',
'country' => '<string>',
'latitude' => 0,
'longitude' => 0,
'rawCityCountry' => '<string>',
'formattedAddress' => '<string>'
],
'description' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'companyId' => '<string>'
]
],
'customAttributes' => [
[
'attributeDefinitionId' => '<string>',
'value' => [
'viewType' => 'customText',
'text' => '<string>'
]
]
],
'mainContact' => [
'userId' => '<string>'
],
'languages' => [
[
'id' => '<string>'
]
],
'compensation' => [
'id' => '<string>',
'totalCompensation' => 123,
'baseCompensation' => 123
],
'role' => '<string>',
'department' => '<string>',
'startDate' => '2023-11-07T05:31:56Z',
'endDate' => '2023-11-07T05:31:56Z',
'stageId' => '<string>',
'keepShowingAsCandidate' => 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/clients/contacts/{clientId}"
payload := strings.NewReader("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\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/clients/contacts/{clientId}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\",\n \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gospott.com/clients/contacts/{clientId}")
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 \"avatarUrl\": \"<string>\",\n \"nationality\": [],\n \"status\": [],\n \"emails\": [\n {\n \"email\": \"jsmith@example.com\",\n \"isPrimary\": true\n }\n ],\n \"phoneNumbers\": [\n {\n \"phoneNumber\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"locations\": [\n {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n }\n ],\n \"dateOfBirth\": \"2023-11-07T05:31:56Z\",\n \"socialMedia\": [\n {\n \"url\": \"<string>\",\n \"isPrimary\": true\n }\n ],\n \"education\": [\n {\n \"fieldOfStudy\": \"<string>\",\n \"grade\": \"<string>\",\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"workExperiences\": [\n {\n \"jobTitle\": \"<string>\",\n \"location\": {\n \"street1\": \"<string>\",\n \"street2\": \"<string>\",\n \"postalCode\": \"<string>\",\n \"city\": \"<string>\",\n \"region\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"rawCityCountry\": \"<string>\",\n \"formattedAddress\": \"<string>\"\n },\n \"description\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"companyId\": \"<string>\"\n }\n ],\n \"customAttributes\": [\n {\n \"attributeDefinitionId\": \"<string>\",\n \"value\": {\n \"viewType\": \"customText\",\n \"text\": \"<string>\"\n }\n }\n ],\n \"mainContact\": {\n \"userId\": \"<string>\"\n },\n \"languages\": [\n {\n \"id\": \"<string>\"\n }\n ],\n \"compensation\": {\n \"id\": \"<string>\",\n \"totalCompensation\": 123,\n \"baseCompensation\": 123\n },\n \"role\": \"<string>\",\n \"department\": \"<string>\",\n \"startDate\": \"2023-11-07T05:31:56Z\",\n \"endDate\": \"2023-11-07T05:31:56Z\",\n \"stageId\": \"<string>\",\n \"keepShowingAsCandidate\": true\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidateId": "<string>"
}{
"status": 0,
"message": "ONLY_ONE_PRIMARY_EMAIL_ALLOWED",
"requestId": "<string>",
"category": "MALFORMED_REQUEST",
"statusCode": 400,
"error": "Bad Request"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 404,
"category": "RESOURCE_NOT_FOUND",
"message": "Resource not found",
"requestId": "<string>"
}{
"status": 409,
"category": "RESOURCE_ALREADY_EXISTS",
"message": "Resource already exists",
"requestId": "<string>"
}{
"status": 0,
"message": "<string>",
"requestId": "<string>",
"category": "MALFORMED_REQUEST"
}{
"status": 500,
"category": "INTERNAL_ERROR",
"message": "Internal server error",
"requestId": "<string>"
}Authorizations
API key for authentication. Get your API key from Settings → API Keys in your Spott dashboard.
Path Parameters
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} '’.-]+$Minimum string length:
1Available options:
male, female, x Maximum array length:
50Available options:
Afghan, Albanian, Algerian, American, Andorran, Angolan, Antiguan, Argentinean, Armenian, Australian, Austrian, Azerbaijani, Bahamian, Bahraini, Bangladeshi, Barbadian, Barbudan, Batswana, Belarusian, Belgian, Belizean, Beninese, Bhutanese, Bolivian, Bosnian, Brazilian, British, Bruneian, Bulgarian, Burkinabe, Burmese, Burundian, Cambodian, Cameroonian, Canadian, Cape Verdean, Central African, Chadian, Chilean, Chinese, Colombian, Comoran, Congolese, Costa Rican, Croatian, Cuban, Cypriot, Czech, Danish, Djibouti, Dominican, Dutch, East Timorese, Ecuadorean, Egyptian, Emirian, Equatorial Guinean, Eritrean, Estonian, Ethiopian, Fijian, Filipino, Finnish, French, Gabonese, Gambian, Georgian, German, Ghanaian, Greek, Grenadian, Guatemalan, Guinea-Bissauan, Guinean, Guyanese, Haitian, Herzegovinian, Honduran, Hungarian, I-Kiribati, Icelander, Indian, Indonesian, Iranian, Iraqi, Irish, Israeli, Italian, Ivorian, Jamaican, Japanese, Jordanian, Kazakhstani, Kenyan, Kittian and Nevisian, Kosovar, Kuwaiti, Kyrgyz, Laotian, Latvian, Lebanese, Liberian, Libyan, Liechtensteiner, Lithuanian, Luxembourger, Macedonian, Malagasy, Malawian, Malaysian, Maldivian, Malian, Maltese, Marshallese, Mauritanian, Mauritian, Mexican, Micronesian, Moldovan, Monacan, Mongolian, Moroccan, Mosotho, Motswana, Mozambican, Namibian, Nauruan, Nepalese, New Zealander, Ni-Vanuatu, Nicaraguan, Nigerian, Nigerien, North Korean, Northern Irish, Norwegian, Omani, Pakistani, Palauan, Palestinian, Panamanian, Papua New Guinean, Paraguayan, Peruvian, Polish, Portuguese, Qatari, Romanian, Russian, Rwandan, Saint Lucian, Salvadoran, Samoan, San Marinese, Sao Tomean, Saudi, Scottish, Senegalese, Serbian, Seychellois, Sierra Leonean, Singaporean, Slovakian, Slovenian, Solomon Islander, Somali, South African, South Korean, Spanish, Sri Lankan, Sudanese, Surinamer, Swazi, Swedish, Swiss, Syrian, Taiwanese, Tajik, Tanzanian, Thai, Togolese, Tongan, Trinidadian or Tobagonian, Tunisian, Turkish, Turkmenistani, Tuvaluan, Ugandan, Ukrainian, Uruguayan, Uzbekistani, Venezuelan, Vietnamese, Welsh, Yemenite, Zambian, Zimbabwean Maximum array length:
50Available options:
actively_looking, approachable_but_not_actively_looking, do_not_contact, do_not_poach, not_actively_looking Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Maximum array length:
50Show child attributes
Show child attributes
Maximum array length:
100- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum array length:
100- Option 1
- Option 2
Show child attributes
Show child attributes
Maximum array length:
100Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum array length:
50Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Pattern:
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Was this page helpful?