Sign in

v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB
Candidates

Create Candidate

post/unified/ats/candidates

Headers

x-account-idstring required

The account identifier

Preferstring
Example:heartbeat

Set to "heartbeat" to enable keep-alive newline heartbeats during long-running requests. Response includes Preference-Applied: heartbeat header when honored. (RFC 7240)

Request body

passthroughobject nullable

Value to pass through to the provider

unified_custom_fieldsobject nullable

Custom Unified Fields configured in your StackOne project

phone_numberstring nullable

The candidate personal phone number

namestring nullable

Candidate name

first_namestring nullable

Candidate first name

last_namestring nullable

Candidate last name

emailstring nullable

Candidate email

companystring nullable

Candidate company

titlestring nullable

Candidate title

hired_atstring date-time nullable

Candidate hired date

countrystring nullable

Candidate country

Example request

{
  "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": "+1234567890",
  "phone_numbers": [
    {
      "phone": "+447700112233"
    }
  ],
  "name": "Romain Sestier",
  "first_name": "Romain",
  "last_name": "Sestier",
  "email": "sestier.romain123@gmail.com",
  "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_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ]
}

Response

The candidate was successfully created.

statusCodenumber required
messagestring required
timestampstring date-time required

Example response

{
  "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"
  }
}