Skip to main content
POST
/
recruitment
/
v1
/
candidates
Create a candidate
curl --request POST \
  --url https://api-{region}.sesametime.com/recruitment/v1/candidates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "firstName": "<string>",
  "lastName": "<string>",
  "phone": "<string>",
  "email": "jsmith@example.com",
  "linkedInURL": "<string>",
  "desiredSalary": "<string>",
  "startWorkDate": "2025-12-01",
  "web": "<string>",
  "location": "<string>",
  "vacancyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "address": "<string>",
  "comment": "<string>",
  "referralName": "<string>",
  "acceptPool": false,
  "checkPolicyPrivacy": false,
  "appliedAt": "2025-12-01"
}
'
import requests

url = "https://api-{region}.sesametime.com/recruitment/v1/candidates"

payload = {
    "firstName": "<string>",
    "lastName": "<string>",
    "phone": "<string>",
    "email": "jsmith@example.com",
    "linkedInURL": "<string>",
    "desiredSalary": "<string>",
    "startWorkDate": "2025-12-01",
    "web": "<string>",
    "location": "<string>",
    "vacancyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "address": "<string>",
    "comment": "<string>",
    "referralName": "<string>",
    "acceptPool": False,
    "checkPolicyPrivacy": False,
    "appliedAt": "2025-12-01"
}
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>',
    phone: '<string>',
    email: 'jsmith@example.com',
    linkedInURL: '<string>',
    desiredSalary: '<string>',
    startWorkDate: '2025-12-01',
    web: '<string>',
    location: '<string>',
    vacancyId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    statusId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    address: '<string>',
    comment: '<string>',
    referralName: '<string>',
    acceptPool: false,
    checkPolicyPrivacy: false,
    appliedAt: '2025-12-01'
  })
};

fetch('https://api-{region}.sesametime.com/recruitment/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://api-{region}.sesametime.com/recruitment/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>',
    'phone' => '<string>',
    'email' => 'jsmith@example.com',
    'linkedInURL' => '<string>',
    'desiredSalary' => '<string>',
    'startWorkDate' => '2025-12-01',
    'web' => '<string>',
    'location' => '<string>',
    'vacancyId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'statusId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'address' => '<string>',
    'comment' => '<string>',
    'referralName' => '<string>',
    'acceptPool' => false,
    'checkPolicyPrivacy' => false,
    'appliedAt' => '2025-12-01'
  ]),
  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://api-{region}.sesametime.com/recruitment/v1/candidates"

	payload := strings.NewReader("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"linkedInURL\": \"<string>\",\n  \"desiredSalary\": \"<string>\",\n  \"startWorkDate\": \"2025-12-01\",\n  \"web\": \"<string>\",\n  \"location\": \"<string>\",\n  \"vacancyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statusId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"address\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"referralName\": \"<string>\",\n  \"acceptPool\": false,\n  \"checkPolicyPrivacy\": false,\n  \"appliedAt\": \"2025-12-01\"\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://api-{region}.sesametime.com/recruitment/v1/candidates")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"firstName\": \"<string>\",\n  \"lastName\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"linkedInURL\": \"<string>\",\n  \"desiredSalary\": \"<string>\",\n  \"startWorkDate\": \"2025-12-01\",\n  \"web\": \"<string>\",\n  \"location\": \"<string>\",\n  \"vacancyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statusId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"address\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"referralName\": \"<string>\",\n  \"acceptPool\": false,\n  \"checkPolicyPrivacy\": false,\n  \"appliedAt\": \"2025-12-01\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api-{region}.sesametime.com/recruitment/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  \"phone\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"linkedInURL\": \"<string>\",\n  \"desiredSalary\": \"<string>\",\n  \"startWorkDate\": \"2025-12-01\",\n  \"web\": \"<string>\",\n  \"location\": \"<string>\",\n  \"vacancyId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"statusId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"address\": \"<string>\",\n  \"comment\": \"<string>\",\n  \"referralName\": \"<string>\",\n  \"acceptPool\": false,\n  \"checkPolicyPrivacy\": false,\n  \"appliedAt\": \"2025-12-01\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "vacancy": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "description": "<string>",
      "contractType": "<string>",
      "experience": "<string>",
      "createdById": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "openedAt": "2020-01-01T10:00:00+01:00",
      "createdAt": "2020-01-01T10:00:00+01:00",
      "updatedAt": "2020-01-01T10:00:00+01:00",
      "public": true,
      "locationVacancy": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "createdAt": "2020-01-01T10:00:00+01:00"
      },
      "scheduleType": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "createdAt": "2020-01-01T10:00:00+01:00"
      },
      "category": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "createdAt": "2020-01-01T10:00:00+01:00"
      },
      "officeIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "departmentIds": [
        "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      ],
      "evaluationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "vacancyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "type": "<string>",
    "statusId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "status": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "order": 123,
      "createdAt": "2020-01-01T10:00:00+01:00",
      "updatedAt": "2020-01-01T10:00:00+01:00",
      "vacancyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "linkedInURL": "<string>",
    "desiredSalary": "<string>",
    "startWorkDate": "2020-01-01T10:00:00+01:00",
    "evaluation": 123,
    "web": "<string>",
    "location": "<string>",
    "hasDocument": true,
    "comment": "<string>",
    "appliedAt": "2020-01-01T10:00:00+01:00",
    "threadId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "lastComment": {},
    "numComments": 123,
    "imageProfileURL": "<string>",
    "checklist": {},
    "createdAt": "2020-01-01T10:00:00+01:00",
    "updatedAt": "2020-01-01T10:00:00+01:00",
    "employeeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "acceptPool": true,
    "checkPolicyPrivacy": true
  },
  "meta": {
    "currentPage": 1,
    "lastPage": 1,
    "total": 1,
    "perPage": 1
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Candidate object that needs to be created

​
firstName
string
required

The first name of the candidate

​
lastName
string
required

The last name of the candidate

​
phone
string
required

The phone number of the candidate

​
email
string<email>
​
linkedInURL
string

The LinkedIn URL of the candidate

​
desiredSalary
string

The desired salary of the candidate

​
startWorkDate
string<date>

The start work date of the candidate

Example:

"2025-12-01"

​
web
string

The web of the candidate

​
location
string

The location of the candidate

​
vacancyId
string<uuid>

The identifier of the vacancy where the candidate will be added

​
statusId
string<uuid>

The identifier of the status of the candidate

​
address
string

The address of the candidate

​
comment
string

The description of the candidate

​
gender
enum<string>

The gender of the candidate

Available options:
male,
female,
non_binary_gender,
no_response
​
referralSource
enum<string>

The referral source of the candidate

Available options:
customer,
employee,
friendEmployee,
other,
socialMedia
​
referralName
string

The name of the person who referred the candidate

​
acceptPool
boolean
default:false

Whether the candidate accepts to be in the pool

​
checkPolicyPrivacy
boolean
default:false

Whether the candidate has accepted the privacy policy

​
appliedAt
string<date>

The date of the application

Example:

"2025-12-01"

Response

200 - application/json

Object

​
data
object
​
meta
object