v1

latestOpenAPI 3.0.0Apache 2.02026-07-131565161.1 KB

Applicants

Update Applicant

patch/ats/applicants/{id}

Path parameters

idstring required

ID of the record you are acting upon.

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

A unique identifier for an object.

namestring

The name of an applicant.

salutationstring nullable

A formal salutation for the person. For example, 'Mr', 'Mrs'

first_namestring nullable

The first name of the person.

last_namestring nullable

The last name of the person.

middle_namestring nullable

Middle name of the person.

initialsstring nullable

The initials of the person, usually derived from their first, middle, and last names.

birthdaystring date nullable

The date of birth of the person.

gender'male' | 'female' | 'unisex' | 'other' | 'not_specified' nullable

The gender represents the gender identity of a person.

social_security_numberstring nullable

A unique identifier assigned by the government. This field is considered sensitive information and may be subject to special security and privacy restrictions.

typestring

cover_letterstring

job_urlstring nullable

photo_urlstring nullable

The URL of the photo of a person.

headlinestring

Typically a list of previous companies where the contact has worked or schools that the contact has attended

titlestring nullable

The job title of the person.

stage_idstring

recruiter_idstring

coordinator_idstring

application_idsstring[] nullable

applicationsstring[] nullable

Deprecated: Use application_ids instead. Array of application IDs associated with the applicant.

followersstring[] nullable

sourcesstring[] nullable

source_idstring

confidentialboolean

anonymizedboolean

tagsstring[] nullable

archivedboolean nullable

last_interaction_atstring date-time nullable

owner_idstring nullable

sourced_bystring nullable

cv_urlstring

record_urlstring nullable

rejected_atstring date-time nullable

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

deletedboolean nullable

Flag to indicate if the object is deleted.

deleted_bystring nullable

The user who deleted the object.

deleted_atstring date-time nullable

The time at which the object was deleted.

updated_bystring nullable

The user who last updated the object.

created_bystring nullable

The user who created the object.

updated_atstring date-time nullable

The date and time when the object was last updated.

created_atstring date-time nullable

The date and time when the object was created.

Example request

{
  "id": "12345",
  "name": "Elon Musk",
  "salutation": "Mr",
  "first_name": "Elon",
  "last_name": "Musk",
  "middle_name": "D.",
  "initials": "EM",
  "birthday": "2000-08-12",
  "gender": "male",
  "social_security_number": "123456789",
  "type": "Candidate",
  "cover_letter": "I submit this application to express my sincere interest in the API developer position. In the previous role, I was responsible for leadership and ...",
  "job_url": "https://democompany.recruitee.com/o/example-talent-pool",
  "photo_url": "https://unavatar.io/elon-musk",
  "headline": "PepsiCo, Inc, Central Perk",
  "title": "CEO",
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "stage_id": "12345",
  "recruiter_id": "12345",
  "coordinator_id": "12345",
  "application_ids": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4",
    "a98lfd96-43b3-4bde-8c70-85b707d992e6"
  ],
  "applications": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4",
    "a98lfd96-43b3-4bde-8c70-85b707d992e6"
  ],
  "followers": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4",
    "a98lfd96-43b3-4bde-8c70-85b707d992e6"
  ],
  "sources": [
    "Job site"
  ],
  "source_id": "12345",
  "anonymized": true,
  "tags": [
    "New"
  ],
  "last_interaction_at": "2020-09-30T07:43:32.000Z",
  "owner_id": "54321",
  "sourced_by": "12345",
  "cv_url": "https://files.example.com/candidates/36615291/cv.pdf",
  "record_url": "https://app.intercom.io/contacts/12345",
  "rejected_at": "2020-09-30T07:43:32.000Z",
  "deleted": true,
  "deleted_by": "12345",
  "deleted_at": "2020-09-30T07:43:32.000Z",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Applicants

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "lever",
  "resource": "Applicants",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}