Páginas da documentação

Desenvolvedores · Referência · v1.2.0

Rascunho pela IA

A IA do LeadGo monta a campanha a partir de um briefing; você revisa e cria.

https://leadgo.com.br/api/v1 Baixar arquivo para IA OpenAPI 3.1 Criar token
POST /campaign-briefs ai:draft

Montar campanha com a IA

O mesmo "Criar com a IA" do painel: a partir do objetivo, da verba, da região, do link, da descrição livre e das mídias, a IA escreve nome, público, interesses e a copy de cada anúncio. Nada é publicado: a resposta traz data.campaign, pronto para revisar e enviar em POST /campaigns. Leva até ~2 minutos (configure o timeout do seu cliente para 180 s). Limite de 15 por hora por pessoa, somado ao painel.

Corpo

objective obrigatório string sales, leads, lead_form, traffic, awareness, whatsapp.
description obrigatório string O que é anunciado, para quem e o diferencial (10 a 2000 caracteres).
budget.amount_cents obrigatório integer Verba diária em centavos.
link_url string Obrigatório nos objetivos com link (sales, leads, traffic, awareness).
media_ids obrigatório string[] Mídias prontas (1 a 10); a IA escreve uma copy para cada.
persona_id integer Com persona, o público é o dela e a IA escreve para ela.
targeting.countries string[] Países (padrão BR).
targeting.cities object[] Cidades (de GET /targeting/cities).
tracking.pixel_id string Pixel, nos objetivos sales e leads (sem ele, o padrão da conta).
whatsapp.phone_number string Número do WhatsApp (E.164), no objetivo whatsapp.
lead_form.privacy_policy_url string Política de privacidade, no objetivo lead_form (sem ela, a de Leads › Configurações).

Exemplo

cURL
curl -X POST "https://leadgo.com.br/api/v1/campaign-briefs" \
  -H "Authorization: Bearer $LEADGO_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "objective": "sales",
    "description": "Loja de suplementos para mulheres que treinam. Whey e creatina com 30% off e frete grátis acima de R$ 199.",
    "budget": {
        "amount_cents": 5000
    },
    "link_url": "https://loja.exemplo.com.br/suplementos",
    "media_ids": [
        "01jbx3m7k2q8f5v9w4n6c0r1ht"
    ]
}'

Resposta 200

HTTP 200
{
    "data": {
        "campaign": {
            "name": "Vendas | Suplementos | Outubro",
            "goal": "conversions",
            "status": "paused",
            "budget": {
                "type": "daily",
                "amount_cents": 5000
            },
            "tracking": {
                "conversion_event": "PURCHASE"
            },
            "targeting": {
                "countries": [
                    "BR"
                ],
                "age_min": 25,
                "age_max": 45,
                "gender": "female",
                "interests": [
                    {
                        "id": "6003107902433",
                        "name": "Fitness"
                    }
                ]
            },
            "link_url": "https://loja.exemplo.com.br/suplementos",
            "creatives": [
                {
                    "media_id": "01jbx3m7k2q8f5v9w4n6c0r1ht",
                    "headline": "Whey com 30% off",
                    "body": "Treine melhor com o whey que cabe no bolso.",
                    "description": "Frete grátis",
                    "call_to_action": "SHOP_NOW"
                }
            ]
        },
        "rationale": "Público feminino fitness com interesse em suplementos.",
        "unresolved_interests": []
    }
}

Erros: validation_failed, ai_rate_limited, ai_unavailable, ad_account_not_linked