Sequências via API

Entenda como gerenciar sequências e seus contatos via API.

É possível gerenciar sequências diretamente via API, realizando operações de listagem, adição e remoção de contatos de forma programática. O comportamento segue as mesmas regras da plataforma.

As mesmas regras da plataforma se aplicam via API. Contatos que já fazem parte da sequência não serão adicionados novamente.

Endpoints disponíveis

Listar sequências

Retorna todas as sequências cadastradas na conta.

Método: GET
Endpoint: Sequências > Listar

Listar contatos

Retorna todos os contatos atualmente em execução em uma sequência específica.

Método: GET
Endpoint: Sequências > Listar contatos
Parâmetros necessários: ID da sequência

Adicionar contato

Adiciona um único contato a uma sequência.

Método: POST
Endpoint: Sequências > Adicionar contato
Parâmetros necessários: ID da sequência + ID do contato ou telefone

Adicionar contatos

Adiciona múltiplos contatos a uma sequência em uma única requisição.

Método: POST
Endpoint: Sequências > Adicionar contatos
Parâmetros necessários: ID da sequência + lista de IDs dos contatos ou telefones

Remover contato

Remove um único contato de uma sequência.

Método: DEL
Endpoint: Sequências > Remover contato
Parâmetros necessários: ID da sequência + ID do contato ou telefone

Remover contatos

Remove múltiplos contatos de uma sequência em uma única requisição.

Método: DEL
Endpoint: Sequências > Remover contatos
Parâmetros necessários: ID da sequência + lista de IDs dos contatos ou telefones