Ativar campanha no Instantly, por uma API
Inicia uma campanha em rascunho ou retoma uma pausada. A Instantly passa então a enviar os passos aos leads da campanha, das contas em email_list, dentro da agenda.
- Identificador
- instantly_activate_campaign
A chamada
POST https://connect.reportei.com/api/tools/instantly_activate_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"id": "<id>"
}
}Seu sistema envia o id da conexão do cliente e os argumentos da tool. Os headers são os mesmos de toda a API do Connect: o token do seu produto e o token do cliente.
Parâmetros
As descrições dos parâmetros seguem a documentação oficial do app, em inglês.
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| id | string | Sim | Id of the campaign, from List campaigns. |
Conexões possíveis
O seu cliente conecta a conta do Instantly uma vez, por um dos modos abaixo. A mesma conexão serve para todas as tools do toolkit.
Chave de API
O cliente cola a chave do app numa tela do Connect, ou o seu sistema envia a chave por POST /api/customer-toolkits, sem tela.
A resposta
Em caso de sucesso, o Connect preserva o status e o corpo da resposta do app. Erros HTTP retornados pelo app usam o envelope {error, api_error}; falhas de autenticação ou validação podem ocorrer antes da execução. O header X-Toolkit-Execution-Id identifica a execução registrada, consultável em GET /api/tools/executions/{uuid}.
Pronta para agentes de IA
O input desta tool é um JSON Schema, disponível em GET /api/tools/instantly_activate_campaign. Ele vira a definição de tool do seu agente sem conversão.
Outras tools do Instantly
- Listar campanhasGETLista as campanhas do workspace com id, nome e status, até limit por página. Para a próxima página, passe next_starting_after como starting_after, até que ele deixe de voltar.
- Obter campanhaGETRetorna uma campanha com status, agenda, sequences (os passos de email e suas variantes), contas de envio em email_list e opções de envio.
- Criar campanhaPOSTCria uma campanha como rascunho, com agenda, passos de email e contas de envio. Adicione leads com Create lead e inicie com Activate campaign.
- Atualizar campanhaPATCHAltera uma campanha. Envie só os campos a mudar; sequences e campaign_schedule substituem os atuais por inteiro.
- Pausar campanhaPOSTPausa uma campanha, e nenhum email sai até que Activate campaign a retome.
- Obter métricas da campanhaGETRetorna, por campanha, leads, contatados, emails enviados, aberturas, respostas, cliques em links, bounces, descadastros, leads concluídos e oportunidades, de uma campanha ou de todas.
- Listar leadsPOSTLista leads com email, nomes, empresa, status e status de interesse, até limit por página. Para a próxima página, passe next_starting_after como starting_after, até que ele deixe de voltar.
- Criar leadPOSTAdiciona um lead a uma campanha ou a uma lista de leads. Um lead adicionado a uma campanha ativa entra na sequência e recebe emails conforme a agenda.
Toolkits da mesma categoria
Ver os 100 toolkitsVeja o Connect aplicado ao seu produto.
Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.
