API Reference

Creating a job

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

Creates a new job. Click here for more information.

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

Job to be created

int64

Job template to be used when creating the job. If provided, the template will be copied first.

string
length ≤ 255

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

string
required
length ≤ 255

Job name

boolean

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.

string
enum
required
length ≤ 255

Job type. Value "vacancy_type_talent_pool" is not available for quick apply job postings.

string
enum
required
length ≤ 255

Job publication type

Allowed:
date

Deadline for hiring candidates

date

Final date for application

int64
required

The number of open vacancies for this job

int64
required

Job department or area id

int64
required

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

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)

string
length ≤ 255

Job address district

string
length ≤ 255

Job address complements

string
length ≤ 255

Address Zip Code

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.

customFields
array of objects

Custom fields values defined for this job.

customFields
jobRatingCriterias
array of strings

Rating criterias for the job

jobRatingCriterias
string
length ≤ 255

A video url about the job.

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