v1

latestOpenAPI 3.1.02026-07-1276185442.2 KB

Applications

Create Application

post/unified/ats/applications

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

job_idstring nullable

Unique identifier of the job

job_posting_idstring nullable

Unique identifier of the job posting that is associated with application

location_idstring nullable

Unique identifier of the location

candidate_idstring nullable

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

Example request

{
  "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"
  },
  "questionnaires": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "answers": [
        {
          "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
          "type": {
            "value": "short_text"
          },
          "values": [
            "Yes",
            "No Travel",
            "It sounds pretty cool.",
            "Excel",
            "Power Point"
          ]
        }
      ]
    }
  ],
  "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": [
      {
        "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"
      }
    ]
  },
  "documents": [
    {
      "name": "weather-forecast",
      "file_format": {
        "value": "pdf"
      },
      "content": "VGhpcyBpc24ndCByZWFsbHkgYSBzYW1wbGUgZmlsZSwgYnV0IG5vIG9uZSB3aWxsIGV2ZXIga25vdyE",
      "category_id": "6530",
      "path": "/path/to/file",
      "confidential": {
        "value": "true"
      },
      "category": {
        "value": "resume",
        "source_value": "550e8400-e29b-41d4-a716-446655440000"
      }
    }
  ]
}

Response

The application was created successfully.

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