> ## 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.

# Quick Start

> Crie um formulário, inscreva alguém e (opcional) confirme double opt-in.

<Tip>
  **Criar** exige `forms:manage`. **Inscrever** exige `forms:submit`. Waitlist e newsletter são só o `template` na criação, mesmos endpoints.
</Tip>

## Em poucas palavras

* `POST /v1/forms/lists` cria o formulário
* `POST /v1/forms/subscriptions` registra a inscrição
* Página pública: `POST /w/forms/{id}/subscribe` (sem API Key)

Escopos: [Escopos da API Key](/marketing-addons-api/como-funciona/escopos-da-api-key).

***

## 1. Criar formulário

#### 1A, Pelo painel

**Add-ons → Forms** → escolha o template (Waitlist, Newsletter, etc.) → personalize campos e publique.

#### 1B, Pela API

Escopo: **`forms:manage`**.

```http theme={null}
POST /v1/forms/lists
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

Exemplo, fila de espera:

```json theme={null}
{
  "name": "Early access 2026",
  "template": "WAITLIST",
  "features": {
    "queue": true,
    "doubleOptIn": false,
    "captureContact": true
  }
}
```

Templates: `BLANK`, `CONTACT`, `SURVEY`, `WAITLIST`, `NEWSLETTER`.

URL pública: `https://api.notifique.dev/w/forms/{id}`

***

## 2. Pausar ou encerrar

```http theme={null}
PATCH /v1/forms/lists/{id}
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{ "status": "PAUSED" }
```

Valores: `ACTIVE`, `PAUSED`, `CLOSED`, `ENDED`.

***

## 3. Listar formulários e inscrições

```http theme={null}
GET /v1/forms/lists
Authorization: Bearer sk_live_xxxxx
```

```http theme={null}
GET /v1/forms/lists/{id}/subscriptions?status=CONFIRMED&page=1&limit=25
Authorization: Bearer sk_live_xxxxx
```

Escopo: **`forms:manage`**.

***

## 4. Inscrever alguém

Escopo: **`forms:submit`**.

```http theme={null}
POST /v1/forms/subscriptions
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{
  "listId": "cmuxxxform",
  "email": "pessoa@exemplo.com",
  "name": "Maria",
  "answers": { "empresa": "Acme" }
}
```

* Formulário inativo (não-newsletter) → **200** com `status: "SKIPPED"`
* Newsletter inativa → **400**
* Com double opt-in → resposta inclui **`confirmationToken`**

***

## 5. Confirmar double opt-in

```http theme={null}
POST /v1/forms/subscriptions/confirm
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{ "confirmationToken": "token_da_resposta" }
```

Dispara webhook **`form.confirmed`**.

***

## 6. Cancelar inscrição (newsletter)

```http theme={null}
POST /v1/forms/subscriptions/{subscriptionId}/cancel
Authorization: Bearer sk_live_xxxxx
```

```json theme={null}
{ "source": "api" }
```

Dispara **`form.unsubscribed`**.

***

## Inscrição pública (sem API Key)

```http theme={null}
POST /w/forms/{id}/subscribe
Content-Type: application/json
```

Corpo: campos do formulário + `website` vazio (honeypot anti-spam).

***

## Próximos passos

* [Templates e casos de uso](/marketing-addons-api/como-funciona/templates-e-casos-de-uso)
* [Eventos de webhooks](/marketing-addons-api/como-funciona/eventos-do-webhooks)
* [Introdução](/marketing-addons-api/como-funciona/introducao)