API

v2.0

Leads

Adicionando um novo lead

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."
}

Rota

https://www.followize.com.br/api/v2/Leads/

Parâmetros obrigatórios

Nome Tipo Limite Descrição
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.
name Texto 100 Nome do cliente.
email Texto 150 E-mail do cliente.

Parâmetros opcionais

Nome Tipo Limite Descrição
message Texto Mensagem
hubUtmz Texto 632 Gerado pela TAG de rastreamento. Valor esperado: utmcsr=ORIGEM|utmccn=CAMPANHA|utmcmd=MÍDIA|utmcct=FORMATO|
phone Texto 40 Telefone do cliente.
cellPhone Texto 40 Celular do cliente.
addressLine1 Texto 200 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.
companyWebsite Texto 150 Website 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.
emailOptIn Booleano (0=não, 1=sim) Cliente aceita ou não receber email marketing.
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.

Respostas

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.

Exemplos

PHP

<?php
	$apiURL = "https://www.followize.com.br/api/v2/Leads/";

	$data["clientKey"] = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
	$data["teamKey"] = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx";
	$data["conversionGoal"] = "API v2.0";
	$data["name"] = $_POST["name"];
	$data["email"] = $_POST["email"];

	$data["message"] = $_POST["message"];
	$data["hubUtmz"] = $_POST["hubUtmz"];

	$data = json_encode($data);

	$curl = curl_init();
	curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);
	curl_setopt($curl, CURLOPT_URL, $apiURL);
	curl_setopt($curl, CURLOPT_HEADER, false);
	curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, false);
	curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, false);
	curl_setopt($curl, CURLOPT_POST, true);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $data);
	$result = json_decode(curl_exec($curl), true);
	curl_close($curl);

	if ($result["success"] == 1){
		echo "Lead inserido com sucesso.";
	} else {
		echo "Houve um erro na inserção do lead.";
	}
?>

Clique aqui e faça o download desse exemplo.

Seja um de nossos parceiros e aumente seus lucros.