Como criar contato utilizando a API

Pré-requisito:

• Como se integrar a API da Mailerweb

1. Criando uma Lista Estática

Criaremos uma lista estática onde, obrigatoriamente, devemos associar os contatos.

Para interagir com a lista estática, criaremos os seguintes endpoint e parâmetros:

POST: /api/v1/contacts/static_list/

Resposta esperada:

Obs.: A ID da Lista Estática está nos atributos “ID” e “resource_url” (que poderá acessar os detalhes da lista a partir do endpoint) e será utilizada para criar os contatos na base da Mailerweb.
 

2.  Criando os contatos

Com a lista estática criada, você adicionará os contatos:

POST: /api/v1/contacts/contact/

Obs. 1: O atributo “tag_list”, necessariamente, tem que receber o valor dentro dos colchetes;
Obs. 2: O campo e-mail deve conter um e-mail válido.

Resultado esperado:

• Campo “status”: valor "ok" - sucesso na criação do contato.
• Campo “opt_out”: False - contato optou por não sair da lista de recebimento.
• Campo “ip_address_inclusion”: endereço IP de origem na inclusão do contato.
   

Havendo algum erro de digitação no campo “e-mail”, a API devolverá uma mensagem de e-mail incorreto:

Variações de erros ao tentar incluir um contato:

• Valor incorreto para a lista: verifique novamente o valor no campo “tag_list” ou crie uma lista com esse valor. Possivelmente um contato foi associado com ID incorreto ou a uma lista inexistente;
• Contato não atribuído a uma Lista Estática: deve-se informar, no campo “tag_list”, as listas nas quais o contato deve ser incluído;
• E-mail existente na base de dados: para atualização dos dados, informe o parâmetro “update”. É provável que você esteja tentando criar um contato que já existe;
• E-mail inválido e não pode receber mensagens: possivelmente o e-mail do contato não existe, e a operação não será permitida. Ou tente remover da lista de supressão, no Painel de Controle;
• Telefone com formato inválido: verifique se o número do telefone está correto.
   

DICA!!!

É precisa adicionar o dicionário “data”, caso queira criar um contato com um campo customizado:

Obs.: O campo "gender” deverá ser adicionado como campo customizado, e depois será feita a inclusão do contato. Se o campo customizado não existir, o dado será ignorado.