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

> Create a form, subscribe someone, and (optionally) confirm double opt-in.

<Tip>
  **Create** needs `forms:manage`. **Subscribe** needs `forms:submit`. Waitlist and newsletter are just the `template` on create, same endpoints.
</Tip>

## In short

* `POST /v1/forms/lists` creates the form
* `POST /v1/forms/subscriptions` registers a submission
* Public page: `POST /w/forms/{id}/subscribe` (no API Key)

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

***

## 1. Create form

#### 1A, Dashboard

**Add-ons → Forms** → pick template (Waitlist, Newsletter, etc.) → customize and publish.

#### 1B, API

Scope: **`forms:manage`**.

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

Waitlist example:

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

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

Public URL: `https://api.notifique.dev/w/forms/{id}`

***

## 2. Pause or end

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

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

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

***

## 3. List forms and subscriptions

```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
```

Scope: **`forms:manage`**.

***

## 4. Subscribe someone

Scope: **`forms:submit`**.

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

```json theme={null}
{
  "listId": "cmuxxxform",
  "email": "person@example.com",
  "name": "Maria",
  "answers": { "company": "Acme" }
}
```

***

## 5. Confirm double opt-in

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

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

Fires **`form.confirmed`** webhook.

***

## 6. Cancel subscription (newsletter)

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

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

Fires **`form.unsubscribed`**.

***

## Public subscribe (no API Key)

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

Body: form fields + empty `website` honeypot.

***

## Next steps

* [Templates and use cases](/en/marketing-addons-api/como-funciona/templates-e-casos-de-uso)
* [Webhook events](/en/marketing-addons-api/como-funciona/eventos-do-webhooks)
* [Introduction](/en/marketing-addons-api/como-funciona/introducao)