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:

NomeValorDescrição
AuthorizationBearer [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

EndpointMétodoLink para Teste
/api/v2/prospects/delete/[application_id]POSTLoading...

Payload

Definição campo a campo para exclusão de uma prospecção na API:

CampoTipoObrigatórioDescrição
applicationIdintSimID da prospecção de candidato que será excluído do funil de prospecção.
typestringSimDefine 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á).
vacanciesarrayNãoLista as vagas das quais a prospecção será excluída no caso de o tipo ser partial
pipe_stage_idintNãoID 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!"
}