Skip to main content

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 de contacts 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

Se mailingId não for enviado, um mailing será criado automaticamente.

Request

Response


2 — Adicionar contatos ao mailing

Utilize o mailingId retornado anteriormente.

Request

Response


3 — Fechar o mailing

Quando terminar de enviar os contatos, utilize close: true.

Request

Response

Após o mailing ser fechado não será possível adicionar novos contatos.

Regras Importantes

  • Máximo de 1000 contatos por request
  • tipo_de_registro deve ser TELEFONE ou EMAIL
  • valor_do_registro deve ser um telefone válido quando o tipo for TELEFONE, ou um e-mail válido quando o tipo for EMAIL
  • nome_cliente deve conter o nome do cliente
  • cpfcnpj é 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 mailingId retornado na primeira requisição
  • Apenas envie close: true quando tiver certeza de que não haverá novos contatos