Você poderá criar Listas Estáticas de forma programática utilizando a nossa API de gestão de contatos e campanhas, utilize os métodos abaixo para começar a criar conteúdo em nossa plataforma de envio de e-mail marketing,
Para se integrar à API é necessário que você esteja autenticado e para isso é importante que você tenha acesso ao artigo "Como se integrar a API da MailerWeb?".
Passo 1 - Criando uma Lista Estática
Com esse método você poderá criar as listas estáticas para serem utilizadas em suas campanhas de E-mail, SMS e WhatsApp Marketing.
Para interagir com as Listas Estáticas, vamos criar o objeto com os seguintes parâmetros e com o seguinte endpoint:
Campo "name" é utilizado apenas para identificar a nome da lista que está sendo criada.
POST: /api/v1/contacts/static_list/
"name": "Lista 01"
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X POST --data data https://painel.mailerweb.com.br/api/v1/contacts/static_list/
"contacts_hard_bounce": 0,
"contacts_soft_bounce": 0,
"contacts_valids": 1,
"date_created": "2015-06-23",
"id": id-static-list,
"last_updated": "2020-11-11",
"name": "Lista 01",
"resource_uri": "/api/v1/contacts/static_list/id-static-list/",
"total_contacts": 1
Repare que o ID da Lista Estática está no atributo ID e no atributo resource_url, onde você poderá acessar os detalhes dessa campanha a partir do endpoint entregue por esse parâmetro.
Agora que você está de posse do ID da Lista Estática, vamos ao Passo 2:
Passo 2 - Listando as Listas Estáticas existentes
Para visualizar todas as listas estática registradas em sua base.
GET: /api/v1/contacts/static_list/
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET https://painel.mailerweb.com.br/api/v1/contacts/static_list/
"total_count": 139
"name": "Stormers",
Listando as listas estáticas por ID:
GET: /api/v1/contacts/static_list/?id=xxx
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET https://painel.mailerweb.com.br/api/v1/contacts/static_list/?id=xxxx
Listando as listas estáticas por nome:
GET: /api/v1/contacts/static_list/?name=teste
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET https://painel.mailerweb.com.br/api/v1/contacts/static_list/?name=teste
Passo 3 - Atualizando uma Lista Estática
Você pode necessitar alterar o nome da Lista Estática, nesse caso você utilizar o método PATCH com os parâmetros abaixo:
PATCH: /api/v1/contacts/static_list/XXX58/
'name': 'Teste 02'
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X PATCH --data data https://painel.mailerweb.com.br/api/v1/contacts/static_list/XXX58/
A resposta será o objeto entregue com os dados atualizados, caso contrário será retornado o erro 401.
Agora você poderá utilizar o ID da Lista Estática para criar sua campanha de envio de e-mail, sms e WhatsApp Marketing.
Passo 4 - Excluindo uma Lista Estática
Você poderá excluir um critério de uma lista dinâmica a partir do método delete, conforme exemplo a seguir
DELETE: /api/v1/contacts/static_list/id-da-lista-estática/
curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X DELETE https://painel.mailerweb.com.br/api/v1/contacts/static_list/id-da-lista-estatica/
IMPORTANTE: Ao excluir uma lista estática, todos os contatos atrelados a ela terão sua identificação removida, se o contato ficar sem nenhuma lista, ele será excluído da sua base de contatos (Contato Órfão).