Como adicionar um comentário a um candidato

A API do InHire permite registrar comentários em um CANDIDATO. O comentário aparece para a equipe no card do candidato na vaga, na área de comentários e no histórico, junto das mudanças de etapa e de status.

É uma forma de trazer para o InHire informações produzidas em outros sistemas, como o resultado de um teste técnico, uma observação de uma entrevista feita fora da plataforma ou um retorno do gestor.

Adicionando um comentário

Use o endpoint Adicionar comentário à candidatura, informando no caminho o id da candidatura (no formato {jobId}*{talentId}, o mesmo id retornado em Obter candidaturas paginadas) e, no corpo, o texto do comentário no campo userNotes:

POST https://api.inhire.app/job-talents/talents/{jobId}*{talentId}/activities

{
  "userNotes": "Teste técnico concluído com nota 8,5.\nPonto de atenção: modelagem de dados."
}

Envie o comentário como texto simples. Quebras de linha (\n) são preservadas na exibição.

A resposta traz o comentário criado:

{
  "id": "{{id do comentário}}",
  "talentId": "{{talentId}}",
  "userNotes": "Teste técnico concluído com nota 8,5.\nPonto de atenção: modelagem de dados.",
  "userId": "{{id do usuário de API}}",
  "userName": "Integração Plataforma de Testes",
  "createdAt": "2026-10-10T14:32:05.000Z",
  "updatedAt": "2026-10-10T14:32:05.000Z"
}

Se a candidatura informada não existir, a requisição é recusada com status 404.

Autoria do comentário

O comentário é registrado em nome do usuário de API usado para obter o token de acesso (veja Autenticação). É esse nome que a equipe vê como autor do comentário no InHire.

dica

Se você mantém mais de uma integração, crie um usuário de API para cada uma e dê a ele um nome que identifique a origem (por exemplo, "Integração Plataforma de Testes"). Assim a equipe sabe de onde veio cada comentário.

Cada requisição cria um novo comentário. Se a sua integração repetir uma chamada (por exemplo, em uma nova tentativa após timeout), o comentário aparecerá duplicado.