updating a job
Essa documentação se refere ao glossário do endpoint de alterar vagas (método PATCH)
Endpoint do escopo de Jobs
Abaixo seguem os campos da vaga que podem ser atualizados através desse endpoint:
CAMPO BACKEND | OPÇÕES NO BACKEND | CAMPO NO FRONTEND | Observações |
---|---|---|---|
code | Ao criar uma nova vaga, em Dados internos, campo Código da vaga. | Apesar de ser gerado automaticamente pelo sistema ao criar a vaga, é um campo editável. | |
name | Ao criar uma nova vaga, em Detalhes da vaga, campo texto chamado Dê um nome para sua vaga | Nome da vaga | |
status | draft, waiting_approval, approved, disapproved, published, frozen, closed, canceled | As alterações de status da vaga devem seguir a regra de negócio conforme documentado nesse link. | |
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 | Ao criar uma nova vaga, em Detalhes da vaga, campo de lista chamado Qual é o tipo da vaga? | Tipo da vaga |
publicationType | External, Internal | Ao criar uma nova vaga em, Publicação da vaga, campo Tipo de publicação. | Apesar de aparecerem 4 tipos no frontend (pública, interna, confidencial e não-listada) na API temos apenas as opções external e internal, pois há uma correspondência (de/para) entre os tipos |
hiringDeadline | Ao criar uma nova vaga em, Definição de etapas, ao configurar a etapa de contratação, campo Data prevista para contratação | Data prevista para contratação (campo obrigatório para publicação da vaga) | |
numVacancies | Ao criar uma nova vaga, em Dados internos, campo Quantas posições? | Ao colocar o número de posições, no frontend é habilitado o campo para preencher com o código da posição, porém ao criar uma vaga via API não é possível atribuir esse código diretamente, sendo necessário fazer um POST utilizando o endpoint Creating a vacancy code | |
departmentId | Ao criar uma nova vaga, em Detalhes da vaga, campo Qual a área de trabalho? (No frontend o que aparece é uma lista com os departamentos previamente cadastrados no setup e não o seu Id.) | Número gerado automaticamente pela Gupy ao criar uma área. Para consultar os ids das áreas, utilize o endpoint listing departments | |
roleId | Ao criar uma nova vaga, em Detalhes da vaga, campo Qual o cargo da vaga? (No frontend o que aparece é uma lista com os cargos previamente cadastrados no setup e não o seu Id.) | Número gerado automaticamente pela Gupy ao criar um cargo. Para consultar os ids dos cargos, utilize o endpoint listing roles | |
description | Ao criar uma nova vaga em, Descrição da vaga, campo chamado Descreva sobre a vaga e aproveite para falar sobre a empresa, sua cultura e equipe. | campo obrigatório para a publicação da vaga | |
responsibilities | Ao criar uma nova vaga em, Descrição da vaga, campo chamado Descreva as responsabilidades e atribuições. Cite também as experiências que se espera ou deseja que a pessoa possua. | ||
prerequisites | Ao criar uma nova vaga em, Descrição da vaga, campo chamado Descreva os requisitos e qualificações, falando sobre ferramentas, habilidades, cursos e certificações. | ||
additionalInformation | Ao criar uma nova vaga em, Descrição da vaga, campo chamado Descreva as informações adicionais que são relevantes para a pessoa candidata, como os benefícios oferecidos. | ||
notes | Ao criar uma nova vaga, em Dados internos, campo Observação ou justificativa | ||
disabilities | true, false | Ao criar uma nova vaga, em Detalhes da vaga, campo chamado Vagas para PCD? | |
addressStreet | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressNumber | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressCity | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressDistrict | Ao criar uma nova vaga, em Local de Trabalho | ||
addressComplements | Ao criar uma nova vaga, em Local de Trabalho | ||
addressState | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressStateShortName | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressCountry | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressCountryShortName | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressZipCode | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressLatitude | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
addressLongitude | Ao criar uma nova vaga, em Local de Trabalho, campo Seu endereço | ||
branchId | Ao criar uma nova vaga, em Local de Trabalho, campo Informe a estrutura organizacional para esta vaga (No frontend o que aparece é uma lista com as filiais previamente cadastrados no setup e não o seu Id.) | Número gerado automaticamente pela Gupy ao criar uma filial. | |
remoteWorking | true, false | Ao criar uma nova vaga, em Local de Trabalho, campo Trabalho remoto | esse campo será descontinuado, a recomendação é utilizar o campo workplaceType. |
workplaceType | hybrid, on-site, remote | Ao criar uma nova vaga, em Local de Trabalho, campo Trabalho remoto | |
salary {currency, startsAt, endsAt} | currency: R$ | Ao criar uma nova vaga, em Dados internos, campo Salário mensal. Ao clicar em adicionar faixa salarial o campo endsAt ficará disponível. | Se não houver faixa salarial o campo starstAt terá o valor que foi definido como salário. |
reason | staff_increase, staff_replacement | Ao criar uma nova vaga, em Dados internos, campo lista Qual é o motivo da requisição da vaga? | |
recruiterEmail | Ao criar uma nova vaga, em Dados internos, campo Digite o e-mail ou o nome do recrutador da vaga | O e-mail deve ser previamente cadastrado na plataforma na seção de Acesso à plataforma - Usuários | |
managerEmail | Ao criar uma nova vaga, em Dados internos, campo Digite o e-mail ou o nome do gestor responsável pela vaga | O e-mail deve ser previamente cadastrado na plataforma na seção de Acesso à plataforma - Usuários | |
careerPageId | Ao criar uma nova vaga, em Publicação da vaga, campo Página de carreira: | No frontend aparece apenas a lista das páginas de carreiras que a empresa possui, para saber qual o Id correspondente, faça o GET utilizando o endpoint Listing carrer pages usando o nome da página de carreiras como filtro. Campo obrigatório para publicação da vaga | |
customFields {id, value} | A criação dos campos customizados é realizada em Setup -> Menu lateral esquerdo (seção templates) -> campos customizados da vaga | Não é possível criar um campo customizado através da API. O campo deve estar previamente cadastrado na plataforma para que ao criar a vaga apenas seja setado qual o valor que ele vai receber. | |
cancelReason | staff_increase_or_substitution_postponed, cancellation_requested_by_manager, internal_transfer, organizational_restructuring, budget_review, other | Motivo do cancelamento da vaga | |
cancelReasonNotes | Notas adicionais sobre o cancelamento da vaga | ||
canceledByEmail | E-mail de quem realizou o cancelamento | ||
approvers | |||
workflowRequestMethod | |||
jobRatingCriterias {id, name} | Ao criar uma nova vaga, em Definição de critérios, campo Nome do critério | Não é possível criar um critério através da API. O critério deve estar previamente cadastrado na plataforma para que ao criar a vaga apenas seja setado qual o valor que ele vai receber. | |
videoUrl | Ao criar uma nova vaga, em Mídias da vaga, campo URL do vídeo da vaga | ||
jobBoards | Ids dos jobBoards que as vagas serão publicadas. Confira a tabela dos ids logo abaixo |
jobBoard | id | Observação |
---|---|---|
riovagas | 10 | gratuito |
jooble | 11 | gratuito, veja mais clicando aqui |
indeed | 1 | ativado por padrão em todas as vagas publicadas (gratuito). Conheça mais clicando aqui |
3 | é necessário realizar a ativação na plataforma (gratuito). Consulte aqui como fazer | |
trampos | 14 | pago, precisar ter um conta no Job Board, veja como funciona clicando aqui |
glassdoor | 9 | integrado com indeed, veja como funciona clicando aqui |
99hunters | 13 | gratuito, conheça mais clicando aqui |
netvagas | 12 | gratuito, conheça mais clicando aqui |
talent | 15 | gratuito |
career_jet | 147 | |
jobbol | 279 | |
carreira_fashion | 246 | |
yduqs | 213 | |
recruta_simples | 180 |
Publicando Vagas em Páginas de Carreira Confidencial
Caso tenha a necessidade de publicar uma vaga confidencial, garanta que possui uma página de carreira confidencial criada e edite uma vaga normalmente e utilizando no campo careerPageId o ID dessa página de carreira confidencial. No campo publicationType pode ser selecionada a opção external assim as vagas serão publicadas como confidenciais.
Updated 4 months ago