For AI agents: the complete documentation index is available at https://docs.clickmax.io/llms.txt, the full documentation bundle is available at https://docs.clickmax.io/llms-full.txt, and this page is available as Markdown at https://docs.clickmax.io/reference/api/capture-links.md.
  • Português
  • Links de captura

    Os links de captura servem para enviar dados de um lead para a Clickmax sem depender de um formulário criado dentro da plataforma.

    Na prática, você recebe uma URL de captura e envia para ela os dados que quer salvar, como nome, email e telefone.

    Se você já tem uma landing page, um formulário externo ou uma integração própria, basta usar o link de captura gerado na Clickmax e enviar os dados do lead para essa URL. A Clickmax recebe essas informações e cria ou atualiza o lead automaticamente.

    Exemplo de envio

    O envio deve ser feito com método POST e com o conteúdo em formato JSON.

    Exemplo de URL:

    https://api.clickmax.dev/ingest/SEU_LINK_DE_CAPTURA

    Exemplo de payload:

    {
      "email": "[email protected]",
      "name": "Maria Silva",
      "telephone": "5511999999999",
      "document": "12345678900",
      "profession": "Analista",
      "city": "São Paulo",
      "state": "SP",
      "instagram": "mariasilva",
      "birthday": "1990-05-20",
      "address": {
        "street": "Av. Paulista",
        "number": "1000",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "zipCode": "01310-100",
        "country": "BR"
      },
      "customFields": {
        "empresa": "Acme Inc",
        "orcamento": 50000
      },
      "utmSource": "facebook",
      "utmMedium": "cpc",
      "utmCampaign": "campanha-de-captacao",
      "utmContent": "criativo-a",
      "utmTerm": "gestao comercial"
    }

    Exemplo com curl:

    curl -X POST "https://api.clickmax.dev/ingest/SEU_LINK_DE_CAPTURA" \
      -H "Content-Type: application/json" \
      --data '{
        "email": "[email protected]",
        "name": "Maria Silva",
        "telephone": "5511999999999",
        "utmSource": "facebook",
        "utmMedium": "cpc",
        "utmCampaign": "campanha-de-captacao",
        "utmContent": "criativo-a",
        "utmTerm": "gestao comercial"
      }'

    Campos mais comuns

    CampoO que significa
    emailEmail do lead
    nameNome do lead
    telephoneTelefone somente com números
    documentDocumento do lead (CPF/CNPJ), só números
    professionProfissão do lead
    cityCidade do lead
    stateEstado (UF) do lead
    instagram@ do Instagram (sem o @)
    birthdayData de nascimento no formato AAAA-MM-DD
    addressObjeto de endereço com os subcampos street, number, complement, neighborhood, city, state, zipCode, country. Todos os subcampos são opcionais — envie apenas os que tiver (ex.: só city e state)
    utmSourceOrigem do tráfego
    utmMediumMeio da campanha
    utmCampaignNome da campanha
    utmContentVariação do anúncio ou criativo
    utmTermTermo ou palavra-chave
    customFieldsObjeto com seus campos customizados. A chave pode ser o nome do campo, o rótulo ou o id do campo customizado; o valor é o conteúdo

    Campos customizados

    Você pode enviar valores para os campos customizados do seu workspace usando o objeto customFields. Cada chave identifica um campo e pode ser:

    • o nome do campo (ex.: empresa),
    • o rótulo exibido (ex.: Empresa), ou
    • o id do campo customizado.

    Campos não encontrados são ignorados silenciosamente (o lead é criado mesmo assim). Os campos customizados são gravados apenas na criação do lead — se o lead já existir (mesmo e-mail ou telefone), eles não são sobrescritos.

    Cuidados importantes

    • envie o telefone somente com números
    • sempre que possível, envie pelo menos nome, email ou telefone para identificar o lead com mais facilidade

    Resposta esperada

    Quando o envio for aceito, a resposta retorna um identificador do lead criado:

    {
      "leadId": "088a60ed-7fe6-4a96-b7dd-a91573fc3cdc"
    }

    Resumo rápido

    Se você já tem uma página ou formulário fora da Clickmax, o link de captura é a forma mais simples de enviar esses dados para dentro da plataforma.