# Boas-vindas em uma chamada: do cadastro ao primeiro e-mail

> Crie uma campanha de Disparo por API em modo Imediato com o e-mail de boas-vindas. No cadastro do seu app, chame /api/campaigns/trigger com o lead como objeto. A BIP cria ou atualiza o contato e envia na hora. Com a reentrada desligada, cada pessoa recebe as boas-vindas uma vez só.

Fonte: https://wiki.bip.marketing/pt-br/boas-vindas-em-uma-chamada · Atualizado: 2026-10-08

<UseCaseMeta effort="api" channel="email" plan="free" />

Quem cria a conta no seu app recebe as boas-vindas no mesmo instante, com o próprio nome, a partir de uma única chamada do seu servidor.

<Checklist items="Uma conta na BIP (vale o plano gratuito)|Acesso ao servidor do seu app, onde o cadastro acontece|O nome (2 caracteres ou mais) e o e-mail de quem se cadastra|Uma chave de API com Disparo de Campanhas e Escrita de Contatos|Recomendado: um domínio de envio próprio verificado (planos pagos)" />

## O que você vai conseguir

- Boas-vindas no instante do cadastro, com o primeiro nome da pessoa.
- Contato criado e e-mail enviado na mesma chamada: sem rotina de sincronização e sem planilha.
- Nenhum contato duplicado: quem já estava na BIP tem o perfil atualizado.
- Boas-vindas uma vez só por pessoa, mesmo que o seu sistema chame a API duas vezes.
- Tags e campos do cadastro no contato, prontos para segmentar depois.
- O e-mail saindo com o endereço da sua marca, se você usar domínio próprio.

## Como funciona

<Steps items="Alguém cria a conta no seu app|Seu servidor chama a BIP com os dados da pessoa|A BIP cria o contato e envia as boas-vindas na hora" />

A campanha usa o **Disparo por API** no modo **Imediato**. Na prática:

- Seu servidor chama `/api/campaigns/trigger` com o `lead` como objeto. A BIP procura o contato pelo e-mail ou pelo telefone. Se encontra, atualiza; se não encontra, cria. Contato novo precisa de `name` com pelo menos 2 caracteres.
- No modo **Imediato**, o envio entra na fila assim que a BIP recebe a chamada. A resposta traz `"mode": "immediate"` e o `leadId` do contato.
- Com a **Janela de Reentrada do Lead** desligada (o padrão), cada contato recebe a campanha uma vez só, para sempre. Para boas-vindas, é exatamente o que você quer: uma chamada repetida aparece como **Rejeitado** e não conta como envio.
- No BIP Lite, cada e-mail de boas-vindas processado usa um envio do mês.

## Passo a passo

### 1. Crie o campo do plano

A mesma chamada que dispara as boas-vindas pode guardar dados do cadastro. Crie antes os campos que o seu app vai mandar. Tags não precisam de preparo.

1. Em **Configurações** → **Geral**, vá até **Campos** e clique em **Adicionar Campo**.
2. Em **Tipo de Campo**, escolha **String**. Em **Nome do Campo**, digite _Plano_.
3. Clique em **Salvar**.

<Shot src="/img/boas-vindas-em-uma-chamada/1-pt-br.png" alt="Campo personalizado Plano, do tipo String, em Configurações, aba Geral" url="dash.bip.marketing/…/settings" />

### 2. Crie a chave de API

1. Em **Configurações**, abra a aba **Chaves de API** e clique em **Adicionar Nova Chave de API**.
2. Em **Nome**, digite _Nimbus App — cadastro_.
3. Em **Escopos**, ligue **Disparo de Campanhas** e **Escrita de Contatos**. Os dois juntos permitem criar o contato e disparar na mesma chamada.
4. Clique em **Salvar** e copie a **Chave de API**. Guarde a chave no servidor, numa variável de ambiente, e nunca no código do app.

<Shot src="/img/boas-vindas-em-uma-chamada/2-pt-br.png" alt="Nova chave de API com os escopos Disparo de Campanhas e Escrita de Contatos ligados" url="dash.bip.marketing/…/settings?tab=api-keys" />

### 3. Monte o e-mail de boas-vindas

1. Em **Modelos de Email**, clique em **Novo Modelo**.
2. Clique em **Configurações** e preencha **Nome**, **Idioma** (**Português**), **Assunto** e **Pré-visualização**. Os textos estão em [Pronto para copiar](#pronto-para-copiar).
3. Monte os blocos: logo, cabeçalho com o primeiro nome, texto com os primeiros passos, botão para o app e assinatura.
4. No assunto e no cabeçalho, digite `@first` e escolha `lead.firstName()`. Clique em cada etiqueta e preencha o **Valor de Fallback**.
5. Clique em **Pré-visualização** → **Enviar Email de Prévia** para ver o e-mail na sua caixa de entrada.
6. Clique em **Salvar**.

<Shot src="/img/boas-vindas-em-uma-chamada/3-pt-br.png" alt="Editor de e-mail com as boas-vindas do Nimbus App e o primeiro nome no cabeçalho" url="dash.bip.marketing/…/emails-templates/…" />

### 4. Envie com o domínio da sua marca

Recomendado, nos planos pagos. As boas-vindas são o primeiro e-mail que a pessoa recebe de você: um remetente como `ola@nimbusapp.com.br` é reconhecido na caixa de entrada, e as respostas chegam a uma caixa que o seu time lê.

1. Em **Configurações** → **Domínios de Email**, adicione `nimbusapp.com.br` e crie no DNS os registros que a BIP mostra. O passo a passo completo está em [Domínio de envio próprio](/pt-br/dominio-de-envio).
2. Com o status **Verificado**, vá a **Configurações** → **Geral** e preencha **Email De (Nome)** e **Email De (Endereço)**.
3. Clique em **Salvar**.

No plano gratuito, pule este passo: os e-mails saem de `no-reply@bip.marketing`, com o nome que você define em **Email De (Nome)**.

<Shot src="/img/boas-vindas-em-uma-chamada/4-pt-br.png" alt="Domínio nimbusapp.com.br com o status Verificado em Domínios de Email" url="dash.bip.marketing/…/settings?tab=email-domains" />

### 5. Crie a campanha de boas-vindas

1. Em **Campanhas**, clique em **Nova Campanha**.
2. Em **Nome da Campanha**, digite _Boas-vindas — Nimbus App_ e escolha o emoji 👋.
3. Em **Tipo de Agendamento**, escolha **Disparo por API** e, em **Modo de Disparo**, **Imediato**.
4. Deixe **Permitir Reentrada do Lead** desligado: cada pessoa recebe as boas-vindas uma vez.
5. Em **Canal**, escolha **Email**. Em **Nome do remetente**, digite _Sofia, do Nimbus App_. Em **Email de envio**, fique com **Padrão da Conta** ou escolha o seu domínio e digite `ola`.
6. Em **Modelo de E-mail**, ligue o modelo do passo 3.

<Shot src="/img/boas-vindas-em-uma-chamada/5-pt-br.png" alt="Campanha com Disparo por API no modo Imediato e o canal Email com remetente e modelo" url="dash.bip.marketing/…/campaigns/…" />

### 6. Teste e ative

1. Clique em **Salvar** → **Salvar Rascunho**.
2. Clique em **Testar Campanha**, digite o seu e-mail e clique em **Enviar Teste**. Se você ainda não é contato, crie-se antes em **Contatos** → **Criar Contato**.
3. Confira o remetente, o assunto e o seu nome no e-mail. O teste não consome envios.
4. Clique em **Salvar** → **Salvar e Ativar** e confirme em **Ativar Disparo por API**. A campanha passa ao status **Ativo** e começa a aceitar chamadas.

<Shot src="/img/boas-vindas-em-uma-chamada/6-pt-br.png" alt="Janela Testar Campanha com o e-mail do contato e o botão Enviar Teste" url="dash.bip.marketing/…/campaigns/…" />

### 7. Ligue o cadastro do app à BIP

1. Na campanha, abra **Integração via API**. Os comandos já vêm com o ID da campanha, que também está no fim do endereço da página.
2. No seu servidor, logo depois de criar a conta do usuário, chame `/api/campaigns/trigger` com o `lead` como objeto: `name`, `email`, as `tags` e os `fields` do cadastro.
3. Guarde o `leadId` da resposta junto do usuário. Ele serve para registrar eventos desse contato depois.
4. Não deixe uma falha na chamada travar o cadastro: registre o erro e siga em frente.

Se o seu formulário de cadastro não pede o nome, passe a pedir. A BIP precisa de um nome com pelo menos 2 caracteres para criar o contato. Telefone, se mandar, sempre com `+` e código do país.

<Shot src="/img/boas-vindas-em-uma-chamada/7-pt-br.png" alt="Painel Integração via API com os comandos de disparo da campanha de boas-vindas" url="dash.bip.marketing/…/campaigns/…" />

## Pronto para copiar

### Campanha

| Opção                           | Valor                                           |
| ------------------------------- | ----------------------------------------------- |
| **Nome da Campanha**            | 👋 Boas-vindas — Nimbus App                     |
| **Tipo de Agendamento**         | **Disparo por API**                             |
| **Modo de Disparo**             | **Imediato**                                    |
| **Janela de Reentrada do Lead** | **Permitir Reentrada do Lead** desligado        |
| **Canal**                       | **Email**                                       |
| **Nome do remetente**           | Sofia, do Nimbus App                            |
| **Email de envio**              | `ola@nimbusapp.com.br` (ou **Padrão da Conta**) |
| **Modelo de E-mail**            | Boas-vindas · Nimbus App                        |

### Campo

| **Nome do Campo** | **Tipo de Campo** | Exemplo de valor |
| ----------------- | ----------------- | ---------------- |
| Plano             | **String**        | Trial            |

### E-mail

Onde aparece `[@primeiro nome]`, digite `@first`, escolha `lead.firstName()` e use o **Valor de Fallback** da tabela do fim desta seção.

<Copy label="Assunto">
[@primeiro nome], sua conta no Nimbus App está pronta
</Copy>

<Copy label="Pré-visualização">
Três passos para organizar a primeira semana do seu time.
</Copy>

| Ordem | Bloco                    | Ajuste sugerido                                               |
| ----- | ------------------------ | ------------------------------------------------------------- |
| 1     | **Adicionar Imagem**     | Logo do Nimbus App, **Largura Máxima (px)** 160, centralizado |
| 2     | **Adicionar Cabeçalho**  | Saudação com o primeiro nome                                  |
| 3     | **Adicionar Texto**      | Os três primeiros passos                                      |
| 4     | **Adicionar Botão**      | Uma ação só, com **Largura** de 50                            |
| 5     | **Adicionar Texto**      | Convite para responder                                        |
| 6     | **Adicionar Assinatura** | **Simples**                                                   |

<Copy label="Cabeçalho">
Que bom ter você aqui, [@primeiro nome]!
</Copy>

<Copy label="Texto">
Sua conta no Nimbus App já está ativa. Para aproveitar bem os primeiros dias, comece por aqui:

1. Crie o seu primeiro projeto.
2. Convide quem trabalha com você.
3. Defina os prazos da semana e acompanhe tudo num painel só.
</Copy>

<Copy label="Botão — Nome">
Abrir o Nimbus App
</Copy>

<Copy label="Botão — URL do Link" code>
https://nimbusapp.com.br/entrar
</Copy>

<Copy label="Texto final">
Ficou com alguma dúvida? É só responder este e-mail: a resposta chega direto ao nosso time.
</Copy>

O texto final funciona com o domínio próprio, em que as respostas chegam à caixa de envio. No plano gratuito, troque por:

<Copy label="Texto final (plano gratuito)">
Ficou com alguma dúvida? Escreva para ajuda@nimbusapp.com.br.
</Copy>

| Campo da **Assinatura** | Valor              |
| ----------------------- | ------------------ |
| **Predefinição**        | **Simples**        |
| **Nome**                | Sofia Costa        |
| **Título**              | Sucesso do Cliente |
| **Empresa**             | Nimbus App         |
| **Website**             | nimbusapp.com.br   |

| Variável           | Onde        | **Valor de Fallback** |
| ------------------ | ----------- | --------------------- |
| `lead.firstName()` | **Assunto** | Olá                   |
| `lead.firstName()` | Cabeçalho   | cliente               |

Todo contato criado pela API tem nome, então o fallback raramente aparece.

### Remetente

| Onde                          | Campo                   | Valor                  |
| ----------------------------- | ----------------------- | ---------------------- |
| **Configurações** → **Geral** | **Email De (Nome)**     | Nimbus App             |
| **Configurações** → **Geral** | **Email De (Endereço)** | `ola@nimbusapp.com.br` |
| Campanha                      | **Nome do remetente**   | Sofia, do Nimbus App   |

### API

Troque `SUA_CHAVE_DE_API` pela sua chave e `ID_DA_CAMPANHA` pelo ID do painel **Integração via API**.

<Copy label="curl" code>
curl -X POST https://api.bip.marketing/api/campaigns/trigger \
  -H "Content-Type: application/json" \
  -H "x-bip-api-key: SUA_CHAVE_DE_API" \
  -d '{
    "campaignId": "ID_DA_CAMPANHA",
    "lead": {
      "name": "Tiago Pereira",
      "email": "tiago.pereira@exemplo.com",
      "tags": ["trial"],
      "fields": [{ "key": "Plano", "value": "Trial" }]
    }
  }'
</Copy>

<Copy label="Resposta" code>
{"campaignId": "ID_DA_CAMPANHA", "leadId": "ID_DO_CONTATO", "mode": "immediate"}
</Copy>

<Copy label="TypeScript" code>
// No servidor do Nimbus App
const API_KEY = process.env.BIP_API_KEY ?? 'SUA_CHAVE_DE_API';
const CAMPANHA_BOAS_VINDAS = 'ID_DA_CAMPANHA';

type NovoUsuario = { nome: string; email: string; telefone?: string; plano: string };
type RespostaDisparo = { campaignId: string; leadId: string; mode: 'immediate' | 'delay' };

export async function darBoasVindas(usuario: NovoUsuario): Promise<RespostaDisparo> {
  const res = await fetch('https://api.bip.marketing/api/campaigns/trigger', {
    method: 'POST',
    headers: { 'Content-Type': 'application/json', 'x-bip-api-key': API_KEY },
    body: JSON.stringify({
      campaignId: CAMPANHA_BOAS_VINDAS,
      lead: {
        name: usuario.nome, // 2 caracteres ou mais
        email: usuario.email,
        ...(usuario.telefone ? { phone: usuario.telefone } : {}), // com + e código do país
        tags: ['trial'],
        fields: [{ key: 'Plano', value: usuario.plano }]
      }
    })
  });
  if (!res.ok) throw new Error(`BIP ${res.status}: ${await res.text()}`);
  return res.json();
}

// Logo depois de criar a conta: o cadastro termina mesmo se a BIP não responder
export async function aoCriarConta(usuario: NovoUsuario) {
  try {
    const { leadId } = await darBoasVindas(usuario);
    // guarde o leadId junto do usuário para registrar eventos depois
    return leadId;
  } catch (erro) {
    console.error('Boas-vindas não disparadas', erro);
    return null;
  }
}
</Copy>

## Como medir

Em **Campanhas**, abra **Estatísticas da Campanha** (pelo ícone de gráfico na lista ou no topo da campanha).

- **Processado (_N_ execuções)**: quantas boas-vindas a BIP processou. Compare com o número de cadastros do seu app no mesmo período.
- **Entregue**, **Taxa de Abertura** e **Taxa de Cliques**: quantos e-mails chegaram, foram abertos e levaram a um clique.
- **Links mais clicados**: quantas pessoas abriram o app pelo botão.
- **Interações do Destinatário**: filtre por **Rejeitado** para ver as chamadas repetidas, com o motivo **O lead já recebeu esta campanha**. Filtre por **Erro** para ver os e-mails que não puderam ser enviados.

Para contar quantos contatos chegaram pela integração, crie um segmento com **Primeira / Última Origem** → **Primeira Origem (Tipo)** → API. Junte **Data de Criação** para ver só os cadastros de um período.

## Variações

### WhatsApp no lugar do e-mail

Nos planos pagos, com um número conectado, crie a campanha com o **Canal** **WhatsApp** e mande o `phone` no `lead`, com `+` e código do país. A resposta da pessoa chega no app WhatsApp Business.

<WaTemplate name="nimbus_boas_vindas" category="MARKETING" footer="Nimbus App · nimbusapp.com.br" buttons="Abrir o Nimbus App">
Oi, {{1}}! Sua conta no Nimbus App está pronta. Comece criando o seu primeiro projeto e convide quem trabalha com você. Ficou com dúvida? É só responder esta mensagem.
</WaTemplate>

Botão **URL** fixo: `https://nimbusapp.com.br/entrar`. Amostra de `{{1}}`: Tiago.

| Variável na campanha | Campo do contato | Valor de exemplo |
| -------------------- | ---------------- | ---------------- |
| **Corpo · {{1}}**    | **first name**   | Tiago            |

### Avise o time no mesmo envio

Campanhas de e-mail aceitam até 3 webhooks. Crie o webhook no menu **Webhooks** e ligue-o na seção **Webhooks** da campanha: os dados do novo cadastro vão para o seu CRM ou para o canal do time no mesmo envio das boas-vindas. O webhook enviado junto com o e-mail não conta como envio extra. Veja [Webhooks](/pt-br/webhooks).

### Sem integração: boas-vindas diárias

Sem acesso ao servidor do app, use uma campanha **Recorrente** com **Frequência** **Diário** e a reentrada desligada, ligada a um segmento como este:

| Critério        | Operador          | Valor                                  |
| --------------- | ----------------- | -------------------------------------- |
| Data de Criação | Depois ou igual a | Relativo: `-1` Dias, **Início do dia** |

Cada contato novo recebe as boas-vindas uma vez, na primeira execução depois da chegada. Mantenha a janela curta: no BIP Lite, cada execução de uma campanha **Recorrente** desconta da capacidade a contagem inteira do segmento, inclusive de quem já recebeu. Veja [Campanhas](/pt-br/campanhas) e [Planos e limites](/pt-br/planos-e-limites).

<PlanOnly plan="full">
No BIP Full, um fluxo com o gatilho **Contato Criado** continua a conversa depois das boas-vindas: um nó **Temporizador** espera alguns dias e um nó **Enviar Email** manda a próxima dica.
</PlanOnly>

## Perguntas frequentes

### O contato fica duplicado se a pessoa já estava na BIP?

Não. A BIP reconhece a pessoa pelo e-mail ou pelo telefone e atualiza o mesmo perfil: o nome passa a ser o do cadastro, as tags novas são somadas e os campos enviados são atualizados.

### Se o meu sistema chamar duas vezes, a pessoa recebe dois e-mails?

Não, com a **Janela de Reentrada do Lead** desligada. A segunda chamada aparece como **Rejeitado** nas estatísticas, com o motivo **O lead já recebeu esta campanha**, e não conta como envio.

### Preciso de domínio próprio?

Não. No plano gratuito, as boas-vindas saem de `no-reply@bip.marketing`, com o nome que você define em **Email De (Nome)**. Nos planos pagos, o [domínio de envio próprio](/pt-br/dominio-de-envio) põe o endereço da sua marca no remetente e faz as respostas chegarem até você.

### Posso chamar a API direto do app ou do navegador?

Não. A chave ficaria visível para qualquer pessoa. Chame a API do seu servidor, logo depois de criar a conta.

## Veja também

- [Recupere carrinhos abandonados por e-mail ou WhatsApp](/pt-br/carrinho-abandonado)
- [API da BIP: chaves, contatos, eventos e disparos](/pt-br/api)
- [Campanhas: única, recorrente e por API](/pt-br/campanhas)
- [Editor de e-mail: blocos, variáveis e preview](/pt-br/editor-de-email)
- [Domínio de envio próprio](/pt-br/dominio-de-envio)
- [Webhooks: leve cada envio para o seu sistema](/pt-br/webhooks)
- [Boas-vindas no site da BIP](https://bip.marketing/pt-br/use-cases/welcome)
- [BIP para SaaS](https://bip.marketing/pt-br/solutions/saas)