📝 Conceitos básicos

Ao longo desta documentação, apresentaremos termos relacionados à nossa ferramenta que são importantes para a compreensão de cada comando. Abaixo seguem estas definições:

Contato:

Um contato é um registro dentro de uma lista. O campo mínimo e obrigatório de um contato é o seu e-mail. Um contato pode ter informações adicionais, chamadas de “campo personalizado”.

Campo personalizado:

Cada informação adicional de um contato além dos campos padrão já existentes. O campo personalizado é criado sempre dentro de alguma Lista e pode ser uma informação específica do seu negócio.

Usuário:

Um usuário é um cliente da Flowbiz, ou seja, é o contratante dos nossos serviços.

Lista:

É onde são armazenados os contatos de cada conta de usuário. É possível ter diversas listas dentro da ferramenta de modo a utilizá-las de diversas formas. Por padrão a plataforma cria as listas de Clientes e Assinantes.

Segmento:

É um filtro (ou visão) dentro de uma lista, formulado a partir de uma regra que o usuário define. Cada lista pode ter infinitos segmentos.

Campanha:

É uma ação promocional de marketing (e-mail) direcionada a uma ou mais listas de contatos podendo ter segmentações.

🚧

Atenção

Os Endpoints podem variar para cada cliente!

Exemplo:

  • https://mbiz.mailclick.me/api.php
  • https://news.mailclick.me/api.php

Consulte o Endpoint a ser utilizado antes de realizar a integração.
Para testes com a API na plataforma ReadMe, é utilizado o Endpoint: https://mbiz.mailclick.me/api.php