> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Templates e casos de uso

> WAITLIST, NEWSLETTER, CONTACT, SURVEY e BLANK, quando usar cada um e como se comportam.

<Tip>
  O **template** só define o **padrão** (fila, opt-in, campos). Tudo vive em **`/v1/forms`**, não há API separada de waitlist ou newsletter.
</Tip>

## Templates em resumo

| Template       | Uso típico           | Fila (`queue`) | Double opt-in default | Contato |
| -------------- | -------------------- | -------------- | --------------------- | ------- |
| **WAITLIST**   | Pré-lançamento, beta | Sim            | Não                   | Sim     |
| **NEWSLETTER** | Base de e-mail       | Não            | Ignorado no subscribe | Sim     |
| **CONTACT**    | Fale conosco         | Não            | Não                   | Sim     |
| **SURVEY**     | Pesquisa / NPS       | Não            | Não                   | Não     |
| **BLANK**      | Layout livre         | Não            | Não                   | Não     |

Ajuste `features` na API ou no painel (`queue`, `doubleOptIn`, `captureContact`).

***

## Caso 1, Waitlist (fila de espera)

**Cenário:** Produto ainda não lançou; você quer ordem de chegada.

1. Crie com `template: "WAITLIST"` e `features.queue: true`
2. Compartilhe `/w/forms/{id}` ou inscreva via API
3. Cada inscrição confirmada recebe **`queuePosition`** (posição na fila)
4. Webhook `form.submitted` alimenta CRM ou automação de boas-vindas

***

## Caso 2, Newsletter

**Cenário:** Captar e-mails para novidades recorrentes.

1. Crie com `template: "NEWSLETTER"`
2. Subscribe faz **upsert** por e-mail/telefone; `preferences` substitui preferências anteriores
3. Resposta inclui **`unsubscribeToken`**, trate como segredo
4. Cancelamento: API `.../cancel` ou `/w/forms/unsubscribe?token=`
5. Webhook **`form.unsubscribed`** para limpar listas externas

<Note>
  Newsletter **ignora** double opt-in, inscrições ficam ativas na hora. Para confirmação por e-mail, use **CONTACT** ou **BLANK** com `doubleOptIn: true`.
</Note>

***

## Caso 3, Formulário de contato

**Cenário:** Site com “Fale conosco”.

1. `template: "CONTACT"`, campos nome, e-mail, mensagem por padrão
2. `captureContact: true` cria ou vincula **contato** no workspace
3. Webhook `form.submitted` abre ticket ou notifica equipe

***

## Caso 4, Pesquisa (SURVEY)

**Cenário:** NPS pós-compra ou feedback de evento.

1. `template: "SURVEY"`, vários campos em `answers`
2. Sem captura automática de contato (padrão); ative `captureContact` se quiser

***

## Página hospedada e embed

| Recurso           | URL                            |
| ----------------- | ------------------------------ |
| Página pública    | `/w/forms/{id}`                |
| Embed             | `/w/embed/forms/{id}`          |
| Subscribe público | `POST /w/forms/{id}/subscribe` |
| Confirmar opt-in  | `/w/forms/confirm?token=`      |

HTML gerado a partir de `hostedPageTheme`, `hostedPageCopy` e `hostedPageForm` no painel.

***

## Status do formulário

| Status                        | Comportamento                                                                     |
| ----------------------------- | --------------------------------------------------------------------------------- |
| `ACTIVE`                      | Aceita inscrições                                                                 |
| `PAUSED` / `CLOSED` / `ENDED` | Bloqueia página pública; API retorna `SKIPPED` (ou **400** se newsletter inativa) |

***

## Próximos passos

* [Quick Start](/marketing-addons-api/como-funciona/quick-start)
* [Eventos de webhooks](/marketing-addons-api/como-funciona/eventos-do-webhooks)
* [Introdução](/marketing-addons-api/como-funciona/introducao)