Create Candidate

POST /unified/ats/candidates

Create Candidate

cURL

curl --request POST \
  --url https://api.stackone.com/unified/ats/candidates \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "unified_custom_fields": {
    "my_project_custom_field_1": "REF-1236",
    "my_project_custom_field_2": "some other value"
  },
  "phone_number": "[phone]",
  "phone_numbers": [
    {
      "type": "personal",
      "phone": "[phone]"
    }
  ],
  "name": "Romain Sestier",
  "first_name": "Romain",
  "last_name": "Sestier",
  "email": "[e-mail]",
  "social_links": [
    {
      "type": "linkedin",
      "url": "https://www.linkedin.com/in/romainsestier/"
    }
  ],
  "company": "Company Inc.",
  "title": "Software Engineer",
  "hired_at": "2021-01-01T01:01:01.000Z",
  "country": "United States",
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ]
}
'

201

{
  "statusCode": 201,
  "message": "Record created successfully.",
  "timestamp": "2021-01-01T01:01:01.000Z",
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3"
  }
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id · string · required

The account identifier

Body

application/json

passthrough · object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

unified_custom_fields · object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

phone_number · string | null · deprecated

The candidate personal phone number

Example:

"[phone]"

phone_numbers · object[] | null

List of candidate phone numbers including the type of the number when available

Show child attributes

name · string | null

Candidate name

Example:

"Romain Sestier"

first_name · string | null

Candidate first name

Example:

"Romain"

last_name · string | null

Candidate last name

Example:

"Sestier"

email · string | null

Candidate email

Example:

"[e-mail]"

social_links · object[] | null

List of candidate social links

Show child attributes

company · string | null

Candidate company

Example:

"Company Inc."

title · string | null

Candidate title

Example:

"Software Engineer"

hired_at · string<date-time> | null

Candidate hired date

Example:

"2021-01-01T01:01:01.000Z"

country · string | null

Candidate country

Example:

"United States"

custom_fields · object[] | null

The candidate custom fields

Show child attributes

Response

201

application/json

The candidate was successfully created.

statusCode · number · required

Example:

201

message · string · required

Example:

"Record created successfully."

timestamp · string<date-time> · required

Example:

"2021-01-01T01:01:01.000Z"

data · object · required

Show child attributes