Excluindo prospecção de candidato
Este endpoint permite remover uma prospecção específica de candidato (prospect) do funil de prospecção.
Headers necessários:
| Nome | Valor | Descrição |
|---|---|---|
| Authorization | Bearer [SEU_TOKEN] | Bearer Token para autenticação. Saiba mais aqui. |
Uma vez que os Headers estejam devidamente configurados, podemos ir ao próximo passo.
Endpoint utilizado para excluir uma prospecção
| Endpoint | Método | Link para Teste |
|---|---|---|
| /api/v2/prospects/delete/[application_id] | POST | Loading... |
Payload
Definição campo a campo para exclusão de uma prospecção na API:
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| applicationId | int | Sim | ID da prospecção de candidato que será excluído do funil de prospecção. |
| type | string | Sim | Define o tipo de exclusão. Os tipos são: only (exclui somente na vaga deifinida na URL), partial (exclui em vagas selecionadas), all (remove de todas as vagas que ele está). |
| vacancies | array | Não | Lista as vagas das quais a prospecção será excluída no caso de o tipo ser partial |
| pipe_stage_id | int | Não | ID do estágio do pipeline de prospecção, usado para identificar o ponto exato da exclusão. |
Exemplo de resposta
{
"message": "Ação realizada com sucesso!"
}Updated 7 days ago
