Pular para o conteúdo principal

Como adicionar tags a um candidato

A API do InHire permite adicionar tags a um CANDIDATO. As tags são configuradas por vaga e retornadas no array tags do endpoint Obter vaga ou do endpoint específico Obter tags de uma vaga. Cada tag possui um id, que é o valor usado para adicioná-la ao candidato.

Se a tag desejada ainda não existe na vaga, crie-a antes com o endpoint Criar tag para uma vaga.

Adicionando tags​

Use o endpoint Adicionar tags à candidatura, informando no caminho o id da candidatura (no formato {jobId}*{talentId}, o mesmo id retornado em Obter candidaturas paginadas) e, no corpo, os ids das tags:

POST https://api.inhire.app/job-talents/talents/{jobId}*{talentId}/tags
{
"tagIds": ["{{id da tag}}", "{{id de outra tag}}"]
}

As tags enviadas são somadas às que o candidato já possui: nenhuma tag existente é removida. Enviar uma tag que o candidato já tem não gera erro nem duplicidade, então a mesma requisição pode ser repetida com segurança.

A resposta traz a lista completa de tags do candidato após a operação:

{
"tags": [
{ "id": "{{id da tag}}", "name": "Sênior", "color": "#FFB020" },
{ "id": "{{id de outra tag}}", "name": "Inglês fluente", "color": "#3366FF" }
]
}

Se algum dos ids enviados não corresponder a uma tag da vaga, a requisição é recusada com status 422 e nenhuma tag é adicionada.

Se a resposta for 409 (as tags do candidato foram alteradas por outra operação no mesmo instante) ou um erro 5xx, repita a requisição. Como a operação é idempotente, repeti-la não duplica tags nem remove as que já foram adicionadas.

Substituindo todas as tags do candidato​

O endpoint Atualizar candidatura também aceita o campo tags, mas com outro comportamento: ele substitui a lista inteira. Qualquer tag que não estiver no corpo da requisição é removida do candidato.

aviso

Para apenas acrescentar tags, use Adicionar tags à candidatura. Use o tags de Atualizar candidatura somente quando quiser definir o conjunto completo de tags do candidato (por exemplo, para remover uma tag), enviando todas as tags que devem permanecer.