ArgorantDocs

Campanhas do início ao fim

Crie a campanha, escreva os e-mails, adicione uma lista, escolha as caixas de e-mail e inicie. Cada etapa é uma chamada, e nada é enviado antes do início.

Nada é enviado até você chamar launch. As mesmas etapas existem como comandos de linha de comando e ferramentas MCP, então um agente pode executar o fluxo inteiro e perguntar ao usuário antes do início. Envie um header Idempotency-Key em cada chamada para que uma nova tentativa nunca faça o trabalho duas vezes.

Verifique se há uma caixa de e-mail conectada

Shell
curl "https://app.argorant.com/api/v1/inboxes" -H "Authorization: Bearer $ARGORANT_API_KEY"

Ainda não tem caixa de e-mail? Conecte um Google Workspace em uma etapa (guia), o Microsoft 365 no app, ou uma caixa de e-mail de qualquer outro provedor com as configurações de servidor dele (guia).

Crie a campanha com as configurações

Shell
curl -X POST "https://app.argorant.com/api/v1/campaigns" \
  -H "Authorization: Bearer $ARGORANT_API_KEY" -H "Content-Type: application/json" \
  -d '{
    "name": "Q4 CFO outreach",
    "daily_limit": 40, "per_mailbox_daily_limit": 20,
    "timezone": "Europe/Berlin", "timezone_mode": "fixed",
    "window_start": "08:00", "window_end": "17:00", "skip_weekends": true,
    "gap_minutes_min": 60, "gap_minutes_max": 120,
    "planned_start_date": "2026-10-01", "tags": ["q4"]
  }'

Só name é obrigatório, e todas as configurações podem ser alteradas depois com PATCH /api/v1/campaigns/{id}. timezone_mode: "lead" envia no horário local de cada pessoa. As campanhas enviam texto simples, que é o que melhor chega à caixa de entrada. Não há linha de descadastro, a menos que você defina include_unsubscribe como true.

Escreva a sequência

Shell
curl -X POST "https://app.argorant.com/api/v1/campaigns/$ID/emails" \
  -H "Authorization: Bearer $ARGORANT_API_KEY" -H "Content-Type: application/json" \
  -d '{"emails":[
    {"subject":"Quick question, {{first_name}}","body":"Hi {{first_name}},\n\nsaw {{company}} is hiring in finance. Worth a 10 minute call?\n\nBest"},
    {"body":"Bumping this up in case it got buried.","delay_days":3,"same_thread":true}
  ]}'

O primeiro e-mail precisa de um assunto. Por padrão, os follow-ups ficam na mesma conversa e esperam delay_days depois do anterior. Você pode usar {{first_name}}, {{last_name}}, {{company}}, {{company_normalized}} (o nome que as pessoas falam), {{title}} e qualquer coluna que você enviou com as pessoas, como {{plan}}. Escreva {a|b} para variar uma frase por pessoa. Adicione variants a um e-mail para ter outras versões; elas são enviadas em alternância. Uma linha personalizada por pessoa é configurada com PUT /api/v1/campaigns/{id}/personalization; veja Encontre 200 pessoas e envie e-mails para elas.

Adicione a lista

Shell
curl -X POST "https://app.argorant.com/api/v1/campaigns/$ID/leads" \
  -H "Authorization: Bearer $ARGORANT_API_KEY" -H "Content-Type: application/json" \
  -d '{"list_id": 1240}'
# {"input_rows": 1240, "inserted": 1188, "duplicates_skipped": 12, "skipped_not_valid": 40, "queued_for_verification": 0}

Ou envie as suas próprias rows com email, first_name, last_name, company, title e qualquer coluna sua. Cada endereço é verificado antes de entrar. Quando uma lista tem endereços que não podem ser confirmados, a primeira resposta pergunta quais incluir (needs_choice); chame de novo com "grades": ["valid"] (recomendado) ou ["valid", "catch_all"]. Pessoas dos dados do Argorant custam 1 crédito cada na primeira vez; as suas próprias linhas são grátis. Endereços pessoais (e-mail gratuito, internet residencial) são adicionados como qualquer outro; envie "exclude_private_emails": true para ter só e-mails corporativos.

Vincule os remetentes

Shell
curl -X POST "https://app.argorant.com/api/v1/campaigns/$ID/senders" \
  -H "Authorization: Bearer $ARGORANT_API_KEY" -H "Content-Type: application/json" \
  -d '{"all_connected": true}'

Ou indique emails específicos. Os e-mails são distribuídos entre as caixas de e-mail, cada uma dentro do próprio limite diário.

Inicie

Shell
curl "https://app.argorant.com/api/v1/campaigns/$ID" -H "Authorization: Bearer $ARGORANT_API_KEY" | jq .launch_blockers
curl -X POST "https://app.argorant.com/api/v1/campaigns/$ID/launch" -H "Authorization: Bearer $ARGORANT_API_KEY"

launch_blockers fica vazio quando a campanha pode começar. Antes de iniciar, POST /api/v1/campaigns/{id}/test-email envia para você um teste de um e-mail, preenchido com um contato de exemplo. Inicie só depois que o usuário disser sim. pause segura a campanha, stop a encerra, e DELETE remove uma campanha que não está em andamento.

Acompanhe o andamento

GET /api/v1/campaigns/{id}/analytics?days=30 traz os números por dia (enviados, respostas, respostas positivas, bounces, descadastros) com totais e taxas. GET /api/v1/campaigns/{id} tem as contagens ao vivo. GET /api/v1/campaigns/{id}/leads?status=replied lista quem respondeu, e GET /api/v1/campaigns/{id}/replies traz as mensagens. Para respostas de todas as campanhas, use a caixa de entrada. GET /api/v1/campaigns/{id}/senders lista as caixas de e-mail que enviam a campanha, com o status delas.

Altere as pessoas de uma campanha em andamento

POST /api/v1/campaigns/{id}/leads/remove tira muitas pessoas de uma vez, escolhidas por status, resposta, bounce, domínio de e-mail, tag, endereços ou uma lista salva. Envie "preview": true primeiro para ver quantas sairiam. Pessoas que já receberam um e-mail ficam, a menos que você envie "include_contacted": true. Uma adição ou remoção grande roda em segundo plano: a resposta é 202 com um job, e GET /api/v1/campaigns/{id}/lead-jobs/{job_id} diz quanto já avançou.

Linhas personalizadas para muitas pessoas vão em um só arquivo: POST /api/v1/campaigns/{id}/leads/custom-fields/import aceita um arquivo CSV, JSON ou NDJSON com até 200.000 linhas (50 MB). As linhas que as pessoas já têm são mantidas e listadas com a linha do arquivo. Para corrigi-las, envie com ?overwrite=true; uma coluna clear (ou null em JSON) remove uma linha, e a pessoa volta a receber o texto alternativo. Toda linha substituída volta na resposta, a antiga e a nova.

Pastas

GET /api/v1/folders lista as suas pastas, POST /api/v1/folders cria uma e PATCH /api/v1/folders/{id} a renomeia. POST /api/v1/campaigns/{id}/folder com um folder_id coloca uma campanha na pasta, e null a tira de novo. As pastas só organizam as campanhas; o envio não é afetado.

Caixas de e-mail e a lista de bloqueio

GET /api/v1/inboxes lista as suas caixas de e-mail com filtros por domínio, status, tag e provedor. PATCH /api/v1/inboxes/{email} define o limite diário de uma caixa de e-mail, o aquecimento, se ela pode enviar, o nome ou o fuso horário, e DELETE a desconecta. POST /api/v1/inboxes/update faz a mesma alteração em muitas caixas de e-mail de uma vez, escolhidas por domínio, tag, status ou endereço; por padrão ele mostra uma prévia e não altera nada até você enviar "preview": false. POST /api/v1/blocklist com um endereço ou um domínio interrompe todo e-mail para ele no seu workspace; DELETE /api/v1/blocklist/{id} desfaz isso.

As mesmas etapas no terminal

Shell
argorant campaigns create --name "Q4 CFO outreach" --daily-limit 40 --window 08:00-17:00 --timezone Europe/Berlin
argorant campaigns emails set "Q4 CFO" --step 1 --subject "Quick question, {{first_name}}" --body-file step1.txt
argorant campaigns emails set "Q4 CFO" --step 2 --body "Bumping this up." --delay-days 3
argorant campaigns leads add "Q4 CFO" --list 1240
argorant campaigns senders set "Q4 CFO" --all
argorant campaigns test "Q4 CFO" --step 1
argorant campaigns launch "Q4 CFO"
argorant campaigns leads remove "Q4 CFO" --not-replied --domains competitor.com --preview
argorant campaigns folders create --name "Q4"
argorant campaigns move "Q4 CFO" --folder Q4
argorant inboxes update --domains northgate-advisory.com --daily-limit 30

Nesta página