Entendendo os Métodos Open API do Lead Gen & CRM: Lead

Última atualização: 9 de outubro de 2024


O Lead Gen & CRM possui uma organização de API distinta. Este artigo detalhará os métodos listados dentro da API do Lead Gen & CRM, relacionados a Leads.

Conteúdo do Artigo

Usuários:
Administradores ✓  
Gerentes de Empresa    
Gerentes de Marketing    
Gerentes de Vendas    
Vendedores    
Vendedores Jr.    

 

Informações Adicionais sobre a API

Este artigo fornece conteúdo específico sobre os métodos da API do Lead Gen & CRM. No entanto, dado o tamanho e o escopo da API, as informações estão divididas e contidas em diferentes artigos. Cada artigo foca em uma função específica da API do Lead Gen & CRM. Informações adicionais sobre a API podem ser encontradas nos seguintes artigos:

 

Evento
 

getEvents

 Recupera uma lista de eventos Lead do Lead Gen & CRM. Um ID de lead ou um timestamp de evento podem ser especificados. No caso em que um timestamp de evento é especificado, a API retornará todos os eventos que ocorreram após o timestamp fornecido. Por favor, note que eventos de Mail Sync não serão retornados.
 
Parâmetros Nome   Tipo    É Necessário   
onde  

hash

Necessário: nenhum
Opcional: leadID, createTimestamp

   Necessário   
limite  

int

   Opcional  
offset  

int 

   Opcional   
       
Dados de Retorno Nome   Tipo     

campos

   list<Evento>     

 

 

Lead
 

createLeads

 Especifica uma lista de objetos Lead a serem criados no Lead Gen & CRM. Cada objeto de lead é uma chave hash pelo nome do sistema do campo de lead. Se você deseja enviar campos personalizados, primeiro use o método de API getFields para recuperar uma lista de campos personalizados. Para definir um campo personalizado para um lead, use o atributo systemName do campo como a chave.

Este método aceita até 500 objetos de lead por chamada. No entanto, em casos com muitos dados de campos personalizados sendo passados, é melhor separar as solicitações em chamadas menores e mais gerenciáveis para melhorar o desempenho. 250 objetos de lead devem ser usados nesses casos.
 
Params Nome   Tipo    É Necessário   

objects

   list<lead>   Necessário  
       
Retornar
Dados 		Nome   Tipo     

creates

   list<createResult>  

 

deleteLeads

 Especifica uma lista de leads a serem excluídos no Lead Gen & CRM pelo ID.
 
Params Nome   Tipo    É Necessário   

objects

   list<id>   Necessário  
       
Retornar
Dados 		Nome   Tipo     

deletes

   list<deleteResult>  

 

getLead 

 Recupera um único Lead pelo seu ID.
 
Params Nome   Tipo    É Necessário   

id

   int   Necessário  
       
Retornar
Dados 		Nome   Tipo     
leads  

list<Lead>

  

 

getLeads

 Recupera uma lista de Leads dada uma cláusula WHERE, ou recupera todos os Leads se a cláusula WHERE estiver vazia. Se uma lista for usada nos parâmetros, então os parâmetros que não são listas serão ignorados. Um máximo de 500 leads será retornado com o ID da lista sendo selecionado primeiro. Se FIELDS for especificado, apenas os campos solicitados serão retornados.
 
Params Nome   Tipo    É Necessário   
where  

hash

Necessário: nenhum
Opcional: id, list<id>, emailAddress, list<emailAddress>

   Necessário  

limit

   int   Opcional   

offset

   int    Opcional   

fields

   list<systemName>    Opcional   
       
Retornar
Dados 		Nome   Tipo     

leads

   list<Lead>  

 

getLeadsDateRange

 Recupera uma lista de Leads que foram criados ou atualizados entre dois timestamps. Os timestamps devem ser especificados no formato Y-m-d H:i:s. Se FIELDS for especificado, apenas os campos solicitados serão retornados.
 
Params Nome   Tipo    É Necessário   
startDate  

timestamp

   Necessário  
endDate  

timestamp 

   Necessário   
timestamp  

string

Necessário: create, update
Opcional: nenhum

   Necessário   
fields  

list<systemName> 

   Opcional   
       
Retornar
Dados 		Nome   Tipo     

leads

   list<Lead>     

 

subscribeToLeadUpdates

 Inscreve uma URL para receber atualizações de leads em tempo real. O Lead Gen & CRM irá POST uma lista de leads atualizados sempre que os leads forem atualizados na aplicação.
 
Params Nome   Tipo    É Necessário   
url  

string

   Necessário  
       
Retornar
Dados 		Nome   Tipo     
success  

boolean

  

 

updateLeads

 Especifica uma lista de objetos Lead a serem atualizados no Lead Gen & CRM. Cada objeto de lead é uma chave hash pelo nome do sistema do campo de lead. Se você deseja enviar campos personalizados, primeiro use o método de API getFields para recuperar uma lista de campos personalizados. Para definir um campo personalizado para um lead, use o atributo systemName do campo como a chave.
 
Params Nome   Tipo    É Necessário   
objects  

list<lead>

   Necessário  
       
Retornar
Dados 		Nome   Tipo     
updates  

list<updateResult>

  

 

updateLeadsV2

 Especifica uma lista de objetos Lead a serem atualizados no Lead Gen & CRM. Cada objeto de lead é uma chave hash pelo nome do sistema do campo de lead. Se você deseja enviar campos personalizados, primeiro use o método de API getFields para recuperar uma lista de campos personalizados. Para definir um campo personalizado para um lead, use o atributo systemName do campo como a chave. Isso difere de updateLeads na medida em que retorna código de erro 404 se o ID do lead não existir ou se o ID do lead não for fornecido e o email do lead não existir.
 
Params Nome   Tipo    É Necessário   

objects

   list<lead>   Necessário  
       
Retornar
Dados 		Nome   Tipo     

updates

   list<updateResult>  

 

 

eventHistory
 

logCalls

 Registra chamadas com leads. O timestamp deve ser especificado no formato Y-m-d H:i:s.
 
Params Nome   Tipo    É Obrigatório   

objects

   list<CallLog>   Obrigatório  
       
Return
Data 		Nome   Tipo     

success

   boolean  

 

leadListMembership
 

getLeadListMemberships

 Obtém os ID da lista para cada ID de membro. Máximo de 100 leads por solicitação.
 
Params Nome   Tipo    É Obrigatório   

memberIDs

   list<MemberID>   Obrigatório  
       
Retorno
Dados 		Nome   Tipo     

getWhereIns

   list<ListID>  

 

leadTimeline
 

getLeadTimeline 

 Obtém o histórico de eventos do lead. Pode ser filtrado fornecendo restrições. Valores possíveis para o parâmetro eventSource:

   •   emailOpened             •   formSubmit
   •   emailVisit                   •   importantPageVisit
   
Params Name   Type    Is Required   
where  

hash

Required: whoID
Optional: eventName, eventSource, whatType, createTimestamp, whoID

   Required   
       
Return
Data 		Name   Type     

leadTimeline

   list<Event>  

 

 

Outros artigos