Criar campanha no Instantly, por uma API

Cria uma campanha como rascunho, com agenda, passos de email e contas de envio. Adicione leads com Create lead e inicie com Activate campaign.

Identificador
instantly_create_campaign

A chamada

POST https://connect.reportei.com/api/tools/instantly_create_campaign/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>",
    "campaign_schedule": {}
  }
}

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âmetroTipoObrigatórioDescrição
namestringSimName of the campaign.
campaign_scheduleobjectSimWhen the campaign sends.
sequencesarrayNãoThe email copy, as a single sequence with its steps. Instantly only reads the first item.
email_listarrayNãoSending accounts, by the email from List accounts.
daily_limitintegerNãoMaximum emails the campaign sends per day.
daily_max_leadsintegerNãoMaximum new leads contacted per day.
email_gapintegerNãoMinutes between two emails of the campaign.
stop_on_replybooleanNãoWhen true, a lead who replies gets no more steps.
stop_on_auto_replybooleanNãoWhen true, an automatic reply, like out of office, also stops the lead.
stop_for_companybooleanNãoWhen true, a reply stops every lead of the same company domain.
open_trackingbooleanNãoWhether to track opens.
link_trackingbooleanNãoWhether to track link clicks.
text_onlybooleanNãoWhen true, every email goes as plain text.

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_create_campaign. Ele vira a definição de tool do seu agente sem conversão.

Outras tools do Instantly

Ver as 12 tools

Toolkits da mesma categoria

Ver os 100 toolkits

Veja o Connect aplicado ao seu produto.

Teste por 15 dias sem cartão, ou mostre seu cenário ao nosso time.