Skip to main content
POST
/
unified
/
ats
/
applications
Create Application
curl --request POST \
  --url https://api.stackone.com/unified/ats/applications \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "passthrough": {
    "other_known_names": "John Doe"
  },
  "job_id": "4071538b-3cac-4fbf-ac76-f78ed250ffdd",
  "job_posting_id": "1c702a20-8de8-4d03-ac18-cbf4ac42eb51",
  "location_id": "dd8d41d1-5eb8-4408-9c87-9ba44604eae4",
  "application_status": {
    "value": "hired",
    "source_value": "Hired"
  },
  "questionnaires": {
    "id": "right_to_work",
    "answers": [
      {
        "id": "answer1",
        "type": "text",
        "values": [
          "Yes"
        ]
      }
    ]
  },
  "source": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "name": "LinkedIn"
  },
  "candidate_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "candidate": {
    "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": [
      {
        "type": "personal",
        "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": "Completed",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ]
  },
  "documents": [
    {
      "name": "weather-forecast",
      "file_format": {
        "value": "pdf",
        "source_value": "application/pdf"
      },
      "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
      "category_id": "6530",
      "path": "/path/to/file",
      "confidential": {
        "value": "true",
        "source_value": "public"
      },
      "category": {
        "name": "resume",
        "id": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  ]
}
'
{
  "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

​
Prefer
string

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

Example:

"heartbeat"

Body

application/json
​
passthrough
object

Value to pass through to the provider

Example:
{ "other_known_names": "John Doe" }
​
job_id
string | null

Unique identifier of the job

Example:

"4071538b-3cac-4fbf-ac76-f78ed250ffdd"

​
job_posting_id
string | null

Unique identifier of the job posting that is associated with application

Example:

"1c702a20-8de8-4d03-ac18-cbf4ac42eb51"

​
location_id
string | null

Unique identifier of the location

Example:

"dd8d41d1-5eb8-4408-9c87-9ba44604eae4"

​
application_status
object
​
questionnaires
object[] | null

Questionnaires associated with the application

Example:
{
  "id": "right_to_work",
  "answers": [
    {
      "id": "answer1",
      "type": "text",
      "values": ["Yes"]
    }
  ]
}
​
source
object
​
candidate_id
string | null

Unique identifier of the candidate. Provide this OR candidate, but not both.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

​
candidate
object

Candidate Properties. Provide this OR candidate_id, but not both. Providing this attempts to create a new candidate with the application.

​
documents
object[] | null

Document Properties. Providing this attempts to upload files with the application.

Response

The application was created successfully.

​
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