API Reference

Updating a job

patch
https://api.gupy.io/api/v1/jobs/

Updates an existing job.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Job ID

Body Params

Job to be updated

string
length ≤ 255

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

string
length ≤ 255

Job name

string
enum
length ≤ 255

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.

string
enum
length ≤ 255

Job type

boolean

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

string
enum
length ≤ 255

Job publication type

Allowed:
int64

The number of open vacancies for this job

int64

Job department or area id

int64

Job role id

string
length ≤ 1073741824

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

string
length ≤ 1073741824

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

string
length ≤ 1073741824

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

string
length ≤ 1073741824

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

string
length ≤ 1073741824

Notes about the job (free text)

boolean

This job is available to person with disabilities

string
length ≤ 255

Address street name

string
length ≤ 255

Address number and complements

string
length ≤ 255

Address city

string
length ≤ 255

Job address district

string
length ≤ 255

Job address complements

string
length ≤ 255

Address state name (eg. São Paulo)

string
length ≤ 255

Address state short name (eg. SP)

string
length ≤ 255

Address country name (eg. Brasil)

string
length ≤ 255

Address country short name (eg. BRA)

double

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

double

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

number

Job branch id

boolean
deprecated

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

string
enum
length ≤ 255

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

Allowed:
salary
object

Job salary information (not shown in the career page).

string
enum
length ≤ 255

Job opening reason

Allowed:
string
length ≤ 255

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

string
length ≤ 255

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

int64

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

date

Deadline for hiring candidates

date

Final date for application

customFields
array of objects

Custom fields values defined for this job.

customFields
string
enum
length ≤ 255

Job cancel reason

Allowed:
string
length ≤ 255

Job cancel reason notes provided by user when cancelReason is other

string
length ≤ 255

E-mail of the person who canceled the job

string
length ≤ 255

A video url about the job.

approvers
array of numbers

User ids to be approvers of the job

approvers
string
enum
length ≤ 255

Workflow request method

Allowed:
jobBoards
array of numbers

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.

jobBoards
Responses

Updated 10 months ago

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 10 months ago