ats
job
patch/ats/{connection_id}/job/{id}

Request

  • Base URL: https://api.unified.to
  • URL: https://api.unified.to/ats/{connection_id}/job/{id}
  • Auth: API key in header authorization

Path parameters

connection_idstring required

ID of the connection

idstring required

ID of the Job

Query parameters

fieldsstring[]

Fields to return

rawstring

Raw parameters to include in the 3rd-party request. Encoded as a URL component. eg. raw parameters: foo=bar&zoo=bar -> raw=foo%3Dbar%26zoo%3Dbar

Request body

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
recruiter_idsstring[]
hiring_manager_idsstring[]
status'ARCHIVED' | 'PENDING' | 'DRAFT' | 'OPEN' | 'CLOSED'
closed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

employment_type'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
remoteboolean
language_localestring

Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)

public_job_urlsstring[]

URLs for pages containing public listings for the job

number_of_openingsnumber

Number of openings for the job

company_idstring

id value of the company associated with the job in the ATS (reference to AtsCompany)

minimum_experience_yearsnumber
minimum_degreestring
skillsstring[]
user_idstring

User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)

industrystring
summarystring

Short job blurb (distinct from full description when both exist)

rawobject

Response

Successful

idstring
created_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

updated_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

namestring
descriptionstring
recruiter_idsstring[]
hiring_manager_idsstring[]
status'ARCHIVED' | 'PENDING' | 'DRAFT' | 'OPEN' | 'CLOSED'
closed_atstring date-time

(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)

employment_type'FULL_TIME' | 'PART_TIME' | 'CONTRACTOR' | 'INTERN' | 'CONSULTANT' | 'VOLUNTEER' | 'CASUAL' | 'SEASONAL' | 'FREELANCE' | 'OTHER'
remoteboolean
language_localestring

Preferred language for the job, in ISO 639-1 format (e.g., U.S. English is en-us)

public_job_urlsstring[]

URLs for pages containing public listings for the job

number_of_openingsnumber

Number of openings for the job

company_idstring

id value of the company associated with the job in the ATS (reference to AtsCompany)

minimum_experience_yearsnumber
minimum_degreestring
skillsstring[]
user_idstring

User id of the job owner in the ATS (references an HRIS employee) (reference to HrisEmployee)

industrystring
summarystring

Short job blurb (distinct from full description when both exist)

rawobject

Changes

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the new optional request property

    • info

      added the enum value summary to the property items/ of the query request parameter fields

    • info

      added the optional property to the response with the status