Sign in

v1

latestOpenAPI 3.1.02026-07-26549156879.0 KB
Ats > JobPosting

Updates a Job posting

Update a job posting.

put/api/2026-07-01/resources/ats/job_postings/{id}

Path parameters

idstring required

Request body

idstring required
titlestring
descriptionstring
contract_type'indefinite' | 'temporary' | 'intern' | 'training' | 'freelance' | 'vendor_contractor' | 'volunteer' | 'per_hour' | 'other' | 'alternant' | 'interim' | 'minijob' | 'werkstudent' | 'apprenticeship' | 'pj' | 'clt' | 'jovem_aprendiz' | 'a_termo_incerto' | 'a_termo_certo' | 'de_curta_duracao' | 'de_muita_curta_duracao' | 'promessa_de_trabalho' | 'a_tempo_parcial' | 'com_pluralidade_de_empregadores' | 'teletrabalho' | 'pre_reforma' | 'recibos_verdes' | 'estagio' | 'sem_termo' | 'apprentissage' | 'fixed_discontinued' | 'apprendistato'
category'administration_and_secretariat' | 'design_and_architecture' | 'education_and_social_policy' | 'engineering' | 'finance' | 'hr' | 'it' | 'legal' | 'management_and_consulting' | 'marketing_and_communication' | 'nursing_and_therapy' | 'physicians' | 'public_sector' | 'purchasing_materials_administration_and_logistics' | 'sales' | 'sciences_and_research' | 'service_industry_and_manufacturing' | 'sports_art_and_creative_jobs' | 'other'
workplace_type'onsite' | 'remote' | 'hybrid'
status'draft' | 'published' | 'unlisted' | 'archived' | 'cancelled' | 'deleted'
schedule_type'full_time' | 'part_time'
team_idstring
location_idstring
salary_format'fixed_amount' | 'range'
salary_from_amount_in_centsinteger
salary_to_amount_in_centsinteger
cv_requirement'mandatory' | 'optional' | 'do_not_ask'
cover_letter_requirement'mandatory' | 'optional' | 'do_not_ask'
phone_requirement'mandatory' | 'optional' | 'do_not_ask'
photo_requirement'mandatory' | 'optional' | 'do_not_ask'
personal_url_requirement'mandatory' | 'optional' | 'do_not_ask'
salary_period'annual' | 'monthly' | 'daily'

Example request

{
  "id": "1",
  "title": "My job title",
  "description": "My job description",
  "contract_type": "indefinite",
  "category": "engineering",
  "workplace_type": "onsite",
  "status": "draft",
  "schedule_type": "full_time",
  "team_id": "1",
  "location_id": "1",
  "salary_format": "range",
  "salary_from_amount_in_cents": 3000000,
  "salary_to_amount_in_cents": 5000000,
  "cv_requirement": "mandatory",
  "cover_letter_requirement": "optional",
  "phone_requirement": "do_not_ask",
  "photo_requirement": "do_not_ask",
  "personal_url_requirement": "do_not_ask",
  "salary_period": "annual"
}

Response

OK

idstring required

Unique identifier for the job posting

company_idstring required

Identifier of the company associated with the job posting

ats_company_idstring required

Identifier of the ATS company associated with the job posting

titlestring required

Title of the job posting

descriptionstring

Description of the job posting

contract_type'indefinite' | 'temporary' | 'intern' | 'training' | 'freelance' | 'vendor_contractor' | 'volunteer' | 'per_hour' | 'other' | 'alternant' | 'interim' | 'minijob' | 'werkstudent' | 'apprenticeship' | 'pj' | 'clt' | 'jovem_aprendiz' | 'a_termo_incerto' | 'a_termo_certo' | 'de_curta_duracao' | 'de_muita_curta_duracao' | 'promessa_de_trabalho' | 'a_tempo_parcial' | 'com_pluralidade_de_empregadores' | 'teletrabalho' | 'pre_reforma' | 'recibos_verdes' | 'estagio' | 'sem_termo' | 'apprentissage' | 'fixed_discontinued' | 'apprendistato'
category'administration_and_secretariat' | 'design_and_architecture' | 'education_and_social_policy' | 'engineering' | 'finance' | 'hr' | 'it' | 'legal' | 'management_and_consulting' | 'marketing_and_communication' | 'nursing_and_therapy' | 'physicians' | 'public_sector' | 'purchasing_materials_administration_and_logistics' | 'sales' | 'sciences_and_research' | 'service_industry_and_manufacturing' | 'sports_art_and_creative_jobs' | 'other'
workplace_type'onsite' | 'remote' | 'hybrid'
remoteboolean required

Indicates if the job posting is remote

status'draft' | 'published' | 'unlisted' | 'archived' | 'cancelled' | 'deleted' required

The current status of the job posting (e.g., draft, published, archived)

schedule_type'full_time' | 'part_time'

The schedule type of the job posting (e.g., full_time, part_time)

team_idstring

Identifier of the team associated with the job posting

location_idstring

Identifier of the location associated with the job posting

legal_entity_idstring

Identifier of the legal entity associated with the job posting

salary_format'fixed_amount' | 'range'

The format of the salary (e.g., range, fixed_amount)

salary_from_amount_in_centsinteger

The minimum salary amount in cents

salary_to_amount_in_centsinteger

The maximum salary amount in cents

hide_salaryboolean

Indicates whether the salary information for the job posting should be hidden from applicants.

cv_requirement'mandatory' | 'optional' | 'do_not_ask' required

Requirement for the CV (e.g, mandatory, optional, do_not_ask)

cover_letter_requirement'mandatory' | 'optional' | 'do_not_ask' required

Requirement for the cover letter (e.g, mandatory, optional, do_not_ask)

phone_requirement'mandatory' | 'optional' | 'do_not_ask' required

Requirement for the phone number (e.g, mandatory, optional, do_not_ask)

photo_requirement'mandatory' | 'optional' | 'do_not_ask' required

Requirement for the phone number (e.g, mandatory, optional, do_not_ask)

personal_url_requirement'mandatory' | 'optional' | 'do_not_ask' required

Requirement for the personal URL (e.g, mandatory, optional, do_not_ask)

urlstring

If published, the public URL of the job posting. Otherwise will be null

salary_period'annual' | 'monthly' | 'daily' required

The period of the salary (e.g., annual, monthly, daily)

published_atstring

Published date in ISO 8601 format of the job. If never been published the value will be null

created_atstring required

Date in ISO 8601 format when the job posting was created

Example response

{
  "id": "1",
  "company_id": "1",
  "ats_company_id": "1",
  "title": "My job title",
  "description": "My job description",
  "contract_type": "indefinite",
  "category": "engineering",
  "workplace_type": "onsite",
  "remote": true,
  "status": "draft",
  "schedule_type": "full_time",
  "team_id": "1",
  "location_id": "1",
  "legal_entity_id": "1",
  "salary_format": "range",
  "salary_from_amount_in_cents": 3000000,
  "salary_to_amount_in_cents": 5000000,
  "cv_requirement": "mandatory",
  "cover_letter_requirement": "optional",
  "phone_requirement": "do_not_ask",
  "photo_requirement": "do_not_ask",
  "personal_url_requirement": "do_not_ask",
  "url": "https://my-factorial-domain/job_posting/job-title-slug",
  "salary_period": "annual",
  "published_at": "2024-07-02T08:28:00.000Z",
  "created_at": "2024-07-10T13:30:02.000Z"
}