> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ipbox.com.br/llms.txt
> Use this file to discover all available pages before exploring further.
# addMailing
>
Importa no lote especificado os prospects contidos no arquivo csv enviado.
O campo 'acao' no csv é usado para indicar a ação a ser tomada na importação do prospect:
I = Inserir (default)
M = Manter
E = Excluir
A ação I (Inserir) insere o prospect no lote se ele não existe ou atualiza o prospect se ele já existe no lote.
A ação M (Manter) mantém inalterado o prospect se ele já existe no lote ou insere o prospect se ele não existe.
A ação E (Excluir) exclui o prospect se ele existe no lote.
Se os campos do csv ou o layout não forem informados, serão usados os campos 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 CSV (p/ o 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||||
```
###### Response:
msg
Mensagem com o resultado da importação
id
Id da importação
## OpenAPI
````yaml /openapi.yaml post /ipbox/api/addMailing
openapi: 3.0.0
info:
title: IPBoX Api Documentation v1.1
description: >-
Nesse documento são descritos os comandos presentes na API Rest do IPBoX. Os
comandos são executados com chamadas POST e com respostas em formato JSON.
version: 1.0.0
servers:
- url: https://{baseUrl}
description: Dominio (e porta, se houver) do servidor IPBoX do cliente
variables:
baseUrl:
default: cliente.ipboxcloud.com.br:9052
description: >-
Substitua pelo dominio real do seu servidor IPBoX. A maioria dos
servidores usa uma porta especifica - inclua-a junto ao dominio (ex.:
cliente.ipboxcloud.com.br:9052)
security:
- ApiToken: []
tags:
- name: Agente
- name: Ligações
- name: Prospects
- name: Agendamentos
- name: Listas
- name: Filas
- name: Lotes
- name: Relatórios
- name: Outros
- name: Times
- name: Blacklist
- name: Áudios
- name: URAs
paths:
/ipbox/api/addMailing:
post:
tags:
- Prospects
summary: addMailing
description: >-
Importa no lote especificado os prospects contidos no arquivo csv
enviado.
O campo 'acao' no csv é usado para indicar a ação a ser tomada na
importação do prospect:
I = Inserir (default)
M = Manter
E = Excluir
A ação I (Inserir) insere o prospect no lote se ele não existe ou
atualiza o prospect se ele já existe no lote.
A ação M (Manter) mantém inalterado o prospect se ele já existe no lote
ou insere o prospect se ele não existe.
A ação E (Excluir) exclui o prospect se ele existe no lote.
Se os campos do csv ou o layout não forem informados, serão usados os
campos 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 CSV (p/ o 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||||
```
###### Response:
msg
Mensagem com o
resultado da
importação
id
Id da
importação
parameters:
- name: Authorization
in: header
schema:
type: string
example: '{{token}}'
- name: Content-Type
in: header
schema:
type: string
example: multipart/form-data
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
arqCsv:
type: string
description: ''
example: null
lote:
type: string
description: Nome do lote
example: descricao_lote
campos:
type: string
description: >-
[Opcional] Se os campos do csv forem informados, serão
usados na importação. Podem ser usados campos default e
campos do prospect. Informar os campos separados por ||.
Exemplo:
acao||codigo||nome||ddd_res||tel_res||Data de Nascimento||CEP
example: campos_csv
layout:
type: string
description: ''
example: layout_campos_csv
importarPrimeiraLinha:
type: string
description: 'Valores possíveis: Y ou N> (default: N)'
example: importar_primeira_linha
apagarExistentes:
type: string
description: 'Valores possíveis: Y ou N> (default: N)'
example: apagar_prospects_existentes_antes_de_importar
separador:
type: string
description: >-
Valores possíveis: PIPE, VIRGULA ou PONTO_VIRGULA> (default:
PIPE)
example: separador_usado_no_csv
prioridade:
type: string
description: >-
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:
type: string
description: 'Valores possíveis: Y ou N> (default: N)'
example: higienizar_mailing
rodarLote:
type: string
description: 'Valores possíveis: Y ou N> (default: N)'
example: rodar_lote
bloquearDownload:
type: string
description: 'Valores possíveis: Y ou N> (default: N)'
example: bloquear_download
urlIntegracao:
type: string
description: >-
[Opcional] URLs permitidas para integracão. Informar as URLs
separadas por ||. Exemplo: crm.com.br||gestao.com.br
example: url_integracao
mailingUra:
type: string
description: 'Valores possíveis: Y ou N> (default: N) '
example: mailing_ura
required:
- arqCsv
- lote
- campos
- importarPrimeiraLinha
- apagarExistentes
- separador
- prioridade
- higienizar
- rodarLote
- bloquearDownload
- urlIntegracao
- mailingUra
responses:
'200':
description: Successful response
content:
application/json: {}
components:
securitySchemes:
ApiToken:
type: apiKey
in: header
name: Authorization
description: >-
Token gerado em IPBoX > API > Token. Aceita o token puro, ou com prefixo
`Bearer ` / `Basic `.
````