Skip to main content

Post, Update and Renew a job

Available

The job is a json-encoded object in the content. The job model is described below. The job (identified by externalJobPostingId) cannot already exist.

HTTP Request [POST]
https://parceiros.empregos.com.br/api/job

curl -X 'POST' \
'https://parceiros.empregos.com.br/api/job' \
-H 'accept: */*' \
-H 'Authorization: bearer any' \
-H 'Content-Type: application/json' \
-d '{
"company": {
"applyUrl": "string",
"name": "string",
"logoUrl": "string",
"description": "string",
"industries": "Alimentos",
"companyId": "string",
"recruiterId": "string",
"nationalRegister": "string"
},
"externalJobPostingId": "string",
"jobPostingOperationType": "CREATE",
"title": "string",
"description": "string",
"location": {
"address": "Praça da República, São Paulo, SP",
"postalCode": "01045-000",
"geolocation": "-23.5440722,-46.6450811"
},
"salary": {
"min": 0,
"max": 0
},
"workplaceTypes": "On-site",
"employmentStatus": "string",
"experienceLevel": "string",
"trackingPixelUrl": "string",
"expireAt": "2023-12-26T14:10:50.530Z"
}'

Parameters [Request]

FieldDescriptionTypeRequired
companyRepresents the company that posted the job.ObjectYes
company.applyUrlURL to which candidates are directed to apply (typically the URL of the job on the client's website or ATS system)StringNo
company.nameThe company name for which this job posting is created for.StringYes
company.logoUrlThe company logo url.StringNo
company.descriptionDescription of the company's activies.StringYes
company.industriesRepresents industries of this job or company. EG: "Alimentos".StringNo
company.companyIdRepresents unique company id within the partner system. Do not send an empty or null string for this field. The maximum allowed length is 50 characters.StringNo
company.recruiterIdRepresents unique recruiter id within the partner system. Do not send an empty or null string for this field. The maximum allowed length is 50 characters.StringNo
company.nationalRegisterNational Register of Legal Entity ID. EG: The Brazilian National Registry of Legal Entities (Portuguese: Cadastro Nacional de Pessoas Jurídicas, “CNPJ”) is a nationwide registry of corporations, partnerships, foundations, investment funds, and other legal entities, created and maintained by the Brazilian Federal Revenue Service (Receita Federal do Brasil, “RFB”). Do not send an empty or null string for this field. The maximum allowed length is 200 characters.StringYes
externalJobPostingIdRepresents unique job id within the partner system. Do not send an empty or null string for this field. The maximum allowed length is 50 characters.StringYes
jobPostingOperationTypeRepresents the operation on the job posting. Available operation options are: CREATE, UPDATE, RENEW.StringYes
titleRepresents the title of the job posting that will be published. Character limit: 200StringYes
descriptionRepresents the job description including the job basic information, responsibility and so on. Character limit: 100 ~ 25,000. Limited set of HTML tags accepted: b, strong, u, i, br, p, ul, li, em.StringYes
locationRepresents the geographic location of the job position to hire.ObjectYes (one of options have to be filled)
location.addressRepresents the address of the job position to hire. EG: "Praça da República, São Paulo, SP". Note: Set “Brazil” for undetermined locals.StringYes/No
location.postalCodeRepresents the Postal Code of the job position to hire. EG: "01045-000"StringYes/No
location.geolocationRepresents the Postal Code of the job position to hire. EG: "-23.5440722,-46.6450811"StringYes/No
workplaceTypesRepresents the workplace nature of the job. Available options are:On-site, Hybrid or Remote.Default: On-site.StringNo
employmentStatusRepresents employment status of the job position. Available options are: FULL_TIME, PART_TIME, CONTRACT, INTERNSHIP, TEMPORARY, VOLUNTEER. If predefined Empregos Platform values are provided, they are displayed on the Empregos Platform job posting. If a non-standard value is provided, Empregos Platform attempts to standardize and match it to the closest pre-defined value. If no values are provided, Empregos Platform standardizes to the closest matched value based on other fields in the job posting.StringNo
experienceLevelRepresents experience level of the job position to hire. Available options are: ENTRY_LEVEL, MID_SENIOR_LEVEL, DIRECTOR, EXECUTIVE, INTERNSHIP, ASSOCIATE, NOT_APPLICABLE. If predefined Empregos Platform values are provided, they are displayed on the Empregos Platform job posting. If a non-standard value is provided, Empregos Platform attempts to standardize and match it to the closest pre-defined value. If no values are provided, Empregos Platform standardizes to the closest matched value based on other fields in the job postingStringNo
trackingPixelUrlURL for the tracking pixel to be embedded on the job descriptionStringNo
salary***ObjectNo
salary.min***IntNo
salary.max***IntNo
expireAtThe date when a job should expire and no longer be available to users. This date should be greater than the current date. If this field is not provided, the default expiration is 90 days.DateTimeNo