O poder de integrar
EnvíaloSimple
+ HTTP API
+ Documentação
= Integração fácil
API EnvíaloSimple
Nossa nova API permitirá que você integre o EnvíaloSimple com todos os seus aplicativos por meio de chamadas simples a URLs, oferecendo inúmeras funcionalidades, agrupadas por módulos para facilitar seu uso e implementação.
Você poderá enviar suas campanhas de email marketing; criar, modificar e excluir contatos, listas de contatos e campanhas; consultar estatísticas e relatórios, e muitas outras funcionalidades para que possa integrá-lo com seus aplicativos.
Postman
Se você usa Postman, disponibilizamos a coleção de métodos para que importe em seu ambiente.
Configuração de variáveis
Nossa coleção de métodos necessita da parametrização das seguintes variáveis do Postman para seu correto funcionamento:
| Nome | Valor |
|---|---|
| url | https://api.esmsv.com |
| token | I6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsIntyuHVlIjoiMm9y… |
Autenticação
Para utilizar a nova API, você deve possuir uma Api key. Para isso, deve acessar sua conta, ir em Configuração > Chave Api e gerar uma nova chave.
Ao utilizar os serviços, o método authorization deve estar presente no header, onde você deve enviar essa chave (token).
Exemplo:
curl --location --request GET 'https://api.esmsv.com/v1/administrator/profile' --header 'Authorization: eyJpdiI6Ik9UZzFNakUyTVRVME9USXpNVGM0TUE9PSIsInZhbHVlIjoiMm9yaGZPYzZqNjVwL1haakw5SlovakNKcEZCeWpGaBcDEfGhIjklMNopqMD0iLCJtYWMiOiJhODVmNDgxZWUxYWoPu2Jktm1MjU0ZDhmNmUzMjA3NDliOGQwYWJkZWFlMjFkNDA4NmNiODRhMjYxIn0='
Esclarecimento: Se você já usava a API anterior e tinha uma chave criada, não poderá usar a mesma, devendo criar uma nova.
Resposta
Todas as respostas terão duas seções: status e code.
Adicionalmente, conforme o tipo de serviço, serão adicionadas outras seções que serão detalhadas em cada um deles.
| Nome | Descrição |
|---|---|
| status | Aqui aparecerá o valor “ok” quando o processo for executado corretamente e “error” quando houver algum erro. |
| code | Aqui aparecerá a mensagem de sucesso quando o processo for executado corretamente ou um detalhe quando houver erros. |
Erros
Existem dois tipos de erros: de validação de dados de entrada (COD 422) e os particulares de cada serviço (COD 400). A seguir são detalhados os erros de validação (COD 422) que são comuns a todos os serviços:
| Código | Descrição |
|---|---|
| is_not_accepted | Valor não aceito. |
| invalid_url | URL inválida. |
| invalid_date | Data incorreta. |
| invalid_alpha_format | O valor deve conter apenas letras. |
| invalid_alpha_dash_format | O valor deve conter apenas letras, números, traços e sublinhados. |
| invalid_alpha_num_format | O valor deve conter apenas letras e números. |
| invalid_array_format | O valor deve ser um array. |
| attached | Este campo já foi anexado. |
| before_date | O valor deve ser uma data anterior. |
| before_or_equal_date | O valor deve ser uma data anterior ou igual. |
| invalid_between_elements | Quantidade de elementos inválida. |
| invalid_between_size_file | Tamanho do arquivo inválido. |
| invalid_between_number | Valor inválido. |
| invalid_between_characters | Quantidade de caracteres inválida. |
| invalid_boolean | O valor deve ser true ou false. |
| invalid_value_confirmed | Valor confirmado inválido. |
| invalid_date_format | Formato de data inválido. |
| invalid_date_equal | Data incorreta. |
| invalid_value_different | O valor deve ser diferente. |
| invalid_value_digits | Quantidade de dígitos inválida. |
| invalid_value_digits_between | Quantidade de dígitos inválida. |
| invalid_image_dimensions | Dimensões da imagem inválidas. |
| value_duplicate | Valor duplicado. |
| invalid_email_format | O formato do email está incorreto. |
| invalid_velue_ends_with | O valor inserido está incorreto. |
| not_exists | O campo é inválido. |
| is_not_file | O campo deve ser um arquivo. |
| not_empty | O campo é obrigatório. |
| invalid_gt_elements | Quantidade de elementos inválida. |
| invalid_gt_size_file | Tamanho do arquivo inválido. |
| invalid_gt_numeric | Valor incorreto. |
| invalid_gt_characters | Quantidade de caracteres inválida. |
| invalid_gte_elements | Quantidade de elementos inválida. |
| invalid_gte_size_file | Tamanho do arquivo inválido. |
| invalid_gte_numeric | Valor inválido. |
| invalid_gte_characters | Quantidade de caracteres inválida. |
| invalid_image | O campo deve ser uma imagem. |
| invalid_value_in | Valor inválido. |
| invalid_value_in_array | Valor inválido. |
| invalid_value_integer | O campo deve ser um número inteiro. |
| invalid_value_ip | O campo deve ser um endereço IP válido. |
| invalid_ipv4_format | O campo deve ser um endereço IPv4 válido. |
| invalid_ipv6_format | O campo deve ser um endereço IPv6 válido. |
| invalid_json_format | O campo deve ser uma string JSON válida. |
| invalid_lt_elements | Quantidade de elementos inválida. |
| invalid_lt_size_file | Tamanho do arquivo inválido. |
| invalid_lt_numeric | Valor inválido. |
| invalid_lt_characters | Quantidade de caracteres inválida. |
| invalid_lte_elements | Quantidade de elementos inválida. |
| invalid_lte_size_file | Tamanho do arquivo inválido. |
| invalid_lte_numeric | Valor inválido. |
| invalid_lte_characters | Quantidade de caracteres inválida. |
| invalid_max_elements | Quantidade de elementos inválida. |
| invalid_max_size_file | Tamanho do arquivo inválido. |
| invalid_max_numeric | Valor inválido. |
| invalid_max_characters | Quantidade de caracteres inválida. |
| invalid_mimes | Formato de arquivo inválido. |
| invalid_mimetypes | Formato de arquivo inválido. |
| invalid_min_elements | Quantidade de elementos inválida. |
| invalid_min_size_file | Tamanho do arquivo inválido. |
| invalid_min_numeric | Valor inválido. |
| invalid_min_characters | Quantidade de caracteres inválida. |
| multiple_of | Valor inválido. |
| invalid_format | Formato de campo inválido. |
| only_numeric | O campo deve ser numérico. |
| invalid_password | Senha incorreta. |
| is_not_present | O campo deve estar presente. |
| prohibited | O campo está proibido. |
| prohibited_if | O campo está proibido. |
| prohibited_unless | O campo está proibido. |
| relatable | O campo não pode ser associado a este recurso. |
| required | O campo é obrigatório. |
| is_not_same_that | Os campos devem coincidir. |
| invalid_count_elements | Quantidade de elementos inválida. |
| invalid_size_file | Tamanho do arquivo inválido. |
| invalid_size_number | Valor inválido. |
| invalid_count_characters | Quantidade de caracteres inválida. |
| invalid_value | Valor inválido. |
| only_characters | O campo deve ser uma cadeia de caracteres. |
| invalid_timezone | O campo deve ser um fuso horário válido. |
| is_used | O campo já foi registrado. |
| error_upload_file | Erro ao enviar o arquivo. |
| invalid_url_format | O formato tipo URL do campo é inválido. |
| invalid_uuid_format | O campo deve ser um UUID válido. |
Arquivos 6
Description
Retorna uma lista das suas imagens. Podem ser filtradas por nome ou por uma pasta.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da imagem. |
| name | Nome da imagem. |
| extension | Extensão da imagem. |
| folder | ID da pasta onde se encontra. |
| file | URL da imagem. |
| created_date | Data de upload. |
| thumbnail | URL da miniatura. |
Body
| Key | Value | Description |
|---|---|---|
| name | creative | Filtro por nome da imagem. |
| folder | 6926fd0ed8209d19b623115b | Filtro por ID da pasta. Os IDs das pastas são obtidos em: Obter coleção de pastas. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar as imagens. Valores possíveis: name | extension | created_date. Por padrão: created_date. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna uma lista das pastas das suas imagens. Podem ser filtradas por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da pasta |
| name | Nome da pasta |
Body
| Key | Value | Description |
|---|---|---|
| name | Folhetos | Filtrar por nome da pasta. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: asc. Sempre ordena por nome da pasta. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
Description
Retorna uma lista dos seus documentos. Podem ser filtrados por nome ou por uma pasta.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do documento |
| name | Nome do documento |
| extension | Extensão do documento |
| folder | ID da pasta onde se encontra. |
| file | URL do documento. |
| created_date | Data de upload. |
Body
| Key | Value | Description |
|---|---|---|
| name | catálogo | Filtro por nome do documento. |
| folder | 6926fd0ed8209d19b628515b | Filtro por ID da pasta. Os IDs das pastas são obtidos em: Obter coleção de pastas. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar os documentos. Valores possíveis: nome | extensão | data_criação. Por padrão: data_criação. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna uma lista das pastas dos seus documentos. Podem ser filtradas por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da pasta |
| name | Nome da pasta |
Body
| Key | Value | Description |
|---|---|---|
| name | Logos | Filtrar por nome da pasta. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: asc. Sempre ordena por nome da pasta. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
Description
Retorna uma lista dos seus blocos salvos. Podem ser filtrados por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do bloco. |
| name | Nome do bloco. |
| thumbnail | URL da miniatura. |
| created_date | Data de upload. |
Body
| Key | Value | Description |
|---|---|---|
| name | desusc | Filtro por nome do bloco. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar os blocos. Valores possíveis: name | created_date. Por padrão: created_date. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe de um bloco.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do bloco |
| name | Nome do bloco |
| created_date | Data de criação |
| thumbnail | Url da miniatura |
| html | Html do conteúdo |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_blockNotFound | Não existe bloco com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| block_id | 69459a53e1b805319487ba83 | Id do bloco. Obrigatório. |
Automations 15
Este módulo permitirá que você realize toda a gestão associada a automations desde a criação até a ativação.
Description
Retorna uma lista de todas as automações. Podem ser filtradas por vários campos: nome, estado e data de criação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação |
| name | Título da automação |
| created | Data de criação da automação |
| schedule_type | Tipo de envio. Valores possíveis: AutoresponderInmediate -> Assim que o evento for detectado AutoresponderDeferred-> Programado |
| days_of_the_week | Dias da semana em que pode ser enviado |
| moment | Momento em que a automação será enviada. Valores possíveis: after -> Depois de before -> Antes de onDay -> No dia Só é exibido se Tipo de envio = Programado |
| days | Quantidade de dias. Só é exibido se Tipo de envio = Programado e Momento = Antes de ou Depois de. |
| hour | Hora de envio. Só é exibido se Tipo de envio = Programado |
| event | Evento disparador. Veja os possíveis valores em: Obter eventos disparadores de automação. |
| status | Estado da automação. Valores possíveis: Draft -> Rascunho Paused -> Pausado Stopped -> Parado PendingforApproval -> Pendente de aprovação Sending -> Ativo |
Body
| Key | Value | Description |
|---|---|---|
| filter | teste | Filtro por nome ou parte do nome do automation. |
| status | Sending | Filtro por estado da automação. Valores possíveis: Draft (Rascunho) / Sending (Ativo) / Paused (Pausado) / PendingForApproval (Pendente de aprovação) / Stopped (Parado) |
| createDateFrom | 2023-04-23 | Filtro por data de criação a partir de. Formato: YYYY-MM-DD. |
| createDateTo | 2023-05-28 | Filtro por data de criação até. Formato: YYYY-MM-DD. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar as automações. Valores possíveis: name/id. Por padrão: id. |
| order | desc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe de uma automação. Tenha em conta que, dependendo do evento disparador e do tipo de envio, são exibidos campos diferentes.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação |
| name | Título da automação |
| subject | Assunto |
| previewText | Texto de visualização |
| fromAlias | Nome do remetente |
| fromEmail | De |
| replyEmail | Responder para |
| event | Evento disparador. Veja os possíveis valores em: Obter eventos disparadores de automação. |
| maillists | Lista(s) de contato(s) (ID e Nome). Exibido apenas para Eventos = Inscrição em uma lista, Cancelamento de inscrição em uma lista e Evento anual |
| idCustomField | Código de campo personalizado do tipo Evento anual configurado. Exibido apenas para Evento disparador = Evento anual |
| relCampaign | Id da campanha associada à automação. Exibido apenas para Eventos = Abertura, Clique em algum link, Clique em link específico e Sem cliques em um link |
| url | Url da campanha associada à automação. Exibido apenas para Eventos = Clique em link específico e Sem cliques em um link |
| daysNoClick | Quantidade de dias sem clique. Exibido apenas para Evento = Sem cliques em um link |
| created | Data de criação da automação |
| schedule_type | Tipo de envio. Valores possíveis: AutoresponderInmediate -> Assim que o evento for detectado AutoresponderDeferred-> Programado |
| moment | Momento em que a automação será enviada. Valores possíveis: after -> Depois de before -> Antes de onDay -> No dia Exibido apenas se Tipo de envio = Programado |
| days | Quantidade de dias. Exibido apenas se Tipo de envio = Programado e Momento = Antes de ou Depois de. |
| hour | Hora de envio. Exibido apenas se Tipo de envio = Programado |
| daysOfTheWeek | Dias da semana em que pode ser enviado |
| status | Estado da automação. Valores possíveis: Draft -> Rascunho Paused -> Pausado Stopped -> Parado PendingforApproval -> Pendente de aprovação Sending -> Ativo |
| content | Conteúdo da automação em HTML |
| trackLinkClicks | Rastrear links |
| trackReads | Contar aberturas |
| trackAnalitics | Vincular com Google Analytics |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 449 | Id de automation. Obrigatório |
Body
Description
Permite criar uma nova automação. Apenas o Título e o Evento disparador são obrigatórios.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação criada |
| name | Título da automação |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_relCampaignNotActive | A campanha de referência está em rascunho. |
| errorMsg_relCampaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_relCampaignRequired | É obrigatório informar a Campanha de referência quando se informa um Link. |
| errorMsg_mailListsIdsNotValid | Não existe lista com o ID informado. |
| errorMsg_specificUrlInvalid | Não existe o link informado. |
| errorMsg_idCFNotFound | Não existe campo personalizado Tipo = Evento anual com o ID informado. |
| errorMsg_relCampaignIsNotAllowedByEvent | Não é permitido informar Campanha de referência para o Evento informado. |
| errorMsg_specificUrlIsNotAllowedByEvent | Não é permitido informar Link específico para o Evento informado. |
| errorMsg_idCFIsNotAllowedByEvent | Não é permitido informar Data específica para o Evento informado. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | Não é permitido informar Listas de contatos para o Evento informado. |
| errorMsg_daysNoClickIsNotAllowedByEvent | Não é permitido informar Dias sem clique para o Evento informado. |
| errorMsg_contentOrcontentUrlOrtemplateId | Só é possível inserir um dos campos: Conteúdo HTML ou Url ou Template. |
| errorMsg_TemplateIDNotFound | Não existe template com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| name | Promoção dia dos pais | Título da automação. Obrigatório. |
| subject | Olá %Member:CustomField1% %Member:CustomField2% | Assunto da automação. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| previewText | Texto para a pré-visualização | Texto de pré-visualização. |
| fromAlias | Empresa S.A. | Nome do remetente. |
| fromEmail | administrador@exemplo.com | Endereço de email do qual a automação será enviada. Obrigatório apenas se o campo “fromAlias” for preenchido. |
| replyEmail | administrador@exemplo.com | Endereço de email para “Responder a”. |
| content | %Member:CustomField1% %Member:CustomField2% Veja as promoções que temos para você! | Conteúdo do email em Html. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| contentUrl | http://google.com.ar | Gerar conteúdo html da automação a partir de uma url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id do modelo. |
| event | click_ones | Evento disparador. Veja os valores possíveis em: Obter eventos disparadores. Obrigatório. |
| relCampaign | 230 | Id da campanha de referência. Obrigatório se for informado um link específico. |
| specificUrl | http://www.google.com | Link específico da campanha de referência. Veja os valores possíveis em: Obter links de uma campanha. |
| daysNoClick | 3 | Dias sem clique. |
| mailListsIds[] | 36 | Array de Ids de listas de contatos. |
| idCF | 12 | Id do campo personalizado correspondente a data específica. Veja os valores possíveis em: Obter coleção de campos personalizados. |
| trackLinkClicks | 1 | Rastrear links. Valores possíveis: 0/1. Por padrão 1. |
| trackReads | 0 | Contar aberturas. Valores possíveis: 0/1. Por padrão 1. |
| trackAnalitics | 0 | Vincular com Google Analytics. Valores possíveis: 0/1. Por padrão 1. |
Description
Permite editar todos os campos de uma automação existente, levando em conta as seguintes considerações:
- Só podem ser modificadas automações em Rascunho, Pausadas ou Paradas.
- Se desejar limpar os dados, os parâmetros devem ser enviados com valor em branco.
- Ao modificar uma automação Parada ou Pausada, ela ficará automaticamente em Rascunho.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_nameIsRequired | O título da automação não pode ser deixado em branco. |
| errorMsg_contentOrcontentUrlOrtemplateId | Só é possível inserir um dos campos: Conteúdo HTML ou URL ou Template. |
| errorMsg_TemplateIDNotFound | Não existe template com o ID informado. |
| errorMsg_automationSending | Não é possível modificar uma automação Ativa. |
| errorMsg_automationPendingForApproval | Não é possível modificar uma automação em revisão. |
| errorMsg_relCampaignNotActive | A campanha de referência está em rascunho. |
| errorMsg_relCampaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_relCampaignRequired | É obrigatório informar a Campanha de referência quando se informa um Link. |
| errorMsg_eventIsRequired | É obrigatório informar Evento disparador quando se informa Campanha ou Link ou Lista ou Data específica ou Dias sem clique |
| errorMsg_mailListsIdsNotValid | Não existe lista com o ID informado. |
| errorMsg_specificUrlInvalid | Não existe o link informado. |
| errorMsg_idCFNotFound | Não existe campo personalizado Tipo = Evento anual com o ID informado. |
| errorMsg_relCampaignIsNotAllowedByEvent | Não é permitido informar Campanha de referência para o Evento informado. |
| errorMsg_specificUrlIsNotAllowedByEvent | Não é permitido informar Link específico para o Evento informado. |
| errorMsg_idCFIsNotAllowedByEvent | Não é permitido informar Data específica para o Evento informado. |
| errorMsg_mailListsIdsIsNotAllowedByEvent | Não é permitido informar Listas de contatos para o Evento informado. |
| errorMsg_daysNoClickIsNotAllowedByEvent | Não é permitido informar Dias sem clique para o Evento informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 577 | Id do automation. Obrigatório. |
| name | Teste editar automation | Título do automation. |
| subject | Olá %Member:CustomField1% %Member:CustomField2% | Assunto da automação. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| previewText | Texto de visualização prévia | Texto de visualização prévia. |
| fromAlias | Empresa S.A. | Nome do remetente. |
| fromEmail | empresa@exemplo.com | Endereço de email do qual a campanha será enviada. Requerido apenas se o campo “fromAlias” for preenchido. |
| replyEmail | email@exemplo.com | Endereço de email para “Responder a”. |
| content | %Member:CustomField1% %Member:CustomField2% Veja as promoções que temos para você! | Conteúdo do email em Html. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| contentUrl | http://google.com.ar | Gerar conteúdo html da automação a partir de uma url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id do modelo. |
| event | anual_event | Evento disparador. Veja os possíveis valores em: Obter eventos disparadores. Requerido. |
| relCampaign | 230 | Id da campanha de referência. Requerido se for informado um link específico. |
| specificUrl | http://google.com | Link específico da campanha de referência. Veja os possíveis valores em: Obter links de uma campanha. |
| daysNoClick | 3 | Dias sem clique. |
| mailListsIds[] | 36 | Array de Ids de listas de contatos. |
| idCF | 3 | Id de campo personalizado correspondente a data específica. Veja os possíveis valores em: Obter coleção de campos personalizados. |
| trackLinkClicks | 0 | Rastrear links. Valores possíveis: 0/1. Por padrão 1. |
| trackReads | 0 | Contar aberturas. Valores possíveis: 0/1. Por padrão 1. |
| trackAnalitics | 0 | Vincular com Google Analytics. Valores possíveis: 0/1. Por padrão 1. |
Description
Permite pré-visualizar as automações por email.
Será enviada uma pré-visualização da automação para os emails indicados. Se possuir campos personalizados no conteúdo: toma o valor de algum contato da lista atribuída ou qualquer contato aleatório no caso de não possuir lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_warnPreviewLimit | Limite máximo de envios diários excedido. |
| errorMsg_notAllowed | Não tem permissão para enviar pré-visualizações. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id do automation. Obrigatório. |
| emails[] | email@exemplo.com | Array de emails. Obrigatório. Máximo: 5. |
Description
Permite pré-visualizar as automações pelo navegador.
Retorna um Html da automação para poder pré-visualizá-la em qualquer navegador. Se possuir campos personalizados no conteúdo: usa o valor do contato indicado, senão usa algum contato da lista atribuída, senão qualquer contato aleatório no caso de não possuir lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id da automação. Obrigatório. |
| email@exemplo.com | Email usado para preencher os campos personalizados incluídos na automação. |
Description
Permite gerar uma miniatura do conteúdo do automation.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automation com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 578 | Id do automation. Obrigatório. |
| width | 300 | Largura da imagem. Obrigatório. Mínimo: 200, máximo: 600. |
| height | 600 | Altura da imagem. Obrigatório. Mínimo: 200, máximo: 600. |
Description
Verifica se a automação cumpre todas as condições para poder ser ativada. Na resposta serão incluídas três seções adicionais:
- canSend onde será indicado se a automação está em condições de ser ativada.
- errors onde será mostrado um detalhe dos motivos pelos quais não poderá ser ativada, caso existam.
- warnings onde será mostrado um detalhe de advertências que, embora não impeçam a ativação da automação, indicam questões a melhorar, caso existam.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_automationIntegrityFail-subject | É necessário informar o campo subject. |
| errorMsg_automationIntegrityFail-replyTo | É necessário informar o campo replyTo. |
| errorMsg_automationIntegrityFail-fromToName | É necessário informar o campo fromToName. |
| errorMsg_automationIntegrityFail-fromTo | É necessário informar o campo fromTo. |
| errorMsg_automationIntegrityFail-content | A automação não tem conteúdo. |
| errorMsg_campaignSending | A automação está ativa. |
| errorMsg_campaignPendingForApproval | A automação está pendente de aprovação. |
| errorMsg_senderDomainNotVerified | O domínio não está verificado. |
| errorMsg_relCampaignNotFound | Não existe campanha ativa com o ID informado. |
| errorMsg_mailListsIdsNotValid | Não existe lista com o ID informado. |
| errorMsg_noListSelected | É necessário informar uma lista. |
| errorMsg_invalidCampaignSelected | É necessário informar uma campanha. |
| errorMsg_invalidUrl | É necessário informar URL. |
| errorMsg_invalidCustomField | É necessário informar uma data específica. |
| errorMsg_invalidDaysNoClick | É necessário informar dias sem cliques. |
| errorMsg_contactListFilter | Você não tem permissão para ativar automações. |
| errorMsg_spamRateErrorThreshold | A automação não passou na verificação de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguma das listas associadas à automação não existe. |
Advertências:
| Código | Descrição |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | O campo subject é curto |
| errorMsg_campaignIntegrityFail-subjectLong | O campo subject é longo. |
| errorMsg_spamRateWarningThreshold | A automação passou na verificação de SPAM, mas você pode melhorar o resultado. |
| errorMsg_senderDomainNotAuthenticated | Domínio não autenticado. |
| errorMsg_senderDmarcAllowedDomain | Recomenda-se usar domínios próprios para manter uma boa reputação e melhorar sua capacidade de entrega. |
Body
| Key | Value | Description |
|---|---|---|
| id | 221 | Id da automação. Obrigatório. |
Description
Retorna uma lista com todos os links de uma campanha para a criação e/ou edição das automações cujo evento disparador exige a url da campanha (Eventos = Clique em link específico e Sem cliques em um link)
Estrutura de saída:
| Campo | Descrição |
|---|---|
| originalLink | Link para usar na automação |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado ou a mesma está em rascunho. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id da campanha. Obrigatório. |
Description
Retorna uma lista com os possíveis Eventos disparadores para a criação e/ou edição das automações.
Detalhe dos valores:
A seguir, uma descrição dos valores atuais:
| Valor | Descrição |
|---|---|
| opener_campaign | Abertura de uma campanha |
| click_any | Clique em algum link |
| click_one | Clique em um link específico |
| no_click_one | Sem clique em um período de tempo específico |
| subscription | Inscrição em uma lista de contatos |
| unsubscription | Cancelamento de inscrição em uma lista de contatos |
| anual_event | Evento anual |
Body
Description
Permite ativar uma automação em rascunho, pausada ou parada.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação ativada |
| status | Pendente |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_momentNotValid | A opção selecionada em Quando enviar para o evento da automação não é permitida. |
| errorMsg_automationIntegrityFail-subject | É necessário informar o campo subject. |
| errorMsg_automationIntegrityFail-replyTo | É necessário informar o campo replyTo. |
| errorMsg_automationIntegrityFail-fromToName | É necessário informar o campo fromToName. |
| errorMsg_automationIntegrityFail-fromTo | É necessário informar o campo fromTo. |
| errorMsg_automationIntegrityFail-content | A automação não tem conteúdo. |
| errorMsg_campaignSending | A automação está ativa. |
| errorMsg_campaignPendingForApproval | A automação está pendente de aprovação. |
| errorMsg_senderDomainNotVerified | O domínio não está verificado. |
| errorMsg_relCampaignNotFound | Não existe campanha ativa com o ID informado. |
| errorMsg_mailListsIdsNotValid | Não existe lista com o ID informado. |
| errorMsg_noListSelected | É necessário informar uma lista. |
| errorMsg_invalidCampaignSelected | É necessário informar uma campanha. |
| errorMsg_invalidUrl | É necessário informar URL. |
| errorMsg_invalidCustomField | É necessário informar uma data específica. |
| errorMsg_invalidDaysNoClick | É necessário informar dias sem cliques. |
| errorMsg_contactListFilter | Você não tem permissão para ativar automações. |
| errorMsg_spamRateErrorThreshold | A automação não passou na verificação de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguma das listas associadas à automação não existe. |
Body
| Key | Value | Description |
|---|---|---|
| id | 590 | Id da automação. Obrigatório. |
| interval | 3 | Quantidade de dias após o evento. Obrigatório. Se intervalo = 0, será enviado assim que detectarmos o evento; caso contrário, será enviado em um tempo programado. |
| moment | after | Quando enviar. Valores possíveis: before (antes do evento) | onDay (no dia do evento) | after (depois do evento). Obrigatório apenas se Quantidade de dias > 0. |
| time | 12 | Hora que será enviado. Obrigatório apenas se intervalo > 0. |
| timeMinute | 15 | Minutos que será enviado. Obrigatório apenas se Quantidade de dias > 0. |
| days[] | 1 | Quais dias da semana pode ser enviado. Valores possíveis: 0 (Domingo) | 1 (Segunda-feira) | 2 (Terça-feira) | 3 (Quarta-feira) | 4 (Quinta-feira) | 5 (Sexta-feira) | 6 (Sábado). Obrigatório. |
Description
Permite eliminar uma automation ou várias ao mesmo tempo, considerando que:
- Se desejar eliminar uma única automation, deve passar como parâmetro o id.
- Se desejar eliminar várias automations, deve passar como parâmetro um array de Ids. Caso alguns dos automations indicados não existam, eles serão mostrados na resposta dentro de automationsNotFound.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automation com o ID informado. |
| invalid_max_elements | No máximo podem ser eliminados até 100 registros. Apenas para exclusão múltipla. |
Body
| Key | Value | Description |
|---|---|---|
| id | 470 | Id de automation a eliminar. Requerido apenas um: id (para exclusão de uma automation) ou array de ids (para exclusão de várias automations). |
| ids[] | 6 | Array de Ids de automations a eliminar. No máximo 100. Requerido apenas um: id (para exclusão de uma automation) ou array de ids (para exclusão de várias automations). |
Description
Permite pausar uma automação que está ativa.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação pausada. |
| status | Pausado |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_automationNotActive | A automação está em rascunho. |
| errorMsg_automationPaused | A automação já está pausada. |
| errorMsg_automationStopped | A automação está parada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Id da automação. Requerido. |
Description
Permite retomar uma automação parada ou pausada.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da automação retomada |
| status | Pendente |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
| errorMsg_automationSending | A automação está ativa. |
| errorMsg_automationPendingForApproval | A automação está pendente de aprovação. |
| errorMsg_automationNotPausedOrStopped | A automação está em rascunho. |
Body
| Key | Value | Description |
|---|---|---|
| id | 457 | Id da automação. Obrigatório. |
Description
Permite duplicar uma automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da nova automação |
| name | Nome da nova automação |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_automationNotFound | Não existe automação com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| automation_id | 590 | Id da automação. Obrigatório. |
Campanhas 15
Este módulo permitirá que você realize toda a gestão associada a campanhas desde a criação até o envio.
Description
Retorna uma lista de todas as campanhas. Podem ser filtradas por vários campos: nome, estado, tipo de envio, tipo de campanha, data de criação e data de envio.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha |
| name | Título da campanha |
| type | Tipo de campanha. Valores possíveis: Quick Campaign -> Regular A/B Campaign -> Teste A/B |
| created | Data de criação da campanha |
| type_send | Tipo de envio. Valores possíveis: Send Now -> Enviar agora One time scheduled -> Programada Not scheduled -> Sem programação |
| status | Estado da campanha. Valores possíveis: Draft -> Rascunho Paused -> Pausada Stopped -> Parada PendingforApproval -> Pendente de aprovação Sending -> Enviando ou Programada Completed -> Enviada |
| recipients_count | Quantidade de destinatários |
| schedule_send_date | Data de programação da campanha Somente para campanhas com Tipo de envio = Programada |
| start_date | Data de início do envio |
| finish_date | Data de término do envio |
Body
| Key | Value | Description |
|---|---|---|
| filter | Promo | Filtro por nome ou parte do nome da campanha. |
| status | Draft | Filtro por estado da campanha. Valores possíveis: Draft (Rascunho) / Completed (Enviada) / Sending (Enviando ou Programada) / Paused (Pausada) / PendingForApproval (Pendente de aprovação) / Stopped (Parada) |
| typeSend | sendNow | Filtro por tipo de envio. Valores possíveis: sendNow (Enviar agora) / scheduled (Programada). |
| createDateFrom | 2021-05-01 | Filtro por data de criação a partir de. Formato: YYYY-MM-DD. |
| createDateTo | 2021-05-28 | Filtro por data de criação até. Formato: YYYY-MM-DD. |
| sendDateFrom | 2021-05-01 | Filtro por data de envio a partir de. Formato: YYYY-MM-DD. |
| sendDateTo | 2021-05-28 | Filtro por data de envio até. Formato: YYYY-MM-DD. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar as campanhas. Valores possíveis: name/id. Por padrão: id. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
| typeAB | 0 | Tipo de campanha. Valores possíveis: 1 (Teste A/B) e 0 (Regular). |
Description
Retorna o detalhe de uma campanha. Tenha em conta que:
Para as campanhas que são reenvios será mostrado também: a campanha original e o tipo de reenvio.
Para as campanhas que têm reenvios automáticos configurados será mostrado também: tipo de reenvio, quantidade de dias e horário.
Para as campanhas Tipo = Teste A/B, são adicionados os dados de cada assunto em subjects. O assunto atual fica para as campanhas Tipo = Regular.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha |
| name | Título da campanha |
| created | Data de criação da campanha |
| subject | Assunto |
| previewText | Texto de visualização |
| fromAlias | Nome do remetente |
| fromEmail | De |
| replyEmail | Responder para |
| type | Tipo de campanha. Valores possíveis: Quick Campaign -> Regular A/B Campaign -> Teste A/B |
| subjects.partition | Tipo de assunto. Valores possíveis: A -> Assunto A B -> Assunto B |
| subjects.subject | Assunto |
| subjects.percentage | Percentual do assunto |
| maillists.id | ID da lista de contatos |
| maillists.name | Nome da lista de contatos |
| segments.id | ID do segmento |
| segments.name | Nome do segmento |
| recipients_count | Total de destinatários da campanha |
| type_send | Tipo de envio. Valores possíveis: Send Now -> Enviar agora One time scheduled -> Programada Not scheduled -> Sem programação |
| schedule_send_date | Data de programação da campanha Somente para campanhas com Tipo de envio = Programada |
| start_date | Data de início do envio |
| finish_date | Data de término do envio |
| trackLinkClicks | Rastrear links |
| trackReads | Contar aberturas |
| trackAnalitics | Vincular com Google Analytics |
| sendReport | Enviar relatório |
| publicArchive | Adicionar ao arquivo público |
| workspace | Como o conteúdo foi realizado. Valores possíveis: designer -> Editor visual expertCoder -> Modo programador externalUrl -> Modo Url |
| content | Conteúdo da campanha em HTML |
| status | Estado da campanha. Valores possíveis: Draft -> Rascunho Paused -> Pausada Stopped -> Parada PendingforApproval -> Pendente de aprovação Sending -> Enviando ou Programada Completed -> Enviada |
| resend.ofCampaign | Campanha da qual é reenvio. Só é mostrado para campanhas que são reenvios de outras. |
| resend.type | Tipo de reenvio. Valores possíveis: 1 -> Para os contatos que não abriram a campanha 2 -> Para os contatos que não clicaram no conteúdo 3 -> Para os contatos que tiveram rebotes suaves 4 -> Novamente para todos os contatos |
| resend.days | Dias para o reenvio. Só é mostrado para campanhas que têm reenvios automáticos configurados. |
| resend.hours | Hora do reenvio. Só é mostrado para campanhas que têm reenvios automáticos configurados. |
| resend.mins | Minutos do reenvio. Só é mostrado para campanhas que têm reenvios automáticos configurados. |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | 12 | Id da campanha. Obrigatório. |
Body
Description
Permite criar uma nova campanha. Apenas o Título é obrigatório.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha criada |
| name | Título da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_mailListsIdsOrSegmentId | Só é possível inserir um dos campos: Lista(s) ou Segmentos. |
| errorMsg_contentOrcontentUrlOrtemplateId | Só é possível inserir um dos campos: Conteúdo HTML ou Url ou Template. |
| errorMsg_TemplateIDNotFound | Não existe template com o ID informado. |
| subject.not_required_on_ab_campaign | Para campanhas Tipo = Teste A/B, você não pode enviar subject. Deve enviar um array de subjects. |
| subjects.only_on_ab_campaign | Para campanhas Tipo = regular, você não pode enviar o array subjects. Deve enviar apenas subject. |
| subjects.invalid_count_elements | Para campanhas Tipo = Teste A/B, você deve enviar os dois assuntos. |
| subjects.invalid_subjects_percentage | Para campanhas Tipo = Teste A/B, a soma das porcentagens deve ser 100. |
Body
| Key | Value | Description |
|---|---|---|
| name | Promoções dia dos pais | Título da campanha. Obrigatório. |
| subject | Olá %Member:CustomField1% %Member:CustomField2% | Assunto da campanha. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| previewText | Texto para a pré-visualização | Texto de pré-visualização. |
| fromAlias | Empresa S.A. | Nome do remetente. |
| fromEmail | administrador@exemplo.com | Endereço de email do qual a campanha será enviada. Obrigatório somente se o campo “fromAlias” for preenchido. |
| replyEmail | administrador@exemplo.com | Endereço de email para “Responder a”. |
| mailListsIds[] | 1 | Array de Ids de listas de contatos. |
| segmentId | 19 | Id do segmento. |
| content | %Member:CustomField1% %Member:CustomField2% Veja as promoções que temos para você! | Conteúdo do email em Html. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| contentUrl | http://google.com.ar | Gerar conteúdo html da campanha a partir de uma url. |
| templateId | 65983f41755d4e4c00e21007 | Id do modelo. |
| trackLinkClicks | 1 | Rastrear links. Valores possíveis: 0/1. Por padrão 1. |
| trackReads | 0 | Contar aberturas. Valores possíveis: 0/1. Por padrão 1. |
| trackAnalitics | 0 | Vincular com Google Analytics. Valores possíveis: 0/1. Por padrão 1. |
| sendReport | 0 | Enviar relatório. Valores possíveis: 0/1. Por padrão 1. |
| publicArchive | 1 | Adicionar ao arquivo público. Valores possíveis: 0/1. Por padrão 0. |
| typeAB | 1 | Tipo de campanha. Valores possíveis: 1 (Teste A/B) e 0 (Regular). Por padrão: 0 (Regular). |
| subjects[0][subject] | Assunto Teste A | Assunto A. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[0][percentage] | 50 | Porcentagem assunto A. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[1][subject] | Assunto Teste B | Assunto B. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[1][percentage] | 50 | Porcentagem assunto B. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
Description
Permite editar todos os campos de uma campanha existente, levando em consideração as seguintes considerações:
Só podem ser modificadas campanhas em Rascunho ou Pausadas.
Se desejar limpar os dados, os parâmetros devem ser enviados com valor em branco.
Ao modificar uma campanha Pausada, ela ficará automaticamente em Rascunho.
Caso alguma das listas indicadas não exista, ela será mostrada na resposta dentro de mailListsNotFound e não será atribuída à campanha.
Caso o segmento indicado não exista, ele será mostrado na resposta dentro de segmentNotFound e não será atribuído à campanha.
Não é possível modificar o Tipo de campanha.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_mailListsIdsOrSegmentId | Só é possível inserir um dos campos: Lista(s) ou Segmentos. |
| errorMsg_contentOrcontentUrlOrtemplateId | Só é possível inserir um dos campos: Conteúdo HTML ou Url ou Template. |
| errorMsg_TemplateIDNotFound | Não existe template com o ID informado. |
| errorMsg_campaignPaused | A campanha está pausada. |
| errorMsg_campaignSending | A campanha está sendo enviada ou programada. |
| errorMsg_campaignPendingForApprova | A campanha está pendente de aprovação. |
| errorMsg_campaignCompleted | A campanha foi enviada. |
| subject.not_required_on_ab_campaign | Para campanhas Tipo = Teste A/B, você não pode enviar subject. Deve enviar um array de subjects. |
| subjects.only_on_ab_campaign | Para campanhas Tipo = regular, você não pode enviar o array subjects. Deve enviar apenas subject. |
| subjects.invalid_count_elements | Para campanhas Tipo = Teste A/B, você deve enviar os dois assuntos. |
| subjects.invalid_subjects_percentage | Para campanhas Tipo = Teste A/B, a soma das porcentagens deve ser 100. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Id da campanha. Obrigatório. |
| name | Teste editar campanha | Nome da campanha. |
| subject | Olá %Member:CustomField1% %Member:CustomField2% | Assunto da campanha. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| previewText | Texto de visualização prévia | Texto de visualização prévia. |
| fromAlias | Empresa S.A. | Nome do remetente. |
| fromEmail | empresa@exemplo.com | Endereço de email do qual a campanha será enviada. Obrigatório apenas se o campo “fromAlias” for preenchido. |
| replyEmail | email@exemplo.com | Endereço de email para “Responder a”. |
| mailListsIds[] | 2 | Array de Ids das listas de contatos. |
| segmentId | 1 | Id do segmento. |
| content | %Member:CustomField1% %Member:CustomField2% Veja as promoções que temos para você! | Conteúdo do email em Html. Você pode incluir campos personalizados utilizando o “Código do campo personalizado” obtido no serviço “Obter detalhe de um campo personalizado”. |
| contentUrl | http://google.com.ar | Gerar conteúdo html da campanha a partir de uma url. |
| templateId | 65bceb74cf2a51360090a4b6 | Id do modelo. |
| trackLinkClicks | 0 | Seguir links. Valores possíveis: 0/1. Por padrão 1. |
| trackReads | 0 | Contar aberturas. Valores possíveis: 0/1. Por padrão 1. |
| trackAnalitics | 0 | Vincular com Google Analytics. Valores possíveis: 0/1. Por padrão 1. |
| sendReport | 0 | Enviar relatório. Valores possíveis: 0/1. Por padrão 1. |
| publicArchive | 1 | Adicionar ao arquivo público. Valores possíveis: 0/1. Por padrão 0. |
| subjects[0][subject] | Assunto Teste A | Assunto A. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[0][percentage] | 50 | Porcentagem do assunto A. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[1][subject] | Assunto Teste B | Assunto B. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
| subjects[1][percentage] | 50 | Porcentagem do assunto B. Se enviado, ambos os assuntos e suas porcentagens devem ser incluídos. |
Description
Permite visualizar as campanhas por email.
Será enviada uma prévia da campanha para os emails indicados. Se possuir campos personalizados no conteúdo: toma o valor de algum contato da lista atribuída ou qualquer usuário aleatório caso não possua lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_warnPreviewLimit | Limite máximo de envios diários excedido. |
| errorMsg_notAllowed | Não tem permissão para enviar prévias. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id da campanha. Obrigatório. |
| emails[] | email@exemplo.com | Array de emails. Obrigatório. Máximo: 5. |
| subject | A | Assunto a mostrar. Valores possíveis: A / B. Deve ser enviado apenas para campanhas Tipo = Teste A/B. Padrão: A. |
Description
Permite pré-visualizar as campanhas por navegador.
Retorna um Html da campanha para poder pré-visualizá-la em qualquer navegador. Se possuir campos personalizados no conteúdo: usa o valor do contato indicado, caso contrário usa algum contato da lista atribuída, caso contrário qualquer usuário aleatório no caso de não possuir lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id da campanha. Obrigatório. |
| email@exemplo.com | Email usado para preencher os campos personalizados incluídos na campanha. Se este dado não for enviado e a campanha possuir campos personalizados, os mesmos serão preenchidos com dados de contatos aleatórios. |
Description
Verifica se a campanha cumpre todas as condições para poder ser enviada. Na resposta serão incluídas três seções adicionais:
- canSend onde será indicado se a campanha está em condições de ser enviada ou não.
- errors onde será mostrado um detalhe dos motivos pelos quais a campanha não poderá ser enviada, caso existam.
- warnings onde será mostrado um detalhe de advertências que, embora não impeçam o envio da campanha, indicam questões a melhorar, caso existam.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_campaignIntegrityFail-subject | É necessário preencher o campo subject. |
| errorMsg_campaignIntegrityFail-replyTo | É necessário preencher o campo replyTo. |
| errorMsg_campaignIntegrityFail-fromToName | É necessário preencher o campo fromToName. |
| errorMsg_campaignIntegrityFail-fromTo | É necessário preencher o campo fromTo. |
| errorMsg_campaignIntegrityFail-content | A campanha não tem conteúdo. |
| errorMsg_noListNoSegmentSelected | É necessário associar uma lista de emails ou um segmento. |
| errorMsg_campaignPendingForApproval | A campanha está pendente de aprovação. |
| errorMsg_campaignCompleted | A campanha está enviada. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | Alcançou o limite máximo de campanhas enviadas simultaneamente. |
| errorMsg_senderDomainNotVerified | O domínio não está verificado. |
| errorMsg_noContactsInMailLists | Alguma das listas não possui contatos. |
| errorMsg_noContactsInSegments | O segmento não possui contatos. |
| errorMsg_contactListFilter | Você não tem permissão para enviar campanhas. |
| errorMsg_spamRateErrorThreshold | A campanha não passou na verificação de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguma das listas associadas à campanha não existe. |
Advertências:
| Código | Descrição |
|---|---|
| errorMsg_campaignIntegrityFail-subjectShort | O campo subject é curto |
| errorMsg_campaignIntegrityFail-subjectLong | O campo subject é longo. |
| errorMsg_spamRateWarningThreshold | A campanha passou na verificação de SPAM, mas você pode melhorar o resultado. |
| errorMsg_senderDomainNotAuthenticated | Domínio não autenticado. |
| errorMsg_senderDmarcAllowedDomain | Recomenda-se usar domínios próprios para manter uma boa reputação e melhorar sua capacidade de entrega. |
Body
| Key | Value | Description |
|---|---|---|
| id | 3 | Id da campanha. Obrigatório. |
Description
Permite enviar uma campanha em rascunho ou parada, tendo em conta que:
- Se a campanha estiver em rascunho, sempre deve indicar o campo Enviar agora.
- Se a campanha estiver parada, se indicar o campo Enviar agora, tomará o valor indicado, caso contrário será retomada com os valores que já estiverem configurados.
Além disso, poderá ser programado um reenvio automático.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha enviada |
| status | Pending |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignPaused | A campanha está pausada. |
| errorMsg_campaignSending | A campanha está sendo enviada ou programada. |
| errorMsg_campaignPendingForApproval | A campanha está pendente de aprovação. |
| errorMsg_campaignCompleted | A campanha foi enviada. |
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_campaignIntegrityFail-subject | É necessário completar o campo subject. |
| errorMsg_campaignIntegrityFail-replyTo | É necessário completar o campo replyTo. |
| errorMsg_campaignIntegrityFail-fromToName | É necessário completar o campo fromToName. |
| errorMsg_campaignIntegrityFail-fromTo | É necessário completar o campo fromTo. |
| errorMsg_campaignIntegrityFail-content | A campanha não tem conteúdo. |
| errorMsg_noListNoSegmentSelected | É necessário associar uma lista de emails ou um segmento. |
| errorMsg_maxSimultaneousCampaignLimitExceeded | Alcançou o limite máximo de campanhas enviadas simultaneamente. |
| errorMsg_senderDomainNotVerified | O domínio não está verificado. |
| errorMsg_noContactsInMailLists | Alguma das listas não possui contatos. |
| errorMsg_noContactsInSegments | O segmento não possui contatos. |
| errorMsg_contactListFilter | Você não tem permissão para enviar campanhas. |
| errorMsg_spamRateErrorThreshold | A campanha não passou na verificação de SPAM. |
| errorMsg_invalidMaillistsSelected | Alguma das listas associadas à campanha não existe. |
Body
| Key | Value | Description |
|---|---|---|
| id | 4 | Id da campanha. Obrigatório. |
| sendNow | 0 | Enviar agora. Valores possíveis: 1 (Enviar agora) e 0 (Agendar). Só é obrigatório quando a campanha está em rascunho. |
| sendDate | 2022-12-31 11:00:00 | Data de agendamento da campanha. Formato: YYYY-MM-DD HH:MM:DD. Deve ser maior que a data e hora atual. Obrigatório, se sendNow = 0 (Agendar). |
| resend | 1 | Agendar reenvio. Valores possíveis: 0 (Não) e 1 (Sim). Padrão 0. |
| resendType | 2 | Tipo de reenvio. Obrigatório se Agendar reenvio = 1. Valores possíveis: 1 (Para os contatos que não abriram a campanha) / 2 (Para os contatos que não clicaram no conteúdo) / 3 (Para os contatos que tiveram rebotes suaves) / 4 (Novamente para todos os contatos) |
| resendDays | 7 | Quantidade de dias para o reenvio. Obrigatório se Programar reenvio = 1. Máximo 999, mínimo: 1. |
| resendHours | 17 | Hora para reenvio. Obrigatório se Programar reenvio = 1. Máximo 23, mínimo: 0. |
| resendMins | 40 | Minutos para reenvio. Obrigatório se Programar reenvio = 1. Máximo 59, mínimo: 0. |
Description
Permite pausar uma campanha que está sendo enviada, programada ou em revisão.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha pausada. |
| status | Paused |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_campaignNotActive | A campanha está em rascunho. |
| errorMsg_campaignPaused | A campanha já está pausada. |
| errorMsg_campaignCompleted | A campanha está enviada. |
| errorMsg_campaignStopped | A campanha está parada. |
| errorMsg_campaignNotPaused | A campanha não pôde ser pausada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Id da campanha. Obrigatório. |
Description
Permite parar uma campanha que está sendo enviada, programada, em revisão ou pausada.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha parada |
| status | Stopped |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_campaignNotActive | A campanha está em rascunho. |
| errorMsg_campaignCompleted | A campanha está enviada. |
| errorMsg_campaignStopped | A campanha já está parada. |
| errorMsg_campaignNotStopped | A campanha não pôde ser parada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 112 | Id da campanha. Obrigatório. |
Description
Permite retomar uma campanha parada ou pausada.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha retomada |
| status | Sending |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_campaignSending | A campanha está enviando ou programada. |
| errorMsg_campaignPendingForApproval | A campanha está pendente de aprovação. |
| errorMsg_campaignCompleted | A campanha está enviada. |
| errorMsg_campaignNotPausedOrStopped | A campanha está em rascunho. |
| campaignBlocked | Foram detectados certos problemas no conteúdo da sua campanha. |
Body
| Key | Value | Description |
|---|---|---|
| id | 127 | Id da campanha. Obrigatório. |
Description
Permite eliminar uma campanha ou várias ao mesmo tempo, tendo em conta que:
- Se desejar eliminar uma única campanha, deverá passar como parâmetro o id.
- Se desejar eliminar várias campanhas, deverá passar como parâmetro um array de Ids. Caso algumas das campanhas indicadas não existam, as mesmas serão mostradas na resposta dentro de campaignsNotFound.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| invalid_max_elements | No máximo podem ser eliminados até 100 registros. Apenas para eliminação múltipla. |
Body
| Key | Value | Description |
|---|---|---|
| id | 113 | Id da campanha a ser excluída. Requerido apenas um: id (para exclusão de uma campanha) ou array de ids (para exclusão de várias campanhas). |
| ids[] | 6 | Array de Ids das campanhas a serem excluídas. No máximo 100. Requerido apenas um: id (para exclusão de uma campanha) ou array de ids (para exclusão de várias campanhas). |
Description
Permite duplicar uma campanha.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da nova campanha |
| name | Nome da nova campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaing_id | Id da campanha. Obrigatório. |
Description
Permite reenviar uma campanha.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da campanha reenviada |
| name | Nome da campanha reenviada |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
| errorMsg_emptyMaillistsOrSegment | A campanha não pode ser reenviada porque a lista de contatos ou o segmento não existe mais. |
| errorMsg_campaignNotCompleted | A campanha não foi enviada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 11 | Id da campanha a reenviar. Obrigatório. |
| type | 4 | Tipo de reenvio. Obrigatório. Valores possíveis: 1 (Para os contatos que não abriram a campanha) / 2 (Para os contatos que não clicaram no conteúdo) / 3 (Para os contatos que tiveram rebotes suaves) / 4 (Novamente para todos os contatos) |
| sendNow | 1 | Enviar agora. Obrigatório. Valores possíveis: 1 (Enviar agora) e 0 (Agendar). |
| sendDate | 2022-12-31 11:00:00 | Data de agendamento do reenvio. Formato: YYYY-MM-DD HH:MM:DD. Deve ser maior que a data e hora atual. Obrigatório, se sendNow = 0 (Agendar). |
Description
Permite gerar uma miniatura do conteúdo da campanha.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 26 | Id da campanha. Obrigatório. |
| width | 300 | Largura da imagem. Obrigatório. Mínimo: 200, máximo: 600. |
| height | 600 | Altura da imagem. Obrigatório. Mínimo: 200, máximo: 600. |
Campos personalizados 7
Este módulo agrupa serviços para a gestão de campos personalizados utilizados para a informação dos contatos, os formulários de inscrição e a personalização das suas campanhas.
Description
Retorna uma lista com todos os campos personalizados. Podem ser filtrados por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do campo personalizado |
| name | Nome do campo personalizado |
| code | Código do campo personalizado. Com este código você poderá incluir os campos personalizados no assunto e conteúdo da campanha |
| type | Tipo de campo. Veja os possíveis valores em: Obter tipos de campos personalizados |
| validation | Tipo de validação. Veja os possíveis valores em: Obter validações de campos personalizados. É exibido apenas para Tipo de campo = Campo de texto ou campo oculto |
| validationCustomRegExp | Validação personalizada. É exibido apenas se Validação = Personalizada) |
| options_values | Opções possíveis. É exibido apenas para Tipo de campo = Listado ou Listado com seleção múltipla ou Listado com seleção única |
| value_default | Valor padrão. É exibido apenas para Tipo de campo = Campo de texto ou campo oculto ou Evento anual |
| date_value | Data padrão. É exibido apenas para Tipo de campo = Evento anual |
Body
| Key | Value | Description |
|---|---|---|
| name | campo | Filtro por nome ou parte do nome do campo personalizado. |
| type | Text field | Filtro por tipo de campo. Veja os possíveis valores em: Obter tipos de campos personalizados. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar os campos. Valores possíveis: name/id. Por padrão: id. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe de um campo personalizado.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do campo personalizado. |
| name | Nome do campo personalizado |
| code | Código do campo personalizado. Com este código você poderá incluir os campos personalizados no assunto e conteúdo da campanha |
| type | Tipo de campo. Veja os possíveis valores em: Obter tipos de campos personalizados |
| validation | Tipo de validação. Veja os possíveis valores em: Obter validações de campos personalizados Aparece apenas para Tipo de campo = Campo de texto ou campo oculto. |
| validationCustomRegExp | Validação personalizada. Aparece apenas se Validação = Personalizada) |
| options_values | Opções possíveis. Aparece apenas para Tipo de campo = Listado ou Listado com seleção múltipla ou Listado com seleção única |
| value_default | Valor padrão. Aparece apenas para Tipo de campo = Campo de texto ou campo oculto ou Evento anual |
| date_value | Data padrão. Aparece apenas para Tipo de campo = Evento anual |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_customFieldNotFound | Não existe campo personalizado com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 3 | Id do campo personalizado. |
Description
Retorna uma lista de tipos de validações que serão utilizadas na criação e/ou edição dos campos personalizados tipo = Campo de texto ou campo oculto.
Detalhe dos valores:
A seguir está uma descrição dos valores atuais:
| Valor | Descrição |
|---|---|
| Do not Apply | Desativar |
| Numeric Only | Aceitar apenas dígitos |
| Alpha Only | Aceitar apenas letras e espaços |
| Alpha Numeric Only | Aceitar apenas letras, números e espaços |
| Email Format Check | Aceitar apenas endereços de e-mail |
| Custom | Personalizada |
Description
Retorna uma lista de tipos de campos que serão usados na criação e/ou edição dos campos personalizados.
Detalhe dos valores:
A seguir está uma descrição dos valores atuais:
| Valor | Descrição |
|---|---|
| Text field | Campo de texto |
| Hidden field | Campo oculto |
| Check box | Lista com seleção múltipla |
| Radio button | Lista com seleção única |
| Anual Date | Evento anual |
| Drop list | Lista |
Description
Permite criar um novo campo personalizado, levando em consideração as seguintes considerações:
- Sempre será obrigatório: Nome e Tipo de campo.
- Para campos tipo = Campo de texto ou campo oculto, sempre serão solicitados os seguintes parâmetros:
- Tipo de validação. É obrigatório indicar um valor.
- Expressão regular. É obrigatório indicar um valor para Validação = Personalizada.
- Valor padrão. Não é obrigatório indicar um valor, portanto pode ficar em branco.
- Para Tipo de campo = Lista ou Lista com seleção múltipla ou Lista com seleção única sempre será solicitado o parâmetro Opções, sendo obrigatório indicar um valor.
- Para Tipo de campo = Evento anual, sempre será solicitado o parâmetro Valor padrão, mas não é obrigatório indicar um valor, portanto pode ficar em branco.
Erros:
| Código | Descrição |
|---|---|
| valueDefaultWithValidationCustomRegExp | O valor padrão não cumpre a validação personalizada. |
Body
| Key | Value | Description |
|---|---|---|
| name | Sobrenome | Nome do campo. Obrigatório. |
| type | Text field | Tipo de campo. Veja os valores possíveis em: Obter tipos de campos personalizados. Obrigatório. |
| validation_type | Do not Apply | Tipo de validação. Veja os valores possíveis em: Obter validações de campos personalizados. Obrigatório se Tipo de campo = Campo de texto ou campo oculto. |
| validationCustomRegExp | /^[0-9]*$/ | Expressão regular para validação do campo. Obrigatório para Validação = Personalizada. |
| value_default | Desconhecido | Valor padrão. Obrigatório para Tipo de campo = Campo de texto ou campo oculto. O valor pode ficar em branco. |
| options_values[] | Opção1 | Array com valores das opções. É necessário indicar pelo menos uma opção com valor para Tipo de campo = Lista ou Lista com seleção múltipla ou Lista com seleção única. |
| date_value | 02-28 | Data anual padrão. Formato: MM-DD. Requerido para Tipo de campo = Evento anual. O valor pode ficar em branco. |
Description
Permite editar um campo personalizado, considerando as seguintes considerações:
- Sempre será obrigatório: Nome e Tipo de campo.
- Para campos tipo = Campo de texto ou campo oculto, sempre serão solicitados os seguintes parâmetros:
- Tipo de validação. É obrigatório indicar um valor.
- Expressão regular. É obrigatório indicar um valor para Validação = Personalizada.
- Valor padrão. Não é obrigatório indicar um valor, portanto pode ficar em branco.
- Para Tipo de campo = Lista ou Lista com seleção múltipla ou Lista com seleção única, sempre será solicitado o parâmetro Opções, sendo obrigatório indicar um valor.
- Para Tipo de campo = Evento anual, sempre será solicitado o parâmetro Valor padrão, mas não é obrigatório indicar um valor, portanto pode ficar em branco.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_customFieldNotFound | Não existe campo personalizado com o ID informado. |
| valueDefaultWithValidationCustomRegExp | O valor padrão não cumpre com a validação personalizada. |
Body
| Key | Value | Description |
|---|---|---|
| id | 8 | Id do campo personalizado a modificar. Obrigatório. |
| name | Data de nascimento | Nome do campo. Obrigatório. |
| type | Anual Date | Tipo de campo. Veja os possíveis valores em: Obter tipos de campos personalizados. Obrigatório. |
| validation_type | Custom | Tipo de validação. Veja os valores possíveis em: Obter validações de campos personalizados. Obrigatório se Tipo de campo = Campo de texto ou campo oculto. |
| validationCustomRegExp | /^[0-9]*$/ | Expressão regular para a validação do campo. Obrigatório para Validação = Personalizada. |
| value_default | Desconhecido | Valor padrão. Obrigatório para Tipo de campo = Campo de texto ou campo oculto. O valor pode ficar em branco. |
| options_values[] | Opção1 | Array com valores das opções. É obrigatório indicar pelo menos uma opção com valor para Tipo de campo = Lista ou Lista com seleção múltipla ou Lista com seleção única. |
| date_value | 02-29 | Data anual padrão. Formato: MM-DD. Obrigatório para Tipo de campo = Evento anual. O valor pode ficar em branco. |
Description
Permite eliminar um campo personalizado desde que o mesmo não esteja sendo usado em algum segmento, formulário ou automação.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_customFieldNotFound | Não existe campo personalizado com o ID informado. |
| errorMsg_customFieldIsUsed | Não pode ser eliminado o campo personalizado porque está sendo usado em algum segmento, formulário ou automação. |
URL Variables
| Key | Value | Description |
|---|---|---|
| customfield_id | 5 | id do campo personalizado a ser excluído. Obrigatório. |
Conta 6
Este módulo agrupa serviços para gerir a configuração da sua conta e conhecer o resumo da sua atividade.
Description
Retorna informações da conta do administrador.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da conta |
| name | Nome e sobrenome |
| username | Nome de usuário |
| timeZone | Fuso horário. Veja os valores possíveis em: Obter fusos horários |
| country | País. Veja os valores possíveis em: Obter países |
| subscription.Type | Tipo de plano. Valores possíveis: Prepaid –> Pré-pago Monthly –> Mensal |
| subscription.Quota | Quantidade de envios do plano. Mostrado apenas para Tipo de plano = Mensal |
| subscription.TermBegin | Data de início. Mostrado apenas para Tipo de plano = Mensal |
| subscription.TermEnd | Data de término. Mostrado apenas para Tipo de plano = Mensal |
| subscription.Credits | Créditos disponíveis |
| created | Data de criação da conta |
| publicArchivesURL | URL para acessar o arquivo público de campanhas |
Description
Permite editar a configuração da conta.
Body
| Key | Value | Description |
|---|---|---|
| name | Juan Pérez | Nome e sobrenome. Obrigatório. |
| conta@exemplo.com | Email. Obrigatório. | |
| timezone | -10800 | Fuso horário. Obrigatório. Veja os valores possíveis em: Obter fusos horários. |
| country | ar | País. Obrigatório. Veja os valores possíveis em: Obter países. |
Description
Retorna estatísticas da conta do administrador.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| TotalSent | Total de envios do último mês |
| AvgMonthlyTotalSent | Média de envios nos últimos seis meses |
| campaigns.Count | Total de campanhas criadas |
| campaigns.Sent | Total de envios em campanhas |
| autoresponders.Count | Total de automações criadas |
| autoresponders.Sent | Total de envios em automações |
| maillists.Count | Quantidade de listas ativas |
| activeMembers.Count | Quantidade de contatos ativos |
| reads.Count | Total de aberturas em campanhas e automações (aberturas totais) |
| clicks.Count | Total de cliques em campanhas e automações (cliques totais) |
Description
Retorna uma lista dos possíveis fusos horários para a configuração da conta.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| label | Descrição do fuso horário |
| value | Código do fuso horário. Será usado em Editar configuração geral da conta |
Description
Retorna uma lista dos possíveis países para a configuração da conta.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| label | Descrição do país |
| value | Código do país. Será utilizado em Editar configuração geral da conta |
Description
Retorna uma lista dos domínios da conta.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do domínio |
| domain | Nome do domínio |
| status | Estado do domínio. Valores possíveis: NotVerified (Não verificado) / Pending (Pendente de verificação) / Verified (Verificado sem autenticação) / Authenticated (Autenticado) |
Body
| Key | Value | Description |
|---|---|---|
| name | seudominio.com | Filtro por nome de domínio |
| status | Authenticated | Filtro por estado do domínio. Valores possíveis: Pending (Pendente de verificação) / Verified (Verificado sem autenticação) / NotVerified (Não verificado) / Authenticated (Autenticado). |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar os domínios. Valores possíveis: name/id. Por padrão: id. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Contatos 8
Este módulo permitirá que você realize toda a gestão associada a contatos que depois serão usados em listas e/ou segmentos.
Description
Retorna uma lista com todos os contatos. Podem ser filtrados por email ou por lista.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do contato |
| Email do contato | |
| created | Data de criação |
| lastSend | Data do último envio |
| suscriptions | Quantidade de listas às quais está inscrito |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_mailListNotFound | Nenhuma lista encontrada com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| luis | Filtro por email ou parte do email do contato. | |
| listId | 2 | Filtro por lista de contatos. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | id | Critério para ordenar os contatos. Valores possíveis: email/id. Por padrão: id |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe de um contato.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do contato |
| Email do contato | |
| created | Data de criação |
| lastActivity | Data da última atividade |
| mailLists | Lista(s) na(s) qual(is) está inscrito (ID e Nome) |
| customFields | Campos personalizados (ID, Nome, Tipo e Valor) |
| lastSend | Data do último envio |
| reads | Aberturas totais |
| clicks | Cliques totais |
| hardBounce | Rejeições duras |
| softBounce | Rejeições suaves |
| shared | Compartilhados |
| unsubscription | Cancelamentos de inscrição |
| complaint | Reclamações |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| contact_id | 2 | Id do contato. Obrigatório. |
Body
Description
Permite criar um novo contato, levando em consideração as seguintes considerações:
- Apenas é necessário inserir o e-mail.
- O contato será atribuído às listas por meio de outro serviço.
- Para preencher os campos personalizados, será utilizado o seguinte critério:
- Se o campo for enviado com um valor, será preenchido com esse valor.
- Se o campo for enviado vazio, o campo será preenchido com valor vazio.
- Se o campo não for enviado, será preenchido com o valor padrão configurado (caso exista).
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do contato criado |
| Email do contato |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactAlreadyExist | Já existe um contato com o mesmo e-mail. |
| customsFieldsNotFound | Não existe o campo personalizado indicado. |
Body
| Key | Value | Description |
|---|---|---|
| sofia@exemplo.com | Email do novo contato. Obrigatório. | |
| customFields[1] | Sofia | Array de campos personalizados. Deve-se colocar o id do campo que se deseja preencher como key do array. No caso de ser um valor do tipo data, deve ter o formato MM-DD. No caso de uma lista de opções múltiplas, separar as opções com vírgula e sem espaços. Por exemplo: opcao1,opcao3. |
Description
Permite editar um contato, considerando as seguintes considerações:
- Nenhum campo é obrigatório.
- O contato será atribuído a listas por meio de outro serviço.
- Para editar os campos personalizados será utilizado o seguinte critério:
- Se o campo for enviado com um valor, ele será modificado com o valor indicado.
- Se o campo for enviado vazio, ele será modificado com o valor indicado (em branco).
- Se o campo não for enviado, o valor do campo não será atualizado, permanecendo o valor atual.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
| customsFieldsNotFound | Não existe o campo personalizado indicado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 6 | Id do contato. Obrigatório. |
| customFields[1] | Sofía | Array de campos personalizados. Deve-se colocar o id do campo que se deseja preencher como chave do array. No caso de ser um valor do tipo data deve ter o formato MM-DD. No caso de uma lista de opções múltiplas, separar as opções com vírgula e sem espaços. Por exemplo: opcao1,opcao3. |
Description
Permite inscrever vários contatos em uma lista, considerando as seguintes observações:
- Contatos que estiverem excluídos não poderão ser inscritos. Nestes casos, eles aparecerão na resposta dentro de contactExclude e não serão inscritos.
- Caso alguns dos contatos indicados não existam, eles aparecerão na resposta dentro de contactNotFound.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_mailListNotFound | Não existe lista de contatos com o ID informado. |
| invalidContacts | Nenhum dos contatos foi inscrito, seja porque não existem ou porque estão excluídos |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 4 | Array de IDs de contatos para inscrever. Obrigatório. Máximo: 100 registros. |
| listId | 1 | ID da lista. Obrigatório. |
Description
Permite cancelar a inscrição de vários contatos de uma lista, considerando as seguintes observações:
- Caso alguns dos contatos indicados não existam, eles serão exibidos na resposta dentro de contactNotFound.
- Os contatos que não estiverem inscritos na lista indicada serão exibidos na resposta dentro de subscribeNotFound.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_mailListNotFound | Não existe lista de contatos com o ID informado. |
| invalidContacts | Nenhum dos contatos foi cancelado, seja porque não existem ou porque não estavam inscritos na lista indicada. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 12 | Array de Ids de contatos para cancelar inscrição. Obrigatório. Máximo: 100 registros. |
| listId | 1 | Id da lista. Obrigatório. |
Description
Permite excluir vários contatos, considerando que:
- Caso alguns dos contatos indicados não existam, eles serão exibidos na resposta dentro de contactsNotFound.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactsNotFound | Nenhum dos contatos informados existe. |
Body
| Key | Value | Description |
|---|---|---|
| contactsIds[] | 49 | Array de Ids de contatos a excluir. Obrigatório. |
Description
Permite carregar os contatos a partir de um arquivo CSV. Tamanho máximo do arquivo: 30MB.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_invalidCountColumnsInParams | A quantidade de colunas do arquivo não corresponde à indicada nos parâmetros. |
| errorMsg_columnEmailNotFound | É obrigatório que a coluna Email esteja parametrizada. |
| errorMsg_mailListNotFound | Não existe lista com o ID indicado. |
| invalid_max_size_file | O tamanho do arquivo ultrapassou o máximo permitido: 30MB. |
Body
| Key | Value | Description |
|---|---|---|
| csv | Arquivo CSV. Obrigatório. | |
| mailList | 6 | Id da lista. Obrigatório. |
| qualifier | doubleQuote | Delimitador de campos. Obrigatório. Valores possíveis: quote (Aspas simples) e doubleQuote (Aspas duplas) |
| delimiter | comma | Separador de colunas. Obrigatório. Valores possíveis: comma (Vírgula) / semicolon (Ponto e vírgula) / numberSign (Cerquilha) / dollarSign (Símbolo de dólar) |
| ignoreFirstRow | 1 | Ignorar a primeira linha do arquivo. Obrigatório. Valores possíveis: 0 (Não) e 1 (Sim). |
| columns[0] | Array indicando a que campo corresponde cada coluna do arquivo CSV. Valores possíveis: Email (Corresponde à coluna Email) CustomFieldX (Corresponde ao código do campo personalizado indicado para a coluna. Veja os valores possíveis em: Obter coleção de campos personalizados). Os valores das colunas começam na posição 0. Ou seja, columns[0] representa a primeira coluna do arquivo CSV. | |
| columns[1] | CustomField1 | |
| columns[2] | CustomField4 |
Exclusões 3
Este módulo permitirá que você realize toda a gestão de exclusões de contatos para que suas campanhas não sejam enviadas a eles.
Description
Retorna uma lista com todas as exclusões criadas pelo Usuário. Podem ser filtradas por email.
Body
| Key | Value | Description |
|---|---|---|
| email@exemplo.com | Filtro por email. | |
| limit | 5 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | Critério para ordenar as exclusões. Valores possíveis: email/id. Por padrão: id. | |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Permite criar exclusões, tendo em conta que:
- Caso algumas das listas indicadas não existam, elas serão mostradas na resposta dentro de listsNotFound.
Erros:
| Código | Descrição |
|---|---|
| msg_listsNotFounds | Nenhuma das listas informadas existe. |
Body
| Key | Value | Description |
|---|---|---|
| always | 0 | Tipo de exclusão. Valores possíveis: 0 (sobre listas selecionadas) / 1 (sobre todas as listas e futuras). |
| emails[] | exclusion@ejemplo.com | Array de Ids de contatos a excluir. Requerido. Máximo: 100 registros. |
| listIds[] | 1 | Array de Ids de listas. Requerido para Tipo de exclusão = Sobre listas seccionadas. Máximo: 100 registros. |
Description
Permite eliminar uma exclusão criada pelo Usuário.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_exclusionNotFound | Não existe exclusão com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| exclusion_id | 3 | Id da exclusão a eliminar. Obrigatório. |
Body
Formulários 2
Este módulo permitirá que você realize toda a gestão associada a formulários para que os contatos possam se inscrever em suas listas.
Description
Retorna uma lista de todos os formulários. Podem ser filtrados por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do formulário |
| name | Nome do formulário |
Body
| Key | Value | Description |
|---|---|---|
| name | teste | Filtro por nome ou parte do nome do formulário. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | name | Critério para ordenar os formulários. Valores possíveis: name/id. Por padrão: id. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe de um formulário.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do formulário |
| name | Nome do formulário |
| mailLists | Lista(s) de contato(s) (ID e Nome) |
| urlSubsOK | URL de inscrição bem-sucedida |
| urlSubsError | URL de inscrição com erro |
| notificationEmail | Email para receber notificação ao inscrever um contato |
| emailConfirm.subject | Assunto do email de confirmação |
| emailConfirm.fromName | Remetente do email de confirmação |
| emailConfirm.fromEmail | Email “de” do email de confirmação |
| emailConfirm.replyToEmail | Email “para responder” do email de confirmação |
| urlConfirmOK | URL de confirmação de inscrição bem-sucedida |
| urlConfirmError | URL de confirmação de inscrição com erro |
| scriptFormWebSite | Código para seu site |
| urlFormWebSite | Link para redes sociais |
| codeQR | Código QR |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_formNotFound | Não existe formulário com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| form_id | 1 | Id do formulário. Obrigatório. |
Listas de contatos 6
Este módulo agrupa serviços para a gestão das listas de contatos que poderão ser utilizadas em suas campanhas.
Description
Retorna uma lista de todas as listas de contatos. Podem ser filtradas por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da lista |
| name | Nome da lista |
| count | Quantidade de contatos |
| lastSend | Data do último envio |
Body
| Key | Value | Description |
|---|---|---|
| name | name | Filtro por nome ou parte do nome da lista. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | id | Critério para ordenar as listas. Valores possíveis: name/id. Por padrão: id. |
| order | desc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Permite criar uma nova lista.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da lista criada |
| name | Nome da lista |
Body
| Key | Value | Description |
|---|---|---|
| name | Nova lista | Nome da lista. Obrigatório. Caracteres especiais não são permitidos. |
Description
Permite editar uma lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactListNotFound | Não existe lista com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 1 | Id da lista. Obrigatório. |
| name | Lista de teste | Nome da lista. Obrigatório. Caracteres especiais não são permitidos. |
Description
Permite excluir uma lista.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_listContactNotFound | Não existe lista com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| list_id | 10 | Id da lista a ser excluída. Obrigatório. |
Description
Permite excluir várias listas de contatos ao mesmo tempo, considerando que:
- Caso algumas das listas indicadas não existam, elas serão exibidas na resposta dentro de mailListsNotFound.
Erros:
| Código | Descrição |
|---|---|
| invalid_max_elements | No máximo podem ser excluídos até 100 registros. |
Body
| Key | Value | Description |
|---|---|---|
| ids[] | 6 | Array de IDs das listas a excluir. Obrigatório. No máximo 100. |
Modelos 1
Este módulo permitirá que você obtenha o detalhe dos seus templates, para depois usá-los para criar o conteúdo das suas campanhas/automations.
Description
Retorna uma lista de todos os modelos. Podem ser filtrados por etiquetas.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do modelo |
| name | Nome do modelo |
| tags | Etiquetas |
| created | Data de criação do modelo |
| thumbUrl | URL da miniatura |
Body
| Key | Value | Description |
|---|---|---|
| tags[] | Natal | Array de etiquetas |
| tags[] | Feliz | Array de etiquetas |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | id | Critério para ordenar os modelos. Valores possíveis: creation/id. Padrão: creation. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Padrão: desc. |
| name | Natal | Filtro por nome do modelo. |
Relatórios de campanhas/automação 10
Este módulo permitirá que você conheça o relatório e as estatísticas de cada campanha/automação enviada.
Description
Retorna o relatório geral de uma campanha/automação. Tenha em mente que:
- Para campanhas do tipo = Teste A/B é adicionada uma seção statisticsDetails com o detalhe das estatísticas para cada Assunto.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| campaign.name | Nome da campanha/automação. |
| campaign.sendDate | Data e hora de envio. Apenas para campanhas. |
| publicURL | URL do relatório público |
| delivery.totalAudience | Total de contatos. Para Campanhas: É a soma de todos os contatos incluídos nas listas ou segmentos para os quais a campanha foi enviada. Inclui os repetidos. Para automação: É a soma de todos os contatos que cumpriram o evento. |
| delivery.repeated | Contatos repetidos. Apenas para campanhas, automações não possuem repetidos. |
| delivery.total | Total de contatos - Contatos repetidos |
| delivery.bounces.hard.Amount | Rejeições permanentes |
| delivery.bounces.hard.Percentage | Percentual de rejeições permanentes sobre o total de rejeições |
| delivery.bounces.soft.Amount | Rejeições temporárias |
| delivery.bounces.soft.Percentage | Percentual de rejeições temporárias sobre o total de rejeições |
| delivery.bounces.total | Total de rejeições. São os e-mails que não puderam ser entregues porque os servidores dos e-mails de destino os rejeitaram |
| delivery.bounces.totalPercentage | Percentual de rejeições sobre o total de contatos |
| delivery.pending | Total de pendentes. São os endereços de e-mail para os quais o sistema ainda não enviou o e-mail |
| delivery.pendingPercentage | Percentual de pendentes sobre o total de contatos |
| delivery.delivered | Total entregues. Compreende o total de e-mails que chegaram ao destino |
| delivery.deliveredPercentage | Percentual de entregues sobre o total de contatos |
| performance.reads | Quantidade de vezes que a campanha/automação foi aberta |
| performance.uniqueReads | Quantidade de contatos que abriram a campanha/automação |
| performance.readsPercentage | Percentual de contatos que abriram a campanha/automação sobre o total entregue |
| performance.clicks | Quantidade de cliques feitos na campanha/automação |
| performance.uniqueClicks | Quantidade de contatos que clicaram na campanha/automação |
| performance.clicksPercentage | Percentual de contatos que clicaram na campanha/automação sobre o total entregue |
| performance.shared.total | Total de compartilhamentos |
| performance.shared.forwardto.Amount | Total de compartilhamentos por e-mail |
| performance.shared.forwardto.Percentage | Percentual de compartilhamentos por e-mail |
| performance.shared.facebook.Amount | Total de compartilhamentos pelo Facebook |
| performance.shared.facebook.Percentage | Percentual de compartilhamentos pelo Facebook |
| performance.shared.linkedin.Amount | Total de compartilhamentos pelo LinkedIn |
| performance.shared.linkedin.Percentage | Percentual de compartilhamentos pelo LinkedIn |
| performance.shared.twitter.Amount | Total de compartilhamentos pelo Twitter |
| performance.shared.twitter.Percentage | Percentual de compartilhamentos pelo Twitter |
| performance.shared.pinterest.Amount | Total de compartilhamentos pelo Pinterest |
| performance.shared.pinterest.Percentage | Percentual de compartilhamentos pelo Pinterest |
| performance.shared.whatsapp.Amount | Total de compartilhamentos pelo Whatsapp |
| performance.shared. whatsapp.Percentage | Percentual de compartilhamentos pelo Whatsapp |
| performance.unsubscriptions.total | Total de cancelamentos de inscrição |
| performance.unsubscriptions.alreadyUnsubscribed.Amount | Total de cancelamentos com motivo Já me descadastrei |
| performance.unsubscriptions.alreadyUnsubscribed.Percentage | Percentual de cancelamentos com motivo Já me descadastrei |
| performance.unsubscriptions.irrelevant.Amount | Total de cancelamentos com motivo Conteúdos irrelevantes |
| performance.unsubscriptions.irrelevant.Percentage | Percentual de cancelamentos por Conteúdos irrelevantes |
| performance.unsubscriptions.neverSignUp.Amount | Total de cancelamentos com motivo Nunca me inscrevi |
| performance.unsubscriptions.neverSignUp.Percentage | Percentual de cancelamentos com motivo Nunca me inscrevi |
| performance.unsubscriptions.spam.Amount | Total de cancelamentos com motivo Considero SPAM |
| performance.unsubscriptions.spam.Percentage | Percentual de cancelamentos com motivo Considero SPAM |
| performance.unsubscriptions.tooOften.Amount | Total de cancelamentos com motivo Frequência excessiva |
| performance.unsubscriptions.tooOften.Percentage | Percentual de cancelamentos com motivo Frequência excessiva |
| performance.unsubscriptions.other.Amount | Total de cancelamentos por outros motivos |
| performance.unsubscriptions.other.Percentage | Percentual de cancelamentos por outros motivos |
| performance.unsubscriptions.oneClickUnsubscribe.Amount | Total de cancelamentos com opção Cancelamento em um clique |
| performance.unsubscriptions.oneClickUnsubscribe.Percentage | Percentual de cancelamentos com opção Cancelamento em um clique |
| performance.complaints | Quantidade de reclamações. É o número de destinatários que marcaram a campanha/automação como spam |
| statisticsDetails.A.Subject | Assunto A |
| statisticsDetails.A.ContentPercentage | Proporção de envios (%) assunto A |
| statisticsDetails.A.TotalRecipients | Envios totais assunto A |
| statisticsDetails.A.SentRecipients | Envios realizados assunto A |
| statisticsDetails.A.PendingRecipients | Envios pendentes assunto A |
| statisticsDetails.A.ContactsReadPercentage | Aberturas (%) assunto A |
| statisticsDetails.A.ReadAmount | Aberturas totais assunto A |
| statisticsDetails.A.UniqueReadAmount | Contatos com aberturas assunto A |
| statisticsDetails.A.ContactsClickPercentage | Cliques (%) assunto A |
| statisticsDetails.A.ClickAmount | Cliques totais assunto A |
| statisticsDetails.A.UniqueClickAmount | Contatos com cliques assunto A |
| statisticsDetails.B.Subject | Assunto B |
| statisticsDetails.B.ContentPercentage | Proporção de envios (%) assunto B |
| statisticsDetails.B.TotalRecipients | Envios totais assunto B |
| statisticsDetails.B.SentRecipients | Envios realizados assunto B |
| statisticsDetails.B.PendingRecipients | Envios pendentes assunto B |
| statisticsDetails.B.ContactsReadPercentage | Aberturas (%) assunto B |
| statisticsDetails.B.ReadAmount | Aberturas totais assunto B |
| statisticsDetails.B.UniqueReadAmount | Contatos com aberturas assunto B |
| statisticsDetails.B.ContactsClickPercentage | Cliques (%) assunto B |
| statisticsDetails.B.ClickAmount | Cliques totais assunto B |
| statisticsDetails.B.UniqueClickAmount | Contatos com cliques assunto B |
| devices.mobileTotal | Total de aberturas em dispositivos móveis |
| devices.mobilePercentage | Percentual de aberturas em dispositivos móveis |
| devices.mobileAgents | Detalhe de aberturas em dispositivos móveis (Quantidade por agente e Percentual) |
| devices.desktopTotal | Total de aberturas em desktop |
| devices.desktopPercentage | Percentual de aberturas em desktop |
| devices.desktopAgents | Detalhe de aberturas em desktop (Quantidade por agente e Percentual) |
| devices.tabletTotal | Total de aberturas em tablets |
| devices.tabletPercentage | Percentual de aberturas em tablets |
| devices.tabletAgents | Detalhe de aberturas em tablets (Quantidade por agente e Percentual) |
| devices.unknownTotal | Total de aberturas em dispositivos desconhecidos |
| devices.unknownPercentage | Percentual de aberturas em dispositivos desconhecidos |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
URL Variables
| Key | Value | Description |
|---|---|---|
| campaign_id | 100 | Id da campanha/automação. Obrigatório. |
Description
Retorna o detalhe das aberturas da campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| Email do contato que realizou a abertura | |
| date | Data e hora da abertura |
| countryCode | País onde a campanha/automação foi aberta (Código ISO) |
| city | Cidade onde a campanha/automação foi aberta (Descrição) |
| platform | Dispositivo onde a campanha/automação foi aberta |
| latitude | Coordenada geográfica onde a campanha/automação foi aberta (latitude) |
| longitude | Coordenada geográfica onde a campanha/automação foi aberta (longitude) |
| app | Aplicativo onde a campanha/automação foi aberta |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id da campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe dos cliques realizados na campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do clique |
| url | Url onde foi clicado |
| Email do contato que realizou o clique |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id da campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe dos compartilhamentos da campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora em que a campanha/automação foi compartilhada |
| via | Meio pelo qual a campanha/automação foi compartilhada. Valores possíveis: forwardto -> Email facebook -> Facebook twitter -> Twitter linkedin -> LinkedIn pinterest -> Pinterest whatsapp -> WhatsApp |
| Email do contato que compartilhou a campanha/automação |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id da campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe dos bounces (duros e suaves) que foram registrados para a campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do bounce |
| type | Tipo de bounce. Valores possíveis: soft -> Bounce suave hard -> Bounce duro |
| Email do contato que bounceou |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
| type | hard | Filtro por tipo de bounce. Valores possíveis: soft/hard. |
Description
Retorna o detalhe das descadastramentos realizados na campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do descadastramento |
| reason | Motivo do descadastramento. Valores possíveis: irrelevant -> Conteúdos irrelevantes tooOften -> Frequência excessiva neverSignUp -> Nunca me inscrevi alreadyUnsubscribed -> Já me descadastrei spam -> Considero SPAM other -> Outros OneClickUnsubscribe -> Descadastramento com um clique |
| note | Notas adicionais quando seleciona motivo = Outros |
| Email do contato que se descadastrou |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id da campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe das reclamações feitas na campanha/automação.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora da reclamação |
| Email do contato que fez a reclamação |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe dos contatos excluídos seja por duplicado ou por estarem na lista de exclusão. Tenha em mente que estes últimos só eram registrados nas versões anteriores; agora não são mais registrados.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| Email do contato excluído | |
| reason | Razão da exclusão. Valores possíveis: duplicated -> Duplicado banned -> Na lista de exclusão |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 386 | Id de campanha/automação. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por email. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna um arquivo com o detalhe dos contatos para os quais a campanha/automação foi enviada.
Importante: Esta informação estará disponível apenas por 6 meses a partir do envio da campanha/automação, após esse período não poderá mais ser baixada.
Estrutura de saída:
Será gerado um arquivo sents.txt contendo em cada linha: data de envio, hora de envio e email do contato para o qual a campanha/automação foi enviada.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado |
| errorMsg_campaignStatisticsNotFound | A campanha/automação ainda não foi enviada |
| errorMsg_campaignSentsNotFound | O arquivo não está mais disponível por ter passado mais de 6 meses desde o envio da campanha/automação |
Body
| Key | Value | Description |
|---|---|---|
| id | 352 | Id da campanha/automação. Obrigatório. |
Description
Retorna um arquivo com o detalhe dos contatos duplicados.
Importante: Esta informação estará disponível apenas por 6 meses a partir do envio da campanha/automação, após esse período não poderá mais ser baixada.
Estrutura de saída:
Será gerado um arquivo duplicates.csv contendo dois dados: email do contato repetido e quantidade de repetições.
Erros:
| Código | Descrição |
|---|---|
| errorMsg_campaignNotFound | Não existe campanha/automação com o ID informado |
| errorMsg_campaignStatisticsNotFound | A campanha/automação ainda não foi enviada |
| errorMsg_campaignDuplicatesNotFound | O arquivo não está mais disponível por ter passado mais de 6 meses desde o envio da campanha/automação |
Body
| Key | Value | Description |
|---|---|---|
| id | 9 | Id da campanha/automação. Obrigatório. |
Relatórios de contatos 6
Este módulo permitirá que você conheça o detalhe da atividade do contato.
Description
Retorna o detalhe das aberturas de campanhas realizadas pelo contato.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora da abertura |
| countryCode | País de onde foi aberta |
| platform | Dispositivo de onde foi aberta |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Padrão: desc. |
Description
Retorna o detalhe dos cliques realizados pelo contato.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do clique |
| url | URL onde clicou |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Padrão: desc. |
Description
Retorna o detalhe das campanhas compartilhadas pelo contato.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora em que a campanha foi compartilhada |
| via | Meio pelo qual a campanha foi compartilhada. Valores possíveis: forwardto -> Email facebook -> Facebook twitter -> Twitter linkedin -> LinkedIn pinterest -> Pinterest whatsapp -> WhatsApp |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Description
Retorna o detalhe dos rebotes (duros e suaves) que foram registrados para o contato.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do rebote |
| type | Tipo de rebote. Valores possíveis: soft -> Rebote suave hard -> Rebote duro |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Padrão: desc. |
| type | hard | Filtro por tipo de rejeição. Valores possíveis: soft/hard. |
Description
Retorna o detalhe das descadastramentos realizados pelo contato a partir das campanhas.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora do descadastramento |
| reason | Razão do descadastramento. Valores possíveis: irrelevant -> Conteúdos irrelevantes tooOften -> Frequência excessiva neverSignUp -> Nunca me inscrevi alreadyUnsubscribed -> Já me descadastrei spam -> Considero SPAM other -> Outros |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Padrão: desc. |
Description
Retorna o detalhe das reclamações feitas pelo contato a partir das campanhas.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| date | Data e hora da reclamação |
| campaignName | Nome da campanha |
Erros:
| Código | Descrição |
|---|---|
| errorMsg_contactNotFound | Não existe contato com o ID informado. |
Body
| Key | Value | Description |
|---|---|---|
| id | 2 | Id do contato. Obrigatório. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| order | asc | Ordenar por data. Valores possíveis: asc/desc. Por padrão: desc. |
Segmentos 1
Este módulo permite obter um detalhe dos segmentos que poderão ser utilizados em suas campanhas.
Description
Retorna uma lista de todos os segmentos. Podem ser filtrados por nome.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID do segmento |
| name | Nome do segmento |
| created | Data de criação |
| members | Quantidade de contatos |
| lastSend | Data do último envio |
Body
| Key | Value | Description |
|---|---|---|
| name | name | Filtro por nome ou parte do nome do segmento. |
| limit | 10 | Quantidade de registros a mostrar por página. Máximo: 100. |
| page | 1 | Número da página a mostrar. |
| orderBy | id | Critério para ordenar os segmentos. Valores possíveis: name/id. Por padrão: id. |
| order | asc | Tipo de ordenação. Valores possíveis: asc/desc. Por padrão: desc. |
Tarefas 1
Este módulo permitirá que você obtenha o detalhe das tarefas geradas a partir da ferramenta.
Description
Retorna uma lista das tarefas realizadas. Podem ser filtradas por estado.
Estrutura de saída:
| Campo | Descrição |
|---|---|
| id | ID da tarefa |
| date | Data e hora da tarefa |
| type | Tarefa realizada. Valores possíveis: excludeContacts -> Carregar exclusões contactsCopied -> Gestão de contatos>Copiar contactsMoved -> Gestão de contatos>Mover contactsExported -> Gestão de contatos>Exportar contactsUnsubscribed -> Gestão de contatos>Cancelar inscrição contactsDeleted -> Gestão de contatos>Excluir importContacts -> Importação de contatos segmentUpdated -> Atualização de segmento reportSummary -> Relatórios de campanhas>Relatório resumo reportReads -> Relatórios de campanhas>Aberturas reportClicks -> Relatórios de campanhas>Cliques reportPerformance -> Relatórios de campanhas>Desempenho reportDelivery -> Relatórios de campanhas>Entregues reportShareds -> Relatórios de campanhas>Compartilhados reportUnsubscriptions -> Relatórios de campanhas>Cancelamentos reportExclusions -> Relatórios de campanhas>Exclusões reportBounces -> Relatórios de campanhas>Rebotes reportComplaints -> Relatórios de campanhas>Reclamações reportSent -> Relatórios de campanhas>Enviados reportBans -> Exportar exclusões reportSummaryMulti -> Selecionar vários Relatórios>Exportar relatórios downloadGDPR -> Exportar dados da conta exportSegment -> Segmentos>Exportar exportList -> Listas>Exportar |
| details.total | Total processados. Este campo só é exibido para as tarefas que realizam processamentos sobre registros. |
| details.imported | Total de contatos importados. Este campo só é exibido para a tarefa importContacts. |
| details.notImported | Total de contatos NÃO importados. Este campo só é exibido para a tarefa importContacts. |
| details.sourceImport | Tipo de importação. Este campo só é exibido para a tarefa importContacts. Valores possíveis: copypaste -> De Copiar e colar .csv -> De arquivo CSV Gmail -> De Gmail Outlook -> De Outlook |
| details.moved | Total de contatos movidos. Este campo só é exibido para a tarefa contactsMoved. |
| details.notMoved | Total de contatos NÃO movidos. Este campo só é exibido para a tarefa contactsMoved. |
| details.copied | Total de contatos copiados. Este campo só é exibido para a tarefa contactsCopied. |
| details.notCopied | Total de contatos NÃO copiados. Este campo só é exibido para a tarefa contactsCopied. |
| details.campaingName | Nome da campanha de referência. Este campo só é exibido para as tarefas correspondentes a Relatórios de campanhas. |
| details.name | Nome do segmento ou lista. Este campo só é exibido para as tarefas realizadas sobre segmentos ou listas. |
| details.contacts | Quantidade de contatos. Este campo só é exibido para a tarefa segmentUpdated. |
| downloadLink | Link para baixar o arquivo. Para poder baixá-lo será necessário autenticar-se da mesma forma que nos demais serviços. OBS: As tarefas downloadGDPR e segmentUpdated são as únicas tarefas que NÃO geram arquivos. |
| status | Estado da tarefa. Valores possíveis: completed -> Finalizada pending -> Em processo |
Body
| Key | Value | Description |
|---|---|---|
| status | completed | Filtro por estado da tarefa. Valores possíveis: completed (Finalizadas) e pending (Em processo). |