Autoresponder.Sequences

Esta integração que permite consultar em quais sequências de e-mails automáticos um cliente está inserido na Flowbiz, atravez do gatilho entrou no segmento. É possível realizar filtros por datas de entrada e saída, para visualizar e acompanhar com maior precisão o status e participação dos clientes nos diferentes fluxos automáticos em períodos específicos.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Retornos


{
  "Subscriber": {
    "ID": "12345",                         //ID do contato
    "Email": "[email protected]"           //E-mail do contato
  },
  "Sequences": [
    {
      "AutoresponderID": "001",            //ID do envio automático
      "Name": "Boas-vindas",               // Nome do envio automático
      "EntryDate": "2024-02-01T10:00:00Z", // Data que entrou no segmento
      "Status": "Active"                   // Status do segmento
    },
    {
      "AutoresponderID": "002",
      "Name": "Recuperação de Carrinho",
      "EntryDate": "2024-02-05T15:30:00Z",
      "Status": "Active"
    },
    {
      "AutoresponderID": "003",
      "Name": "Engajamento Pós-Compra",
      "EntryDate": "2023-12-10T12:45:00Z",
      "ExitDate": "2024-01-15T09:00:00Z",  // Data que saiu do segmento
      "Status": "History"
    }
  ]
}

Códigos de erro

  • Caso nenhum parâmetro obrigatório seja informado:
{
  "Error": {
    "Code": "400",
    "Description": "É obrigatório informar pelo menos um dos parâmetros: Email ou SubscriberID."
  }
}
  • Caso não seja enviada a APIkey:
{
  "Error": {
    "Code": "401",
    "Description": "É obrigatório informar o parâmetro APIKey."
  }
}
  • Caso não sejam encontrados dados:
{
  "Error": {
    "Code": "404",
    "Description": "Nenhuma sequência encontrada para os parâmetros informados."
  }
}
Query Params
string
required

Chave de Autenticação

string
required
Defaults to Autoresponder.Sequences

Comando da API

string
Defaults to JSON
string

E-mail do cliente (obrigatório caso SubscriberID não seja informado).

string

Identificador único do cliente na Flowbiz(obrigatório caso Email não seja informado).

string

Status da sequência, podendo ser "active" ou "history".

string

Filtro de data de entrada inicial (Greater than or Equal). Formato AAAA-MM-DD.

string

Filtro de data de saída final (Less than or Equal). Formato AAAA-MM-DD.

Response
200
Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here!