Visão Geral
A API permite importar contatos em lote para um mailing. Principais características:- Importação de até 1000 contatos por requisição
- Criação automática de mailing no primeiro envio
- Envio incremental de contatos
- Possibilidade de fechar o mailing quando a importação terminar
Endpoint
Headers
Estrutura da Requisição
Body
Parâmetros
* obrigatório a partir do segundo envio
** obrigatório apenas no primeiro envio
Observação sobre os campos do contato
Os campos decontacts não precisam ser enviados em maiúsculo.
Exemplo válido: tipo_de_registro e TIPO_DE_REGISTRO.
Também são válidos os valores telefone e email em tipo_de_registro.
Fluxo de Uso
1 — Criar um novo mailing
SemailingId não for enviado, um mailing será criado automaticamente.
Request
Response
2 — Adicionar contatos ao mailing
Utilize omailingId retornado anteriormente.
Request
Response
3 — Fechar o mailing
Quando terminar de enviar os contatos, utilizeclose: true.
Request
Response
Regras Importantes
- Máximo de 1000 contatos por request
tipo_de_registrodeve serTELEFONEouEMAILvalor_do_registrodeve ser um telefone válido quando o tipo forTELEFONE, ou um e-mail válido quando o tipo forEMAILnome_clientedeve conter o nome do clientecpfcnpjé opcional, mas quando enviado deve ser um CPF/CNPJ válido- Os demais campos são opcionais
- Mailings fechados não aceitam novos contatos
Códigos de Resposta
Exemplos de Erro
Contatos ausentes
Limite excedido
Contrato inválido de contato
Valor incompatível com o tipo_de_registro
CPF/CNPJ inválido
Mailing fechado
Boas Práticas
- Utilize batches entre 500 e 1000 contatos
- Guarde o
mailingIdretornado na primeira requisição - Apenas envie
close: truequando tiver certeza de que não haverá novos contatos