Use o método POST para adicionar um novo lead. Segue exemplo de JSON à ser enviado.
{ "clientKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "teamKey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "conversionGoal": "API v2.0", "name": "Lead de teste", "email": "teste@teste.com.br", "message": "Apenas um teste de inserção de lead usando a API v2.0." }
https://www.followize.com.br/api/v2/Leads/
Nome | Tipo | Limite | Descricao |
---|---|---|---|
clientKey | Texto | 32 | Chave do cliente encontrada no menu configurações. |
teamKey | Texto | 32 | Chave da equipe encontrada no menu configurações. |
conversionGoal | Texto | 100 | Identificador do ponto de conversão. Ex.: Formulário de contato, Landing page |
name | Texto | 100 | Nome |
Texto | 200 | E-mail do cliente. Ver a descrição abaixo. | |
phone | Texto | 40 | Telefone do cliente. Ver a descrição abaixo. |
cellPhone | Texto | 40 | Celular do cliente. Ver a descrição abaixo. |
Parâmetros email, phone e cellPhone
Os lead enviados ao Followize, deverão conter pelo menos um desses três parâmetros. Se pelo menos um deles for enviado, os demais serão opcionais:
Exemplos:
Nome | Tipo | Limite | Descricao |
---|---|---|---|
attendantId | Número | 10 | ID do atendente que irá receber o Lead. Obs.: Se identificar o atendente, o rodízio na equipe será ignorado. |
attendantEmail | Texto | 100 | E-mail do atendente que irá receber o Lead. Obs.: Se identificar o atendente, o rodízio na equipe será ignorado. |
message | Texto | ∞ | Mensagem |
hubUtmz | Texto | 632 | Gerado pela TAG de rastreamento. Valor esperado: utmcsr=ORIGEM|utmccn=CAMPANHA|utmcmd=MÍDIA|utmcct=FORMATO| |
addressLine1 | Texto | 200 | Endereço do cliente. |
addressNumber | Texto | 20 | Número do endereço do cliente. |
addressLine2 | Texto | 20 | Complemento do endereço do cliente. |
neighborhood | Texto | 50 | Bairro do cliente. |
city | Texto | 50 | Cidade do cliente. |
state | Texto | 50 | Estado do cliente. |
country | Texto | 50 | País do cliente. |
zipCode | Texto | 9 | CEP do cliente. |
registrationNumber | Texto | 20 | CPF do cliente. |
jobTitle | Texto | 50 | Cargo do cliente. |
companyName | Texto | 100 | Nome da empresa do cliente. |
companyPhone | Texto | 40 | Telefone da empresa do cliente. |
companyEmail | Texto | 150 | E-mail da empresa do cliente. |
companyWebsite | Texto | 150 | Website da empresa do cliente. |
companyRegistrationNumber | Texto | 20 | CNPJ da empresa do cliente. |
socialTwitter | Texto | 50 | Usuário no Twitter do cliente. |
socialFacebook | Texto | 50 | Usuário no Facebook do cliente. |
socialLinkedin | Texto | 50 | Usuário no LinkedIn do cliente. |
socialGoogleplus | Texto | 50 | Usuário no Google Plus do cliente. |
socialSkype | Texto | 50 | Usuário no Skype do cliente. |
socialWhatsapp | Texto | 50 | Número de telefone cadastrado no Whatsapp do cliente. |
productId | Número | 10 | ID do produto cadastrado no Followize. |
productTitle | Texto | 200 | Título do produto. |
productRefer | Número | 10 | ID de referência do produto cadastrado no site e/ou ERP próprio. |
categoryId | Número | 10 | ID da categoria cadastrada no Followize. |
categoryTitle | Texto | 200 | Título da categoria. |
categoryRefer | Número | 10 | ID de referência da categoria cadastrada no site e/ou ERP próprio. |
brandId | Número | 10 | ID da marca cadastrada no Followize. |
brandTitle | Texto | 200 | Título da marca. |
brandRefer | Número | 10 | ID de referência da marca cadastrada no site e/ou ERP próprio. |
locationId | Número | 10 | ID da unidade cadastrada no Followize. |
locationTitle | Texto | 200 | Título da unidade. |
locationRefer | Número | 10 | ID de referência da unidade cadastrada no site e/ou ERP próprio. |
interest1Id | Número | 10 | ID do Interesse 1 cadastrado no Followize. |
interest1Title | Texto | 255 | Título do interesse 1. |
interest2Id | Número | 10 | ID do Interesse 2 cadastrado no Followize. |
interest2Title | Texto | 255 | Título do interesse 2. |
interest3Id | Número | 10 | ID do Interesse 3 cadastrado no Followize. |
interest3Title | Texto | 255 | Título do interesse 3. |
interest4Id | Número | 10 | ID do Interesse 4 cadastrado no Followize. |
interest4Title | Texto | 255 | Título do interesse 4. |
interest5Id | Número | 10 | ID do Interesse 5 cadastrado no Followize. |
interest5Title | Texto | 255 | Título do interesse 5. |
interest6Id | Número | 10 | ID do Interesse 6 cadastrado no Followize. |
interest6Title | Texto | 255 | Título do interesse 6. |
Nome | Tipo | Limite | Descricao |
---|---|---|---|
legalBases | Json | -- | Base legal do lead. |
Tipos de Base | Descrição |
---|---|
Processamento | Informações coletadas por uma empresa com consentimento e/ou necessidade que serão usados para uma ação dentro de um sistema. |
Comunicação | Informa o consentimento do indivíduo permitindo que uma empresa entre em contato, conforme as regras estabelecidas e sem fazer qualquer tipo de spam. |
Base Legal | Descrição |
---|---|
consent | Quando uma pessoa consente com o tratamento dos seus dados, de forma livre, inequívoca e informada. |
legitimate_interest | Quando a empresa possui um interesse legítimo para o processamento e a utilização dos dados está dentro das expectativas da pessoa, não sendo necessário obter consentimento. |
pre_existing_contract | Quando os dados pessoais são processados por obrigação contratual ou para a validação e início de vigência de um acordo. |
legal_obligation | Quando o tratamento de dados pessoais é justificável por Lei. |
health_protection | Quando o tratamento de dados pessoais é feito com o intuito de proteger a vida, seja do titular do dado ou ainda de outra pessoa. |
public_interest | Quando o tratamento de dados pessoais é resguardado pelo interesse público ou por necessidade de uma autoridade oficial. |
"legalBases": {
"processing": {
"name": "consent",
"optIn": "null"
}
"communication": {
"name": "health_protection",
"optIn": "true"
}
}
Observação:
Quando o optIn estiver como true, deverá ser enviado um nome válido de base legal (conforme as bases citadas acima). Se não for enviado um nome de base legal, o lead será inserido com sucesso e a sua base será considerada como “Não informado”.
Quando for enviada uma base legal com o nome inválido ou inexistente o lead não será inserido, retornando um erro.
{
"success": "1",
"error": "0",
"leadId": "2559633",
"leadType": "new"
}
Campo | Descrição |
---|---|
success | 0 ou 1. Indica se houve sucesso. |
error | 0 ou 1. Indica se houve erro. |
leadId | ID do lead gerado. |
leadType | new ou treatment. Informa se o lead é novo ou se é uma interação de um lead existente. |
{
"success": "0",
"error": "4001"
}
Erro | Descrição |
---|---|
4000 | Um ou mais campos obrigatórios não enviados. |
4001 | Chave de cliente inválida. |
4002 | Chave de equipe inválida. |
4003 | Falha ao cadastrar o contato. |
4004 | Nenhum atendente encontrado na equipe enviada. |
4005 | Falha ao cadastrar a conversão. |
4006 | Verificar bases legais. |
Converse com um de nossos consultores, tire suas dúvidas e conheça todas as vantagens do Followize.