Skip to main content

How to create a new vacancy?

  • Updated

Index

Overview

This endpoint allows you to create a new vacancy in your Pandapé account. There are no query parameters required; all vacancy details are provided in the JSON request body.

POST /v2/vacancies
  • Method: GET
  • URL: /v2/vacancies
  • Content-type: application/json

 

Request Body Schema

The following table summarizes the fields included in the request body along with their data types and descriptions:

Field Type Description
IdUser integer The ID of the user creating the vacancy.
IdRequestToAssociate integer The ID of the associated request (if applicable).
Reference string A reference code or identifier for the vacancy.
Job string The job title or position name.
JobComplement string Additional details or complementary information about the job.
IdCategory1 integer Primary category ID for the vacancy.
IdCategory2 integer Secondary category ID for the vacancy.
IdManagerialLevel integer The managerial level associated with the vacancy.
IdLocation1 integer Primary location identifier.
IdLocation2 integer Secondary location identifier.
IdLocation3 integer Tertiary location identifier.
Description string A detailed description of the vacancy.
NumberVacancies integer The number of available positions for the vacancy.
IdContractWorkType integer Identifier for the type of work contract.
IdWorkingHours integer Identifier for the type of working hours.
IdWorkMethod integer Identifier for the work method.
SalaryMin string The minimum salary offered for the position.
SalaryMax string The maximum salary offered for the position.
HideSalary boolean Indicates whether the salary should be hidden in listings.
CEP string The postal code for the vacancy's location.
VacancyLocationType string Specifies the type of vacancy location (e.g., "0 - CompanyAddress").
CompanyHidden boolean Indicates if the company details should be hidden from the listing.
AlternativeDescription string An alternative description for the vacancy.
YoutubeVideoUrl string A URL linking to a related YouTube video.
IdStudy1Min integer The minimum required study level ID.
CompanyHiddenName string An alternative name for the company if it is hidden.
ContractDate string (ISO 8601 DateTime) The contract date, provided in ISO 8601 format (e.g., "2025-04-02T10:03:25.858Z").
IdExperienceRange integer Identifier for the required range of experience.
AgeMin integer The minimum age requirement for candidates.
AgeMax integer The maximum age requirement for candidates.
IdSex integer Identifier for the required gender (if applicable).
DeficiencyRequired boolean Indicates whether a deficiency must be specified.
DeficiencyInformation string Additional information regarding any required deficiencies.
CIDRequired boolean Indicates whether a CID (International Classification of Diseases) is required.
Deficiencies array An array of deficiency objects. Each object should include:
• IdDeficiency1 (integer): Primary deficiency ID.
• IdDeficiency2List (array of integers): List of secondary deficiency IDs.
ChangeResidenceAvailabilityRequired boolean Specifies whether candidates must be available to change their residence.
TravelAvailabilityRequired boolean Specifies whether candidates must be available for travel.
VehicleRequired boolean Indicates if having a vehicle is a requirement for the vacancy.
LicenseRequired boolean Indicates if candidates must have a valid license.
IdLicenseList array An array of license IDs (integers) that are required for the vacancy.
Studies array An array of study objects. Each object should include:
• IdStudy1 (integer): Primary study ID.
• IdStudy2 (integer): Secondary study ID.
Languages array An array of language objects. Each object should include:
• IdLanguage (integer): Language ID.
• IdLanguageLevel (integer): Proficiency level of the language.
Benefits array An array of strings representing the benefits offered with the vacancy.
Skills array An array of strings representing the required skills for the position.
Tags array An array of strings used to tag the vacancy with relevant keywords.
Publish boolean Determines whether the vacancy should be published immediately.
IsDeficiencyHidden boolean Indicates whether details regarding deficiencies should be hidden from view.

 

Example request

{
  "IdUser": 0,
  "IdRequestToAssociate": 0,
  "Reference": "string",
  "Job": "string",
  "JobComplement": "string",
  "IdCategory1": 0,
  "IdCategory2": 0,
  "IdManagerialLevel": 0,
  "IdLocation1": 0,
  "IdLocation2": 0,
  "IdLocation3": 0,
  "Description": "string",
  "NumberVacancies": 0,
  "IdContractWorkType": 0,
  "IdWorkingHours": 0,
  "IdWorkMethod": 0,
  "SalaryMin": "string",
  "SalaryMax": "string",
  "HideSalary": true,
  "CEP": "string",
  "VacancyLocationType": "0 - CompanyAddress",
  "CompanyHidden": true,
  "AlternativeDescription": "string",
  "YoutubeVideoUrl": "string",
  "IdStudy1Min": 0,
  "CompanyHiddenName": "string",
  "ContractDate": "2025-04-02T10:03:25.858Z",
  "IdExperienceRange": 0,
  "AgeMin": 0,
  "AgeMax": 0,
  "IdSex": 0,
  "DeficiencyRequired": true,
  "DeficiencyInformation": "string",
  "CIDRequired": true,
  "Deficiencies": [
    {
      "IdDeficiency1": 0,
      "IdDeficiency2List": [0]
    }
  ],
  "ChangeResidenceAvailabilityRequired": true,
  "TravelAvailabilityRequired": true,
  "VehicleRequired": true,
  "LicenseRequired": true,
  "IdLicenseList": [0],
  "Studies": [
    {"IdStudy1": 0, "IdStudy2": 0}
  ],
  "Languages": [
    {"IdLanguage": 0, "IdLanguageLevel": 0}
  ],
  "Benefits": ["string"],
  "Skills": ["string"],
  "Tags": ["string"],
  "Publish": true,
  "IsDeficiencyHidden": true
}

 

Responses

Status Code Meaning Description
200 Success The vacancy was successfully created and a JSON object is returned containing the new vacancy details.
401 Unauthorized Authentication credentials are missing or invalid.
403 Forbidden The request was understood but was refused due to insufficient privileges.

 

Error Handling

  • 401 Unauthorized: Verify that your authentication token or credentials are valid and have not expired.
  • 403 Forbidden: Ensure that you have the required permissions to create vacancies in your Pandapé account.

Tips & Best Practices

  • Complete Request Body: Make sure that all required fields are included and correctly formatted. Check default values in your environment for any fields that you do not explicitly set.
  • Field Validation: Verify that numeric fields and IDs match valid entries in your system to avoid data inconsistencies.
  • Publishing Control: Use the Publish field to determine if the vacancy should be immediately available. If set to false, you may use additional endpoints to review and publish vacancies later.
  • Testing: Use development tools like Postman to test your request body and validate responses before integrating into production.

For more information, please consult the Pandapé API v2 documentation.

Related articles