v1
latestOpenAPI 3.0.02026-07-24161168406.5 KBCreating a job
Creates a new job. Click here for more information.
Request body
Job template to be used when creating the job. If provided, the template will be copied first.
Company's job internal code. If not provided, the API will generate one.
Job name
To create a quick_apply job post use quickApply = true. By using Public API resources in quick application type job post, you declare that you have read and agree to the Quick Application Terms of Use.
Job type. Value "vacancy_type_talent_pool" is not available for quick apply job postings.
Job publication type
Deadline for hiring candidates
Final date for application
The number of open vacancies for this job
Job department or area id
Job role id
Job description, shown in the career page (free text)
Responsibilities of the job, shown in the career page (free text)
Pre-requisites of the job, shown in the career page (free text)
Additional information of the job, shown in the career page (free text)
Notes about the job (free text)
This job is available to person with disabilities
Address street name
Address number and complements
Address city
Address state name (eg. São Paulo)
Address state short name (eg. SP)
Address country name (eg. Brasil)
Address country short name (eg. BRA)
Job address district
Job address complements
Address Zip Code
Work location latitude. If not provided, the addressZipCode will be used to get the latitude (this functionality only works with Brazilian postal codes).
Work location longitude. If not provided, the addressZipCode will be used to get the longitude (this functionality only works with Brazilian postal codes).
Job branch id
This job is for remote working. This field will soon be deprecated, please use workplaceType instead for setting remoteWorking accurately.
Workplace type. If provided, will be used to set the remoteWorking correctly.
Job opening reason
Job recruiter e-mail. If provided, must be an valid user in Gupy.
Job manager e-mail. If provided, must be an valid user in Gupy.
Id of the career page where the job will be shown.
Rating criterias for the job
A video url about the job.
Response
A confirmation of successful insertion of the job
Job ID
Job posting code (eg. 999-99999)
Job name (eg. Programador Node.js)
Job status
Job type
Publication type (eg. external, internal)
Number of total vacancies (eg. 10)
Department ID
Department name (eg. Recursos Humanos, Logística)
Role ID
Role name (eg. Desenvolvedor, Estagiário)
Branch ID
Branch name
Job description
Main responsabilities and attribuitions
Requirements and skills
Additional relevant informations
Internal notes about the job
Available for person with disabilities
Job address country
Job address short country name
Job address state
Job address short state name
Job address city
Job address street
Job address district
Job address complements
Job address number
Job address zip code
Work location latitude.
Work location longitude.
This job is for remote working. This field will soon be deprecated, please use workplaceType instead for setting remoteWorking accurately.
Workplace type. If provided, will be used to set the remoteWorking correctly.
Job opening reason
Image url for job website
Image url for social media
Final date for application
Career page ID
Career page name
User ID of the job manager
Name of the job manager
E-mail of the job manager
User ID of the job recruiter
Name of the job recruiter
E-mail of the job recruiter
Deadline for hiring candidates
Job cancel reason
Job cancel reason notes provided by user when cancelReason is other
E-mail of the person who canceled the job
Date of job cancel
Date of creation
Date of update
Date of job publication
Date of job approve
Date of job disapprove
Date of job close
Last date of job freeze
Last date of job unfreeze
User ID of the job creator
Name of the job creator
E-mail of the job creator
A video url about the job.
User ids to be approvers of the job
Workflow request method