Acesso Comercial / Docs / Storefront / API
Ctrl K
MUTATION

lead

Captura dados de lead para formulários de contato, downloads de e-book e capturas em geral.

Input

LeadMutationInput!

CampoTipoDescrição
hostnameString!Hostname da loja.
nameStringNome do lead.
emailString!E-mail do lead.
phoneStringTelefone do lead.
sourceStringFonte do lead (ex: "homepage", "ebook-landing").

Retorno

CampoTipoDescrição
successBooleanSe o lead foi capturado com sucesso.
Também disponível: ebookLead — variante específica para downloads de e-book com campos adicionais.

Mutation

GraphQL
mutation CaptureLead($input: LeadMutationInput!) {
  lead(input: $input) {
    success
  }
}

Variables

JSON
{
  "input": {
    "hostname": "minha-loja",
    "name": "Ana Costa",
    "email": "ana@email.com",
    "phone": "11977776666",
    "source": "homepage"
  }
}

Resposta

JSON
{
  "data": {
    "lead": {
      "success": true
    }
  }
}

Fetch

JavaScript
const response = await fetch('/graphql', {
  method: 'POST',
  credentials: 'include',
  headers: { 'Content-Type': 'application/json' },
  body: JSON.stringify({
    query: `mutation($input: LeadInput!) {
      lead(input: $input) { success }
    }`,
    variables: { input: { hostname: "minha-loja", name: "Maria", email: "maria@email.com", cellphone: "11999999999" } }
  })
});

cURL

Bash
curl -X POST https://minha-loja.com/graphql \
  -H "Content-Type: application/json" \
  -d '{"query":"mutation { lead(input: { hostname: \"minha-loja\", name: \"Maria\", email: \"maria@email.com\" }) { success } }"}'