DocumentaçãoSDK no GitHub

Documentação Guias

Variáveis e condições

Permita que autores adicionem textos, links e layouts por destinatário. Resolva-os no fluxo de envio.

Nesta página

Definir variáveis de personalização

Configure mergeTags no painel ou SDK. Cada variável tem id estável, label, o token exato esperado pelo seu envio e kind: text ou url. sampleValue é opcional e serve apenas para prévias.

typescript
// Run on your mounted editor instance.
editor.updateConfig({
  mergeTags: [
    { id: 'first_name', label: 'First name', token: '{{first_name}}', kind: 'text', sampleValue: 'Alex' },
    { id: 'account_url', label: 'Account URL', token: '{{account_url}}', kind: 'url', sampleValue: 'https://example.com/account' },
  ],
});

const output = await editor.exportHTML();
console.log(output.mergeTags, output.mergeTagIssues);
// Exports retain literal tokens. Resolve recipient values before delivery.

Definir layouts condicionais

Configure displayConditions com id, label, before e after. Use a sintaxe de abertura e fechamento da sua plataforma. Autores aplicam uma regra em Exibir quando numa seção ou layout completo de colunas. Layouts aninhados exigem que todas as regras superiores sejam atendidas.

A Weavour preserva a sintaxe; seu sistema de envio a avalia. Prévias de cenários usam resultados de exemplo e não alteram exportações normais. Condições exigem SDK 0.1.6 ou posterior e um editor hospedado compatível.

typescript
editor.updateConfig({
  displayConditions: [{
    id: 'free_account', label: 'Free accounts', category: 'Account',
    before: "{% if account.plan == 'free' %}", after: '{% endif %}',
  }],
});
const output = await editor.exportHTML();
// Evaluate the host syntax before delivering HTML and plain text.
console.log(output.displayConditions, output.displayConditionIssues);
// Persist onDocumentChange envelopes; reopen with emailDocument.

Atualizar definições sem perder regras salvas

Definições do SDK são mescladas por ID sobre as do painel. [] não adiciona substituições; undefined remove as substituições do SDK. Variáveis e condições salvas preservam a sintaxe original. Alterar uma definição não reescreve e-mails existentes.

Salve o envelope completo de onDocumentChange e reabra com emailDocument. E-mails condicionais usam schemaVersion: 2; não remova nem reduza essa versão.

Resolver personalização antes de enviar

  • Confira mergeTagIssues e displayConditionIssues de exportHTML(). Revise definições alteradas ou indisponíveis.
  • Avalie a sintaxe das condições exportadas e substitua tokens no HTML, texto simples, assunto e pré-cabeçalho no seu sistema de envio.
  • Como alternativa, renderize JSON salvo com mergeValues e conditionValues booleanos no seu backend.
Precisa de ajuda? Fale com a gente