insertProspect

curl --request POST \
  --url https://{baseUrl}/ipbox/api/insertProspect \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data lote=loteId \
  --data nome=nome \
  --data foneres=foneres \
  --data fonecel=fonecel \
  --data fonecom=fonecom \
  --data codigo=codigo \
  --data data_retorno=data_retorno \
  --data usuario_retorno=usuario_retorno \
  --data origem=origem \
  --data midia=midia \
  --data chave=palavra_chave \
  --data cliente=ja_e_cliente \
  --data cidade=cidade \
  --data cep=cep \
  --data site=site \
  --data email=email \
  --data mensagem=mensagem \
  --data plano=plano \
  --data rodar_lote=rodar_lote \
  --data telefone=telefone \
  --data tipo_pessoa=tipo_pessoa \
  --data tipo_carro=tipo_carro \
  --data marca=marca \
  --data modelo=modelo \
  --data ano=ano

import requests

url = "https://{baseUrl}/ipbox/api/insertProspect"

payload = {
    "lote": "loteId",
    "nome": "nome",
    "foneres": "foneres",
    "fonecel": "fonecel",
    "fonecom": "fonecom",
    "codigo": "codigo",
    "data_retorno": "data_retorno",
    "usuario_retorno": "usuario_retorno",
    "origem": "origem",
    "midia": "midia",
    "chave": "palavra_chave",
    "cliente": "ja_e_cliente",
    "cidade": "cidade",
    "cep": "cep",
    "site": "site",
    "email": "email",
    "mensagem": "mensagem",
    "plano": "plano",
    "rodar_lote": "rodar_lote",
    "telefone": "telefone",
    "tipo_pessoa": "tipo_pessoa",
    "tipo_carro": "tipo_carro",
    "marca": "marca",
    "modelo": "modelo",
    "ano": "ano"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    lote: 'loteId',
    nome: 'nome',
    foneres: 'foneres',
    fonecel: 'fonecel',
    fonecom: 'fonecom',
    codigo: 'codigo',
    data_retorno: 'data_retorno',
    usuario_retorno: 'usuario_retorno',
    origem: 'origem',
    midia: 'midia',
    chave: 'palavra_chave',
    cliente: 'ja_e_cliente',
    cidade: 'cidade',
    cep: 'cep',
    site: 'site',
    email: 'email',
    mensagem: 'mensagem',
    plano: 'plano',
    rodar_lote: 'rodar_lote',
    telefone: 'telefone',
    tipo_pessoa: 'tipo_pessoa',
    tipo_carro: 'tipo_carro',
    marca: 'marca',
    modelo: 'modelo',
    ano: 'ano'
  })
};

fetch('https://{baseUrl}/ipbox/api/insertProspect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{baseUrl}/ipbox/api/insertProspect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{baseUrl}/ipbox/api/insertProspect"

	payload := strings.NewReader("lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/insertProspect")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/ipbox/api/insertProspect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 501
  }
}

Prospects

insertProspect

Insere (ou atualiza, se já existir um prospect com o mesmo codigo no lote) um novo prospect no lote especificado.

Ao menos um dos quatro campos de telefone deve ser informado: telefone, foneres, fonecel ou fonecom.

Os campos de dados adicionais (origem, midia, chave, cliente, cep, site, email, mensagem, tipo_pessoa, tipo_carro, marca, modelo, ano, cidade, plano) são opcionais e mapeados para campos customizados de prospect configurados no sistema — um campo informado aqui sem o campo customizado correspondente configurado é simplesmente ignorado (não gera erro).

POST

ipbox

api

insertProspect

curl --request POST \
  --url https://{baseUrl}/ipbox/api/insertProspect \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data lote=loteId \
  --data nome=nome \
  --data foneres=foneres \
  --data fonecel=fonecel \
  --data fonecom=fonecom \
  --data codigo=codigo \
  --data data_retorno=data_retorno \
  --data usuario_retorno=usuario_retorno \
  --data origem=origem \
  --data midia=midia \
  --data chave=palavra_chave \
  --data cliente=ja_e_cliente \
  --data cidade=cidade \
  --data cep=cep \
  --data site=site \
  --data email=email \
  --data mensagem=mensagem \
  --data plano=plano \
  --data rodar_lote=rodar_lote \
  --data telefone=telefone \
  --data tipo_pessoa=tipo_pessoa \
  --data tipo_carro=tipo_carro \
  --data marca=marca \
  --data modelo=modelo \
  --data ano=ano

import requests

url = "https://{baseUrl}/ipbox/api/insertProspect"

payload = {
    "lote": "loteId",
    "nome": "nome",
    "foneres": "foneres",
    "fonecel": "fonecel",
    "fonecom": "fonecom",
    "codigo": "codigo",
    "data_retorno": "data_retorno",
    "usuario_retorno": "usuario_retorno",
    "origem": "origem",
    "midia": "midia",
    "chave": "palavra_chave",
    "cliente": "ja_e_cliente",
    "cidade": "cidade",
    "cep": "cep",
    "site": "site",
    "email": "email",
    "mensagem": "mensagem",
    "plano": "plano",
    "rodar_lote": "rodar_lote",
    "telefone": "telefone",
    "tipo_pessoa": "tipo_pessoa",
    "tipo_carro": "tipo_carro",
    "marca": "marca",
    "modelo": "modelo",
    "ano": "ano"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/x-www-form-urlencoded"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: '<api-key>',
    'Content-Type': 'application/x-www-form-urlencoded'
  },
  body: new URLSearchParams({
    lote: 'loteId',
    nome: 'nome',
    foneres: 'foneres',
    fonecel: 'fonecel',
    fonecom: 'fonecom',
    codigo: 'codigo',
    data_retorno: 'data_retorno',
    usuario_retorno: 'usuario_retorno',
    origem: 'origem',
    midia: 'midia',
    chave: 'palavra_chave',
    cliente: 'ja_e_cliente',
    cidade: 'cidade',
    cep: 'cep',
    site: 'site',
    email: 'email',
    mensagem: 'mensagem',
    plano: 'plano',
    rodar_lote: 'rodar_lote',
    telefone: 'telefone',
    tipo_pessoa: 'tipo_pessoa',
    tipo_carro: 'tipo_carro',
    marca: 'marca',
    modelo: 'modelo',
    ano: 'ano'
  })
};

fetch('https://{baseUrl}/ipbox/api/insertProspect', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{baseUrl}/ipbox/api/insertProspect",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/x-www-form-urlencoded"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{baseUrl}/ipbox/api/insertProspect"

	payload := strings.NewReader("lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{baseUrl}/ipbox/api/insertProspect")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/x-www-form-urlencoded")
  .body("lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{baseUrl}/ipbox/api/insertProspect")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/x-www-form-urlencoded'
request.body = "lote=loteId&nome=nome&foneres=foneres&fonecel=fonecel&fonecom=fonecom&codigo=codigo&data_retorno=data_retorno&usuario_retorno=usuario_retorno&origem=origem&midia=midia&chave=palavra_chave&cliente=ja_e_cliente&cidade=cidade&cep=cep&site=site&email=email&mensagem=mensagem&plano=plano&rodar_lote=rodar_lote&telefone=telefone&tipo_pessoa=tipo_pessoa&tipo_carro=tipo_carro&marca=marca&modelo=modelo&ano=ano"

response = http.request(request)
puts response.read_body

{
  "data": {
    "id": 501
  }
}

Authorizations

Authorization

string

header

required

Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo Bearer / Basic.

Body

application/x-www-form-urlencoded

lote

string

required

Id do lote.

Example:

"loteId"

nome

string

required

Nome do prospect.

Example:

"nome"

foneres

string

[Ao menos um entre telefone/foneres/fonecel/fonecom deve ser informado] Telefone residencial no formato DDD+Numero, exemplo: 11994744333.

Example:

"foneres"

fonecel

string

[Ao menos um entre telefone/foneres/fonecel/fonecom deve ser informado] Telefone celular no formato DDD+Numero, exemplo: 11994744333.

Example:

"fonecel"

fonecom

string

[Ao menos um entre telefone/foneres/fonecel/fonecom deve ser informado] Telefone comercial no formato DDD+Numero, exemplo: 11994744333.

Example:

"fonecom"

codigo

string

[Opcional] Codigo do Prospect; se nao for informado, sera gerado um codigo automaticamente

Example:

"codigo"

data_retorno

string

[Opcional] Data e hora do agendamento no formato DD/MM/AAAA HH:MM

Example:

"data_retorno"

usuario_retorno

string

[Opcional] Login/username do agente do agendamento (se específico)

Example:

"usuario_retorno"

origem

string

[Opcional] Campo customizado — Origem só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"origem"

midia

string

[Opcional] Campo customizado — Mídia só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"midia"

chave

string

[Opcional] Campo customizado — Palavra Chave só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"palavra_chave"

cliente

string

[Opcional] Campo customizado — Já Cliente só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"ja_e_cliente"

cidade

string

[Opcional] Campo customizado — Cidade só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"cidade"

cep

string

[Opcional] Campo customizado — CEP só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"cep"

site

string

[Opcional] Campo customizado — Site só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"site"

string

[Opcional] Campo customizado — E-Mail só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"email"

mensagem

string

[Opcional] Campo customizado — Mensagem só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"mensagem"

plano

string

[Opcional] Campo customizado — Plano Escolhido só é gravado se o campo de prospect correspondente estiver configurado no sistema.

Example:

"plano"

rodar_lote

string

[Opcional] Alterar status do lote para RODANDO (Y ou N) - default: Y

Example:

"rodar_lote"

telefone

string

[Ao menos um entre telefone/foneres/fonecel/fonecom deve ser informado] Telefone genérico no formato DDD+Numero — tratado internamente como telefone residencial.

Example:

"telefone"

tipo_pessoa

string