addMailing

curl --request POST \
  --url https://{baseUrl}/ipbox/api/addMailing \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form lote=descricao_lote \
  --form importarPrimeiraLinha=importar_primeira_linha \
  --form apagarExistentes=apagar_prospects_existentes_antes_de_importar \
  --form campos=campos_csv \
  --form layout=layout_campos_csv \
  --form separador=separador_usado_no_csv \
  --form prioridade=prioridade_de_discagem \
  --form higienizar=higienizar_mailing \
  --form rodarLote=rodar_lote \
  --form bloquearDownload=bloquear_download \
  --form urlIntegracao=url_integracao \
  --form mailingUra=mailing_ura

import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('lote', 'descricao_lote');
form.append('importarPrimeiraLinha', 'importar_primeira_linha');
form.append('apagarExistentes', 'apagar_prospects_existentes_antes_de_importar');
form.append('campos', 'campos_csv');
form.append('layout', 'layout_campos_csv');
form.append('separador', 'separador_usado_no_csv');
form.append('prioridade', 'prioridade_de_discagem');
form.append('higienizar', 'higienizar_mailing');
form.append('rodarLote', 'rodar_lote');
form.append('bloquearDownload', 'bloquear_download');
form.append('urlIntegracao', 'url_integracao');
form.append('mailingUra', 'mailing_ura');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://{baseUrl}/ipbox/api/addMailing', 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/addMailing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/addMailing"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "<api-key>")

	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/addMailing")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--"

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

{
  "status": "success",
  "data": {
    "id": 88,
    "msg": "import ok"
  }
}

Prospects

addMailing

Importa prospects para um lote de discagem a partir de um arquivo CSV. Processamento assíncrono — para arquivos grandes, acompanhe com getStatusImportacao.

O limite é de linhas, não de tamanho de arquivo: até IMPORT_MAX_NUM_PROSPECTS prospects por importação (configurável em Configurações do IPBoX, padrão de 100.000 em instalações novas; 0 = sem limite). Se ultrapassar, retorna o erro numeroMaximoProspectsUltrapassado.

Coluna `acao` (no CSV):

Valor	Ação
I	Inserir (default) — insere o prospect no lote se ele não existe, ou atualiza se já existe.
M	Manter — mantém o prospect inalterado se ele já existe no lote, ou insere se não existe.
E	Excluir — exclui o prospect do lote, se ele existe.

Se os campos do CSV (campos) ou um layout pré-cadastrado (layout) não forem informados, é usado o layout default abaixo:

acao||codigo||nome||ddd_res||tel_res||ddd_res||tel_res||ddd_res||tel_res||ddd_res||tel_res||ddd_res||tel_res

Exemplo de CSV (layout padrão):

I|682181526|LUIZ OLIVEIRA ANDRADE|11|55678912|11|998345521||||||
M|468246710|DANIEL AUGUSTO DA SILVA|11|77635432|11|976883211|11|42336094||||
E|756648374|JOSE MARCELINO COLATINO|13|677876876|13|98765664|13|35586723||||

POST

ipbox

api

addMailing

curl --request POST \
  --url https://{baseUrl}/ipbox/api/addMailing \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: multipart/form-data' \
  --form lote=descricao_lote \
  --form importarPrimeiraLinha=importar_primeira_linha \
  --form apagarExistentes=apagar_prospects_existentes_antes_de_importar \
  --form campos=campos_csv \
  --form layout=layout_campos_csv \
  --form separador=separador_usado_no_csv \
  --form prioridade=prioridade_de_discagem \
  --form higienizar=higienizar_mailing \
  --form rodarLote=rodar_lote \
  --form bloquearDownload=bloquear_download \
  --form urlIntegracao=url_integracao \
  --form mailingUra=mailing_ura

import requests

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

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--"
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "multipart/form-data"
}

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

print(response.text)

const form = new FormData();
form.append('lote', 'descricao_lote');
form.append('importarPrimeiraLinha', 'importar_primeira_linha');
form.append('apagarExistentes', 'apagar_prospects_existentes_antes_de_importar');
form.append('campos', 'campos_csv');
form.append('layout', 'layout_campos_csv');
form.append('separador', 'separador_usado_no_csv');
form.append('prioridade', 'prioridade_de_discagem');
form.append('higienizar', 'higienizar_mailing');
form.append('rodarLote', 'rodar_lote');
form.append('bloquearDownload', 'bloquear_download');
form.append('urlIntegracao', 'url_integracao');
form.append('mailingUra', 'mailing_ura');

const options = {method: 'POST', headers: {Authorization: '<api-key>'}};

options.body = form;

fetch('https://{baseUrl}/ipbox/api/addMailing', 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/addMailing",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: multipart/form-data"
  ],
]);

$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/addMailing"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--")

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

	req.Header.Add("Authorization", "<api-key>")

	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/addMailing")
  .header("Authorization", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"lote\"\r\n\r\ndescricao_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"importarPrimeiraLinha\"\r\n\r\nimportar_primeira_linha\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"apagarExistentes\"\r\n\r\napagar_prospects_existentes_antes_de_importar\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"campos\"\r\n\r\ncampos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"layout\"\r\n\r\nlayout_campos_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"separador\"\r\n\r\nseparador_usado_no_csv\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"prioridade\"\r\n\r\nprioridade_de_discagem\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"higienizar\"\r\n\r\nhigienizar_mailing\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"rodarLote\"\r\n\r\nrodar_lote\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"bloquearDownload\"\r\n\r\nbloquear_download\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"urlIntegracao\"\r\n\r\nurl_integracao\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"mailingUra\"\r\n\r\nmailing_ura\r\n-----011000010111000001101001--"

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

{
  "status": "success",
  "data": {
    "id": 88,
    "msg": "import ok"
  }
}

Authorizations

Authorization

string

header

required

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

Body

multipart/form-data

arqCsv

string

required

[Obrigatório] Arquivo CSV com os prospects a importar.

Example:

null

lote

string

required

[Obrigatório] Nome do lote de destino.

Example:

"descricao_lote"

importarPrimeiraLinha

string

required

[Obrigatório] "Y" ou "N" — precisa ser explicitamente um dos dois valores (não pode ser omitido nem vazio).

Example:

"importar_primeira_linha"

apagarExistentes

string

required

[Obrigatório] "Y" ou "N" — precisa ser explicitamente um dos dois valores (não pode ser omitido nem vazio).

Example:

"apagar_prospects_existentes_antes_de_importar"

campos

string

[Opcional] Layout das colunas do CSV, separadas por "||" (ex.: acao||codigo||nome||ddd_res||tel_res). Ignorado se layout for informado. Se nenhum dos dois for informado, usa o layout default.

Example:

"campos_csv"

layout

string

[Opcional] Nome de um layout de importação pré-cadastrado no sistema. Tem prioridade sobre campos se ambos forem informados.

Example:

"layout_campos_csv"

separador

string

[Opcional] Caractere separador do CSV. Default: "|" (pipe).

Example:

"separador_usado_no_csv"

prioridade

string

Valores possíveis: CEL_COM_RES, CEL_RES_COM, COM_CEL_RES, COM_RES_CEL, RES_CEL_COM ou RES_COM_CEL> (default: Nenhuma prioridade)

Example:

"prioridade_de_discagem"

higienizar

string

Valores possíveis: Y ou N> (default: N)

Example:

"higienizar_mailing"

rodarLote

string

Valores possíveis: Y ou N> (default: N)

Example:

"rodar_lote"

bloquearDownload

string

Valores possíveis: Y ou N> (default: N)

Example:

"bloquear_download"

urlIntegracao

string

[Opcional] URLs permitidas para integracão. Informar as URLs separadas por ||. Exemplo: crm.com.br||gestao.com.br

Example:

"url_integracao"

mailingUra

string

Valores possíveis: Y ou N> (default: N)

Example:

"mailing_ura"

Response

Importação processada (aguarda alguns segundos e retorna o status inicial — use getStatusImportacao para acompanhar o progresso se demorar mais).

status

enum<string>

Available options:

success,

fail

data

object

Show child attributes

Guias

Webhook - Referência técnica

Referência da API

addMailing

Coluna `acao` (no CSV):

Authorizations

Body

Response