updating a job

Essa documentação se refere ao glossário do endpoint de alterar vagas (método PATCH)

Endpoint do escopo de Jobs

Uptade job

Abaixo seguem os campos da vaga que podem ser atualizados através desse endpoint:

CAMPO BACKENDOPÇÕES NO BACKENDCAMPO NO FRONTENDObservações
codeAo 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.
nameAo criar uma nova vaga, em Detalhes da vaga, campo texto chamado Dê um nome para sua vagaNome da vaga
statusdraft
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.
typevacancy_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
publicationTypeExternal
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
hiringDeadlineAo criar uma nova vaga em, Definição de etapas, ao configurar a etapa de contratação, campo Data prevista para contrataçãoData prevista para contratação (campo obrigatório para publicação da vaga)
numVacanciesAo 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
departmentIdAo 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
roleIdAo 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
descriptionAo 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
responsibilitiesAo 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.
prerequisitesAo 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.**
additionalInformationAo 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.**
notesAo criar uma nova vaga, em Dados internos, campo Observação ou justificativa
disabilitiestrue
false
Ao criar uma nova vaga, em Detalhes da vaga, campo chamado Vagas para PCD?
addressStreetAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressNumberAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressCityAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressDistrictAo criar uma nova vaga, em Local de Trabalho
addressComplementsAo criar uma nova vaga, em Local de Trabalho
addressStateAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressStateShortNameAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressCountryAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressCountryShortNameAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressZipCodeAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressLatitudeAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
addressLongitudeAo criar uma nova vaga, em Local de Trabalho, campo Seu endereço
branchIdAo 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.
remoteWorkingtrue
false
Ao criar uma nova vaga, em Local de Trabalho, campo Trabalho remotoesse campo será descontinuado, a recomendação é utilizar o campo workplaceType.
workplaceTypehybrid
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.
reasonstaff_increase
staff_replacement
Ao criar uma nova vaga, em Dados internos, campo lista Qual é o motivo da requisição da vaga?
recruiterEmailAo criar uma nova vaga, em Dados internos, campo Digite o e-mail ou o nome do recrutador da vagaO e-mail deve ser previamente cadastrado na plataforma na seção de Acesso à plataforma - Usuários
managerEmailAo criar uma nova vaga, em Dados internos, campo Digite o e-mail ou o nome do gestor responsável pela vagaO e-mail deve ser previamente cadastrado na plataforma na seção de Acesso à plataforma - Usuários
careerPageIdAo 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 vagaNã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.
cancelReasonstaff_increase_or_substitution_postponed
cancellation_requested_by_manager
internal_transfer
organizational_restructuring
budget_review
other
Motivo do cancelamento da vaga
cancelReasonNotesNotas adicionais sobre o cancelamento da vaga
canceledByEmailE-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érioNã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.
videoUrlAo criar uma nova vaga, em Mídias da vaga, campo URL do vídeo da vaga
jobBoardsIds dos jobBoards que as vagas serão publicadas. Confira a tabela dos ids logo abaixo

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.