storefront.leads.capture(input)

Registra ou atualiza um lead na vitrine (newsletter, modal, pop-up). Prefira o hook useCaptureLead nas seções React.

Input

Campo	Obrigatório	Descrição
`email`	Sim, no cliente	Texto não vazio. O cliente não verifica formato
`fields`	—	Objeto JSON livre (`name`, `phone`, …) — máx. 10 KB
`source`	—	Origem do formulário (`newsletter_footer`, `lead_capture_modal`, …)
`optedIn`	—	Consentimento de marketing (default `false`)
`sessionId`	—	Sessão do visitante
`pageUrl`, `referrer`	—	Rastreio de página
`utmSource` … `utmContent`	—	UTMs

Exemplo direto

import { createStorefront, getLeadTrackingContext } from '@corvex/theme-sdk';

const storefront = createStorefront({ storeId: 'uuid-da-loja' });

const result = await storefront.leads.capture({
  email: 'maria@example.com',
  fields: { name: 'Maria Silva' },
  source: 'lead_capture_modal',
  optedIn: true,
  ...getLeadTrackingContext(),
});

// result.lead.isNew === true → primeiro cadastro

Hook recomendado

import { useCaptureLead } from '@corvex/theme-sdk';

const { capture, status, isNew, error } = useCaptureLead('newsletter_footer');

async function onSubmit(email) {
  await capture({ email, optedIn: true });
}

Escopo

✅ Section, snippet, modal no tema
❌ Rotas admin (GET /stores/:storeId/leads) — apenas painel O cliente não impõe 10 KB nem cota por minuto. Se a API responde 429, o erro fica com code: 'RATE_LIMIT_EXCEEDED'. Os números 5 por minuto e 100 por minuto não estão neste repositório.

Cookbook: Newsletter Capture Veja também Lead (resource).