v1

latestOpenAPI 3.0.0Apache 2.02026-07-131565161.1 KB

Jobs

Update Job

patch/ats/jobs/{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.

slugstring nullable

titlestring nullable

The job title of the person.

sequenceinteger

Sequence in relation to other jobs.

visibility'draft' | 'public' | 'internal'

The visibility of the job

The status of the job.

codestring

The code of the job.

languagestring nullable

language code according to ISO 639-1. For the United States - EN

experiencestring

Level of experience required for the job role.

locationstring nullable

Specifies the location for the job posting.

remoteboolean nullable

Specifies whether the posting is for a remote job.

requisition_idstring

A job's Requisition ID (Req ID) allows your organization to identify and track a job based on alphanumeric naming conventions unique to your company's internal processes.

recruitersstring[] nullable

The recruiter is generally someone who is tasked to help the hiring manager find and screen qualified applicant

hiring_managersstring[]

followersstring[] nullable

descriptionstring nullable

A description of the object.

description_htmlstring nullable

The job description in HTML format

closingstring nullable

closing_htmlstring nullable

The closing section of the job description in HTML format

closing_datestring date nullable

urlstring nullable

URL of the job description

job_portal_urlstring nullable

URL of the job portal

record_urlstring nullable

confidentialboolean

available_to_employeesboolean

Specifies whether an employee of the organization can apply for the job.

tagsstring[] nullable

deletedboolean nullable

Flag to indicate if the object is deleted.

owner_idstring nullable

published_atstring date-time nullable

custom_mappingsCustomMappings nullable

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

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",
  "slug": "ceo",
  "title": "CEO",
  "sequence": 3,
  "visibility": "internal",
  "status": "completed",
  "code": "123-OC",
  "language": "EN",
  "employment_terms": "full-time",
  "experience": "Director/ Vice President",
  "location": "San Francisco",
  "remote": true,
  "requisition_id": "abc123",
  "department": {
    "id": "12345",
    "parent_id": "22345",
    "name": "R&D",
    "code": "2",
    "description": "R&D",
    "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"
              }
            }
          }
        ]
      }
    ]
  },
  "branch": {
    "id": "123",
    "name": "HQ NY"
  },
  "recruiters": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4"
  ],
  "hiring_managers": [
    "123456"
  ],
  "followers": [
    "a0d636c6-43b3-4bde-8c70-85b707d992f4",
    "a98lfd96-43b3-4bde-8c70-85b707d992e6"
  ],
  "description": "A description",
  "blocks": [
    {
      "title": "string",
      "content": "string"
    }
  ],
  "closing": "The closing section of the job description",
  "closing_date": "2020-10-30",
  "salary": {
    "min": 8000,
    "max": 10000,
    "currency": "USD",
    "interval": "year"
  },
  "record_url": "https://app.intercom.io/contacts/12345",
  "links": [
    {
      "type": "job_portal",
      "url": "https://app.intercom.io/contacts/12345"
    }
  ],
  "tags": [
    "New"
  ],
  "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"
    }
  ],
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "deleted": true,
  "owner_id": "54321",
  "published_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"
}

Response

Jobs

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": "sage-hr",
  "resource": "Jobs",
  "operation": "update",
  "data": {
    "id": "12345"
  }
}