API - Como Recuperar ou Deletar Leads Arquivados

A recuperação de leads arquivados é uma função importante para manter a flexibilidade na gestão da base de contatos. Às vezes, um lead arquivado pode voltar a se engajar ou apresentar novas oportunidades, e é essencial que o processo de desarquivamento seja ágil e direto. A API da SprintHub permite que você consulte e gerencie seus leads arquivados facilmente, utilizando o endpoint correto.

Endpoint para Consultar Leads Arquivados

Para recuperar os leads que estão arquivados em uma instância da SprintHub, você deve usar o seguinte endpoint:

https://sprinthub-api-master.sprinthub.app/lead/archive?i=SUA INSTANCIA&apitoken=SEU_TOKEN_DA_INSTÂNCIA

Neste endpoint, você precisa passar dois parâmetros essenciais:

• i=SUA_INSTÂNCIA: Identifica qual instância está sendo consultada.

• apitoken=SEU_TOKEN_DA_INSTÂNCIA: Token de autenticação, garantindo que a solicitação está sendo feita por um usuário autorizado.

Requisitos para o Corpo da Requisição (Body)

Para realizar a consulta e garantir que o lead arquivado seja corretamente identificado, o body da requisição deve conter os seguintes dados em formato JSON:

jsonCopiar código{
  "archived": true,
  "id": 2331
}

Explicação:

• archived: Este campo deve ser definido como true para confirmar que você está buscando leads arquivados.

• id: O ID específico do lead que você deseja consultar ou gerenciar. Neste caso, o ID é 2331, mas deve ser substituído pelo ID do lead que você está tentando recuperar.

Passo a Passo para Recuperar Leads Arquivados

1. Configuração da Requisição: Utilize uma ferramenta de API como o Postman ou um cliente HTTP para realizar a requisição POST para o endpoint mencionado.

2. Envio dos Parâmetros: Certifique-se de que os parâmetros da URL e o token de autenticação estão corretos, garantindo acesso à instância certa e autorização apropriada.

3. Definir o Body da Requisição: No body da requisição, conforme mostrado acima, defina os campos "archived": false e especifique o id do lead arquivado.

4. Enviar a Requisição: Clique em "Send" para enviar a requisição. Se a requisição estiver correta, você receberá uma resposta com o status 200 OK, indicando que o lead foi encontrado.

Exemplo Prático de Requisição no Postman

A imagem apresentada ilustra um exemplo real no Postman, onde a requisição foi bem-sucedida, retornando um status 200 OK.

• Método: POST

• URL: https://sprinthub-api-master.sprinthub.app/lead/archive?i=SUA INSTANCIA&apitoken=SEU_TOKEN_DA_INSTÂNCIA

• Body:

{
  "archived": true,
  "id": 2331
}

Ao realizar esta requisição, o lead com ID 2331 foi recuperado como arquivado.

Agora para Deletar:

Lembrando que, ao Deletar esse lead está perdido para sempre e não pode ser recuperado

• Método: DELETE

• URL: https://sprinthub-api-master.sprinthub.app/leads/ID_DO_LEAD?i=SUA INSTANCIA&apitoken=SEU_TOKEN_DA_INSTÂNCIA

Ao realizar esta requisição, o lead com ID 2346 foi Deletado, mesmo estando arquivado.

Caso deseje realizar um arquivamento, desarquivamento ou delete de leads arquivado em massa, vai ser necessário passar um array com todos os leads IDs dos leads.

Conclusão

O processo de recuperação de leads arquivados via API na SprintHub é simples e eficaz. Certifique-se de sempre utilizar o ID correto e definir o campo "archived": true no corpo da requisição para garantir que está acessando as informações dos leads arquivados. Esse recurso é essencial para manter a flexibilidade e garantir que leads possam ser restaurados sempre que necessário, sem perda de dados importantes.