Notificacoes Inteligentes (0.1.0)

Download OpenAPI specification:Download

Email para suporte: suporte@notificacoesinteligentes.com

API do Notificações Inteligentes para controle das integrações.

Autorização & Autenticação

A autenticação é realizada através do método Bearer Token, utilizando a chave de API do usuário. Para mais detalhes sobre a chave de API acesse nossa documentação

Toda requisição precisa ter o header Accept:

Accept: application/json

Para mais detalhes sobre os eventos da API, assista o video abaixo ou clique aqui

Como sei que deu certo?

Acompanhe a tela de estatísticas da sua integração. Nela, temos todos os envios diários.

Caso não saiba onde fica essa tela, acesse este artigo para saber como verificar as estatísticas.

Já fiz tudo, e agora?

Se não houver nenhum envio depois de um tempo, verifique se a sua integração está conectada a uma instância.

Recomendamos que você:

NÃO tente testar manualmente os webhooks da integração. A operação pode causar grandes problemas caso passe algum telefone incorreto ou com falta de dados;
NÃO tente enviar uma notificação para o mesmo número de telefone que faz os envios. A operação não dá certo, ok?

Teste de endpoint

Sempre que for fazer algum teste utilizando nossos endpoints, recomendamos que altere os valores do Request Body em cada requisição para evitar problemas, pois, não repetimos os payloads.

Too Many Requests

As rotas de eventos das integrações podem receber, no máximo, 60 requisições por minuto.

Padrões de datas da API

Em nossa API existem duas formas de nos fornecer datas:

A primeira forma consiste em nos informar apenas a data Ano-mês-dia, esta forma deve ser usada nos eventos relacionados a Rastreio e Boletos, lembrando que mesmo sem nos fornecer dados como Hora:minuto:segundos, esta data deve estar em Timezone UTC +0

"created_at": "2020-03-10"

A segunda forma consiste em nos informar a data e o horário Ano-mês-dia Hora:minuto:segundo, esta forma deve ser usada nos demais eventos que utilizam datas, lembrando que esta data e horário devem estar em Timezone UTC +0

"created_at": "2020-03-10 13:26:57"

Opt-out

Ao criar um Opt-Out, o sistema buscará todas as instâncias em comum com as lojas conectadas na instância atual e aplicará o bloqueio do contato em todas elas.

Gerenciamento da conta

Busca endereço

Busca os dados do endereço através do CEP fornecido

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

arrays

Responses

Request samples

Payload

Content type

application/json

[ ]

Response samples

200
400

Content type

application/json

[ ]

Gerenciamento de Integrações

Lista integrações

Lista todas as integrações

Authorizations:

bearer_token

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200

Content type

application/json

{"data": [{"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
}
],
"links": {"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Cria integração

Cria uma nova integração com os dados fornecidos

Authorizations:

bearer_token

header Parameters

Content-Type required	string Value: "application/json"
Accept required	string Value: "application/json"

Request Body schema: application/json

name

required

string <= 100 characters

Nome da integração para identificação no painel

platform

required

string (Platform)

Enum: "abmex" "active-campaign" "api-next" "app-max" "asaas" "azcend" "bling-invoices" "bling-orders-2" "braavo" "braip" "brasil-na-web" "builder-all" "calendly" "cartpanda" "climba" "cloudfox" "compra-rapida" "convertize" "convvert" "digital-manager-guru" "dinamize" "dooca" "doppus" "ead-plataforma" "eduzz-2" "elementor" "evermart" "e-com-plus" "e-goi" "fidelimax" "fidelizar" "find-my-pack-next" "forms-app" "funnel-kit" "galax-pay" "greenn" "hero-spark" "hopy" "hotmart" "hotmart-v2" "hubla" "hubspot" "infusionsoft" "irroba" "iset-2" "istpay" "iugu" "jet" "kapsula" "kiwify-2" "lastlink" "lead-lovers" "lpqv" "loja-integrada" "macro" "magazord" "mailchimp" "manychat" "mautic" "member-kit" "monetizze-2" "moovin" "notazz" "nuvem-shop" "omie" "pagali" "pagar-me-1" "pagar-me-2" "pag-hiper" "payt" "pepper" "perfect-pay" "pluga" "prestashop" "rd-station" "saiu-pra-entrega" "shopify-next" "shoppub" "simplo-7" "stripe" "thrivecart" "ticto-3" "tiny" "track-co" "tray" "tray-corp" "tryplo" "via-shop-moda" "vindi" "vnda" "vtex" "wapstore" "wbuy" "we-help" "webstore" "wide-pay" "witure" "woocommerce" "woocommerce-cart-abandonment-recovery" "yampi" "yapay"

Plataforma da integração

Responses

Request samples

Payload

Content type

application/json

{"name": "Loja de Doces",
"platform": "abmex"
}

Response samples

201
422

Content type

application/json

{"data": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
}
}

Atualiza integração

Permite a atualização de informações da integração

Authorizations:

bearer_token

path Parameters

store

required

integer

header Parameters

Content-Type required	string Value: "application/json"
Accept required	string Value: "application/json"

Request Body schema: application/json

name	string <= 100 characters Nome da integração para identificação no painel

Responses

Request samples

Payload

Content type

application/json

{"name": "Loja de Doces"
}

Response samples

200
403
404

Content type

application/json

{"data": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
}
}

Mostra integração

Mostra detalhes de uma integração específica

Authorizations:

bearer_token

path Parameters

store

required

integer

query Parameters

append

string

Enum: "setup_fields" "available_events" "checklist"

Usado para anexar atributos à resposta

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Responses

Response samples

200
401
403
404

Content type

application/json

{"data": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
}
}

Eventos API

Evento de carrinho abandonado

Cria um novo evento de carrinho abandonado na integração

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object Dados sobre o checkout
required	object (Customer) Dados sobre um cliente
required	object Dados sobre o pedido não concluído

Responses

Request samples

Payload

Content type

application/json

{"checkout": {"url": "string"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de boleto impresso

Cria um novo evento de boleto impresso na integração

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (BilletOrder) Dados sobre um pedido com método de pagamento por boleto

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"billet_url": "https://link.boleto/12345",
"billet_pdf": "https://link.boleto/12345?pdf",
"billet_barcode": "123456789 123456789 123456789 123456789",
"billet_value": 99.9,
"billet_due_date": "2020-01-01",
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido cancelado

Cria um novo evento de pedido cancelado na integração

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (Order) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido pago

Cria um novo evento de pedido pago na integração

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (Order) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido estornado

Cria um novo evento de pedido estornado na integração

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (Order) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido entregue

Cria um novo evento de pedido entregue

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (ShippingOrder) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"delivery": {"fee": 10,
"description": "Entrega em até 3 dias úteis",
"code": "AB123456789",
"url": "https://correios.com.br",
"estimate": "2020-01-01"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido despachado

Cria um novo evento de pedido que foi despachado para a transportadora

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (ShippingOrder) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"delivery": {"fee": 10,
"description": "Entrega em até 3 dias úteis",
"code": "AB123456789",
"url": "https://correios.com.br",
"estimate": "2020-01-01"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pedido processando

Cria um novo evento de pedido que está sendo processado (em separação, em processo de embalagem, etc)

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (Order) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pacote saiu para entrega

Cria um novo evento de pacote saiu para entrega

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (ShippingOrder) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"delivery": {"fee": 10,
"description": "Entrega em até 3 dias úteis",
"code": "AB123456789",
"url": "https://correios.com.br",
"estimate": "2020-01-01"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pacote com progresso atualizado

Cria um novo evento de pacote com progresso atualizado

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (ShippingOrder) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"delivery": {"fee": 10,
"description": "Entrega em até 3 dias úteis",
"code": "AB123456789",
"url": "https://correios.com.br",
"estimate": "2020-01-01"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de pacote aguardando retirada

Cria um novo evento de pacote aguardando retirada

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (ShippingOrder) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"delivery": {"fee": 10,
"description": "Entrega em até 3 dias úteis",
"code": "AB123456789",
"url": "https://correios.com.br",
"estimate": "2020-01-01"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de aguardando pagamento

Cria um novo evento de pedido que está aguardando o pagamento ser efetuado

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

	object (Address) Dados sobre o endereço cliente
required	object (Customer) Dados sobre um cliente
required	object (Order) Dados básicos necessários para um pedido

Responses

Request samples

Payload

Content type

application/json

{"address": {"city": "Betim",
"complement": "BL1 AP2",
"neighborhood": "Centro",
"number": "1234",
"postal_code": "12345-123",
"state": "MG",
"street": "Avenida Amazonas"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"order": {"id": "PEDIDO12345",
"products_total": 299.97,
"total": 269.97,
"discount": 50,
"status": "Pedido Aprovado",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
],
"pix": {"bacen_code": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"due_date": "2020-01-01 13:26:57",
"qr_code": "00020126580014br.gov.bcb.pix0136123e4567-e12b-12d1-a456-4266554400005204000053039865802BR5913Fulano de Tal6008BRASILIA62070503***63041D3D",
"url": "https://url.com",
"value": 155.99
},
"payment_type": "credit-card"
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de acesso criado

Cria um novo evento de acesso criado para membros

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

required	object (Access) Dados sobre acesso à area de membros dos clientes
required	object (Customer) Dados sobre um cliente

Responses

Request samples

Payload

Content type

application/json

{"access": {"url": "https://url.com",
"first_access_url": "https://url.com/primeiro-acesso/abc-123-abc-123",
"login": "[email protected]",
"password": "12usuario34",
"products": [{"name": "Barra de Chocolate",
"quantity": 3,
"value": 5
}
]
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento de redefinição de senha

Cria um novo evento de redefinição de senha

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

required	object (ResetPassword) Dados sobre à redefinição de senha
required	object (Customer) Dados sobre um cliente

Responses

Request samples

Payload

Content type

application/json

{"reset_password": {"url": "https://meusite.com/redefinir-senha"
},
"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento relacionado a nota de recomendação do cliente

Cria um novo evento com a nota referente a disposição do cliente em recomendar algo a terceiros

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

required	object (Customer) Dados sobre um cliente
required	object Dados sobre o Note promoter score

Responses

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"nps": {"answer": {"answered_at": "2019-12-08 12:30:00",
"comment": "Ótimo serviço",
"score": 10
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Evento relacionado a pesquisa de recomendação ao cliente

Cria um novo evento com o link para pesquisa

Authorizations:

bearer_token

header Parameters

Accept required	string Value: "application/json"
Content-Type required	string Value: "application/json"

Request Body schema: application/json

required	object (Customer) Dados sobre um cliente
required	object Dados sobre o Note promoter score

Responses

Request samples

Payload

Content type

application/json

{"customer": {"first_name": "João",
"last_name": "Oliveira",
"phone": "+5531991234567",
"email": "[email protected]",
"cpf_cnpj": "91006434089",
"ip": "8.8.8.8"
},
"nps": {"survery": {"url": "https://url.com"
}
}
}

Response samples

Content type

application/json

{"data": {"id": 0,
"store_id": 0,
"headers": { },
"input": { },
"created_at": "2020-03-10T13:26:57+00:00"
}
}

Contatos

Cria um novo contato

Cria um novo contato a conta do usuário

Authorizations:

bearer_token

Request Body schema: application/json

name required	string or null Nome do contato
phone required	string Número de telefone do contato
email required	string or null Email do contato
notes	string or null Observações atribuídas ao lead
tags	Array of strings Lista com os nomes das tags

Responses

Request samples

Payload

Content type

application/json

{"name": "João",
"phone": "+5531992284862",
"email": "[email protected]",
"notes": "Captado via campanhas",
"tags": ["Lead Novo"
]
}

Response samples

201
403
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
}

Lista contatos

Lista os contatos da conta

Authorizations:

bearer_token

query Parameters

limit	integer Limita a quantidade de itens por página
page	integer Usado para manipular a paginação da coleção
include	string Enum: "lists" "lists.source" Relacionamentos que podem ser inclusos na requisição
filter[name]	string Example: filter[name]=João Filtra por contatos que possuam o nome
filter[phone]	string Example: filter[phone]=5531912341234 Filtra por contatos que possuam o telefone
filter[email]	string Example: filter[email][email protected] Filtra por contatos que possuam o email
filter[tags]	Array of strings Example: filter[tags]=1 Filtra por contatos que possuam as tags

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200
403

Content type

application/json

{"data": [{"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
],
"links": {"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Mostra contato

Mostra os dados de um contato da conta

Authorizations:

bearer_token

path Parameters

lead

required

integer

ID do contato

query Parameters

include

string

Enum: "lists" "lists.source"

Relacionamentos que podem ser inclusos na requisição

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
}

Atualiza um contato

Edita um contato já existente associado ao usuário

Authorizations:

bearer_token

path Parameters

lead

required

integer

ID do contato

header Parameters

Accept

required

string

Value: "application/json"

Request Body schema: application/json

name	string or null Nome do contato
phone	string Número de telefone do contato
email	string or null Email do contato
notes	string or null Observações atribuídas ao lead

Responses

Request samples

Payload

Content type

application/json

{"name": "João",
"phone": "+5531992284862",
"email": "[email protected]",
"notes": "Captado via campanhas"
}

Response samples

200
403
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
}

Exclui contato

Exclui os dados de um contato da conta

Authorizations:

bearer_token

path Parameters

lead

required

integer

ID do contato

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

403
404

Content type

application/json

{"error": "unauthorized"
}

Adiciona listas à um contato

Adiciona as listas informadas à um contato específico

Authorizations:

bearer_token

path Parameters

lead

required

integer

ID do contato

header Parameters

Accept

required

string

Value: "application/json"

Request Body schema: application/json

lists

required

Array of integers

Lista com os identificadores das listas

Responses

Request samples

Payload

Content type

application/json

{"lists": [1
]
}

Response samples

200
401
403
404
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
}

Remove listas de um contato

Remove as lista informadas de um contato específico

Authorizations:

bearer_token

path Parameters

lead

required

integer

ID do contato

header Parameters

Accept

required

string

Value: "application/json"

Request Body schema: application/json

lists

required

Array of integers

Lista com os identificadores das listas

Responses

Request samples

Payload

Content type

application/json

{"lists": [1
]
}

Response samples

200
401
403
404
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
}

Listas de Contatos

Lista listas de contatos

Lista as listas de contatos da conta

Authorizations:

bearer_token

query Parameters

include	string Enum: "source" "leadsCount" Relacionamentos que podem ser inclusos na requisição
append	string Value: "has_leads" Propriedades que podem ser inclusas na resposta
filter[name]	string Example: filter[name]=lista de contatos do whatsapp Filtra por listas que possuam o nome
filter[type]	string Example: filter[type]=stream Filtra pelo tipo da lista

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200
403

Content type

application/json

{"data": [{"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{ }
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": { }
}
}
]
}
],
"links": {"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Mostra lista de contatos

Mostra os dados de uma lista de contatos da conta

Authorizations:

bearer_token

path Parameters

list

required

integer

ID da lista

query Parameters

include

string

Value: "source"

Relacionamentos que podem ser inclusos na requisição

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{ }
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": { }
}
}
]
}
}

Atualiza uma lista de leads

Atualiza o nome de uma lista de leads

Authorizations:

bearer_token

path Parameters

list

required

integer

ID da lista

Responses

Response samples

200
403
404

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{ }
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": { }
}
}
]
}
}

Lista contatos da lista

Lista os contatos de uma lista específica

Authorizations:

bearer_token

path Parameters

list

required

integer

ID da lista

query Parameters

limit	integer Limita a quantidade de itens por página
page	integer Usado para manipular a paginação da coleção
include	string Enum: "lists" "lists.source" Relacionamentos que podem ser inclusos na requisição
filter[name]	string Example: filter[name]=João Filtra por contatos que possuam o nome
filter[phone]	string Example: filter[phone]=5531912341234 Filtra por contatos que possuam o telefone
filter[email]	string Example: filter[email][email protected] Filtra por contatos que possuam o email

header Parameters

Accept

required

string

Value: "application/json"

Responses

Response samples

200
403

Content type

application/json

{"data": [{"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": { }
}
]
}
}
],
"links": {"first": "string",
"last": "string",
"prev": "string",
"next": "string"
},
"meta": {"current_page": 0,
"from": 0,
"last_page": 0,
"path": "string",
"per_page": 0,
"to": 0,
"total": 0
}
}

Adiciona contatos à lista

Adiciona os contato informados para uma lista de contatos específica

Authorizations:

bearer_token

path Parameters

list

required

integer

ID da lista

header Parameters

Accept

required

string

Value: "application/json"

Request Body schema: application/json

leads

required

Array of integers

Lista com os identificadores dos contatos

Responses

Request samples

Payload

Content type

application/json

{"leads": [1
]
}

Response samples

200
401
403
404
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{ }
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": { }
}
}
]
}
}

Remove contatos da lista

Remove os contatos informados de uma lista específica

Authorizations:

bearer_token

path Parameters

list

required

integer

ID da lista

header Parameters

Accept

required

string

Value: "application/json"

Request Body schema: application/json

leads

required

Array of integers

Lista com os identificadores dos contatos

Responses

Request samples

Payload

Content type

application/json

{"leads": [1
]
}

Response samples

200
401
403
404
422

Content type

application/json

{"data": {"id": 1,
"owner_id": 1,
"name": "Lista da minha loja",
"type": "stream",
"leads_count": 15,
"has_leads": true,
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"source_type": "store",
"source": {"id": 1,
"name": "Loja de Doces",
"platform": "abmex",
"token": "16a3debc-5be5-4fdb-b5c1-693c662bd31e",
"created_at": "2020-03-10T13:26:57+00:00",
"updated_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"happy_flow_enabled_at": "2022-09-019T10:54:00+00:00",
"setup": { },
"setup_ready_at": "2020-03-10T13:26:57+00:00",
"queue_days_limit": 2,
"setup_fields": [ ],
"category": "affiliate",
"needs_setup": true,
"needs_api": true,
"needs_token": true,
"needs_webhook": true,
"has_pix_event": true,
"deprecated_store": false,
"webhook_url": "string"
},
"tags": [{"id": 1,
"label": "Venda",
"description": "Tag de Vendas",
"color": "FFFFFF",
"hexadecimal_color": "#FFFFFF",
"created_at": "2022-09-02T13:00:00+00:00",
"updated_at": "2022-09-02T13:00:00+00:00",
"deleted_at": "2022-09-02T13:00:00+00:00",
"leads": {"id": 1,
"owner_id": 1,
"phone": "+5531992284862",
"name": "João",
"email": "[email protected]",
"photo": "https://fotos.com/foto123",
"notes": "Captado via campanhas",
"tags": [{ }
],
"custom_variables": [ ],
"created_at": "2020-03-10T13:26:57+00:00",
"deleted_at": "2020-03-10T13:26:57+00:00",
"last_whatsapp_activity_at": "2020-03-10T13:26:57+00:00",
"list": { }
}
}
]
}
}