Ajuda

Você poderá criar remetentes para campanhas de envio de e-mail marketing 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 Remetente Campanha de Envio de E-mail Marketing

Com esse método você poderá criar remetentes para as suas campanha de e-mail marketing, é uma condição necessário para que você possa realizar os envios.

Para interagir com as remetentes de envio de e-mail marketing, vamos criar o objeto com os seguintes parâmetros e com o seguinte endpoint:

• Campo "name" é utilizado apenas para identificar a nome do remetente, por exemplo, "João da Silva"
• Campo "email" é utilizado para você designar o remetente que será utilizado nessa mensagem, ele deve ser um e-mail autenticado e configurado. Ao criar o remetente, o sistema vai enviar automaticamente uma mensagem solicitando a confirmação por meio de clique em um link, caso você já tenha configurado os domínios de envio através de autenticação por chave DKIM, SPF e DMARC essa autenticação não será mais realizada.

POST: /api/v1/campaigns/sender/

{
    "name": "João da Silva",
    "email": "joao@dominio.com.br"
}

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/campaigns/sender/ 

O resultado esperado será semelhante ao JSON abaixo:

{
    "email": "joao@dominio.com.br",
    "id": id-sender,
    "name": "João da Silva",
    "resource_uri": "/api/v1/campaigns/sender/id-sender/"
}

Repare que o ID do remetente de envio 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 da Campanha de Envio de E-mail Marketing, vamos ao Passo 2:

Passo 2 - Listando os Remetentes de Envio de E-mail Marketing existentes

Para visualizar todas as campanhas de envio de e-mail marketing 

GET: /api/v1/campaigns/sender/

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/sender/ 

O resultado será semelhante a esse

{
    "meta": {
        "limit": 10,
        "next": null,
        "offset": 0,
        "previous": null,
        "total_count": 9
    },
    "objects": [
        {
            "email": "joao@dominio.com.br",
            "id": id-sender,
            "name": "João da Silva",
            "resource_uri": "/api/v1/campaigns/sender/id-sender/"
        },
        ...
    ]
}

Importante notar que será exibido um objeto no formato JSON, onde virão 2 dicionários: meta e objects, a saber:

• Em "meta" você terá uma visão geral de quantos objetos você possui e ainda o link da próxima página do objeto, isso estará no atributo "next" do dicionário;
• Em objects, você terá um detalhe completo do objeto carregado no campo resource_uri, terá o link para chamar para a atualização desse objeto.

Você também poderá consultar objetos de acordo com os atributos existentes nesse formulário, por exemplo:

Listando os modelos por ID do Remetente:

GET: /api/v1/campaigns/sender/?id=xxx

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/sender/?id=xxxx 

Listando os remetentes por nome:

GET: /api/v1/campaigns/sender/?name=teste

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/sender/?name=teste 

Listando os remetentes de email:

GET: /api/v1/campaigns/email_template/?email=joao@dominio.com.br

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:API_KEY"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/sender/?email=joao@dominio.com.br

Passo 3 - Atualizando um Remetente de Envio de E-mail Marketing

Você pode necessitar alterar um remetente de envio de e-mail marketing, nesse caso você utilizar o método PATCH com os parâmetros abaixo:

PATCH: /api/v1/campaigns/sender/XXX58/

data = {
   'email': 'joao.silva@dominio.com.br'
}

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/campaigns/email_campaign/XXX58/ 

IMPORTANTE: Se o seu domínio não estiver com o dominio configurado com nossas informações de DKIM e SPF, será enviado um e-mail solicitando a confirmação através de um link.

Passo 4: Solicitando a validação do Remetente de Envio de E-mail Marketing

Ao criar o domínio o sistema automaticamente dispara um e-mail ao endereço cadastrado solicitando uma validação. Caso não tenha recebido é possível fazer uma nova solicitação através do endpoint:

GET: /api/v1/campaigns/sender/validate/XXX58/

curl --dump-header - -H "Content-Type: application/json" \ -H "Authorization: ApiKey username:api_key"\ -X GET --data data https://painel.mailerweb.com.br/api/v1/campaigns/sender/validate/XXX58/

O resultado será algo semelhante a:

{
    "message": "A message was sent to the e-mail atendimento@mailerweb.com.br requesting a confirmation"
}

Caso haja algum problema com o cadastro um erro do tipo 401,403 será exibido.