Sign in

v1

latestOpenAPI 3.0.02026-07-24161168406.5 KB
Jobs

Updating a job

Updates an existing job.

patch/jobs/{jobId}

Path parameters

jobIdinteger required

Job ID

Request body

codestring

Company's job internal code. If not provided, the API will generate one.

namestring

Job name

status'draft' | 'waiting_approval' | 'approved' | 'disapproved' | 'published' | 'frozen' | 'closed' | 'canceled'

Job status. Refer to https://developers.gupy.io/docs/mudanças-de-estado-de-uma-vaga (portuguese only) for more information on updating the status of a job.

type'vacancy_type_apprentice' | 'vacancy_type_associate' | 'vacancy_type_talent_pool' | 'vacancy_type_effective' | 'vacancy_type_internship' | 'vacancy_type_summer' | 'vacancy_type_temporary' | 'vacancy_type_outsource' | 'vacancy_type_trainee' | 'vacancy_type_volunteer' | 'vacancy_legal_entity' | 'vacancy_type_lecturer' | 'vacancy_type_freelancer' | 'vacancy_type_autonomous' | 'vacancy_type_intermittent'

Job type

quickApplyboolean

Unable to change quick-apply field value after a job has been created

publicationType'external' | 'internal'

Job publication type

numVacanciesinteger

The number of open vacancies for this job

departmentIdinteger

Job department or area id

roleIdinteger

Job role id

descriptionstring

Job description, shown in the career page (free text)

responsibilitiesstring

Responsibilities of the job, shown in the career page (free text)

prerequisitesstring

Pre-requisites of the job, shown in the career page (free text)

additionalInformationstring

Additional information of the job, shown in the career page (free text)

notesstring

Notes about the job (free text)

disabilitiesboolean

This job is available to person with disabilities

addressStreetstring

Address street name

addressNumberstring

Address number and complements

addressCitystring

Address city

addressDistrictstring

Job address district

addressComplementsstring

Job address complements

addressStatestring

Address state name (eg. São Paulo)

addressStateShortNamestring

Address state short name (eg. SP)

addressCountrystring

Address country name (eg. Brasil)

addressCountryShortNamestring

Address country short name (eg. BRA)

addressLatitudenumber double

Work location latitude. If not provided, the addressZipCode will be used to get the latitude (this functionality only works with Brazilian postal codes).

addressLongitudenumber double

Work location longitude. If not provided, the addressZipCode will be used to get the longitude (this functionality only works with Brazilian postal codes).

branchIdnumber

Job branch id

remoteWorkingboolean

This job is for remote working. This field will soon be deprecated, please use workplaceType instead for setting remoteWorking accurately.

workplaceType'hybrid' | 'on-site' | 'remote'

Workplace type. If provided, will be used to set the remoteWorking correctly.

reason'staff_increase' | 'staff_replacement'

Job opening reason

recruiterEmailstring email

Job recruiter e-mail. If provided, must be an valid user in Gupy.

managerEmailstring email

Job manager e-mail. If provided, must be an valid user in Gupy.

careerPageIdinteger

Id of the career page where the job will be shown.

hiringDeadlinestring date

Deadline for hiring candidates

applicationDeadlinestring date

Final date for application

cancelReason'staff_increase_or_substitution_postponed' | 'cancellation_requested_by_manager' | 'internal_transfer' | 'organizational_restructuring' | 'budget_review' | 'other'

Job cancel reason

cancelReasonNotesstring

Job cancel reason notes provided by user when cancelReason is other

canceledByEmailstring email

E-mail of the person who canceled the job

videoUrlstring

A video url about the job.

approversnumber[]

User ids to be approvers of the job

workflowRequestMethod'all_at_once' | 'in_order'

Workflow request method

jobBoardsnumber[]

Job Boards ids to be published Refer to https://developers.gupy.io/docs/updating-a-job (portuguese only) for more information on updating the jobBoards of a job.

Response

A confirmation of successful update of the job

idinteger

Job ID

codestring

Job posting code (eg. 999-99999)

namestring

Job name (eg. Programador Node.js)

status'draft' | 'waiting_approval' | 'approved' | 'disapproved' | 'published' | 'frozen' | 'closed' | 'canceled'

Job status

type'vacancy_type_apprentice' | 'vacancy_type_associate' | 'vacancy_type_talent_pool' | 'vacancy_type_effective' | 'vacancy_type_internship' | 'vacancy_type_summer' | 'vacancy_type_temporary' | 'vacancy_type_outsource' | 'vacancy_type_trainee' | 'vacancy_type_volunteer' | 'vacancy_legal_entity' | 'vacancy_type_lecturer' | 'vacancy_type_freelancer' | 'vacancy_type_autonomous' | 'vacancy_type_intermittent'

Job type

publicationType'external' | 'internal'

Publication type (eg. external, internal)

numVacanciesinteger

Number of total vacancies (eg. 10)

departmentIdinteger

Department ID

departmentNamestring

Department name (eg. Recursos Humanos, Logística)

roleIdinteger

Role ID

roleNamestring

Role name (eg. Desenvolvedor, Estagiário)

branchIdinteger

Branch ID

branchNamestring

Branch name

descriptionstring

Job description

responsibilitiesstring

Main responsabilities and attribuitions

prerequisitesstring

Requirements and skills

additionalInformationstring

Additional relevant informations

notesstring

Internal notes about the job

disabilitiesboolean

Available for person with disabilities

addressCountrystring

Job address country

addressCountryShortNamestring

Job address short country name

addressStatestring

Job address state

addressStateShortNamestring

Job address short state name

addressCitystring

Job address city

addressStreetstring

Job address street

addressDistrictstring

Job address district

addressComplementsstring

Job address complements

addressNumberstring

Job address number

addressZipCodestring

Job address zip code

addressLatitudenumber double

Work location latitude.

addressLongitudenumber double

Work location longitude.

remoteWorkingboolean

This job is for remote working. This field will soon be deprecated, please use workplaceType instead for setting remoteWorking accurately.

workplaceType'hybrid' | 'on-site' | 'remote'

Workplace type. If provided, will be used to set the remoteWorking correctly.

reason'staff_increase' | 'staff_replacement'

Job opening reason

imagestring

Image url for job website

socialMediaImagestring

Image url for social media

applicationDeadlinestring date

Final date for application

careerPageIdinteger

Career page ID

careerPageNamestring

Career page name

managerIdinteger

User ID of the job manager

managerNamestring

Name of the job manager

managerEmailstring email

E-mail of the job manager

recruiterIdinteger

User ID of the job recruiter

recruiterNamestring

Name of the job recruiter

recruiterEmailstring email

E-mail of the job recruiter

hiringDeadlinestring date

Deadline for hiring candidates

cancelReason'staff_increase_or_substitution_postponed' | 'cancellation_requested_by_manager' | 'internal_transfer' | 'organizational_restructuring' | 'budget_review' | 'other'

Job cancel reason

cancelReasonNotesstring

Job cancel reason notes provided by user when cancelReason is other

canceledByEmailstring email

E-mail of the person who canceled the job

cancelAtstring date-time

Date of job cancel

createdAtstring date-time

Date of creation

updatedAtstring date-time

Date of update

publishedAtstring date-time

Date of job publication

approvedAtstring date-time

Date of job approve

disapprovedAtstring date-time

Date of job disapprove

closedAtstring date-time

Date of job close

lastFreezeDatestring date-time

Last date of job freeze

lastUnFreezeDatestring date-time

Last date of job unfreeze

creatorIdinteger

User ID of the job creator

creatorNamestring

Name of the job creator

creatorEmailstring email

E-mail of the job creator

videoUrlstring

A video url about the job.

approversnumber[]

User ids to be approvers of the job

workflowRequestMethod'all_at_once' | 'in_order'

Workflow request method