Quick Start

Criar exige forms:manage. Inscrever exige forms:submit. Waitlist e newsletter são só o template na criação, mesmos endpoints.

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.

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.

POST /v1/forms/lists
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

Exemplo, fila de espera:

{
  "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

PATCH /v1/forms/lists/{id}
Authorization: Bearer sk_live_xxxxx

{ "status": "PAUSED" }

Valores: ACTIVE, PAUSED, CLOSED, ENDED.

3. Listar formulários e inscrições

GET /v1/forms/lists
Authorization: Bearer sk_live_xxxxx

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.

POST /v1/forms/subscriptions
Content-Type: application/json
Authorization: Bearer sk_live_xxxxx

{
  "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

POST /v1/forms/subscriptions/confirm
Authorization: Bearer sk_live_xxxxx

{ "confirmationToken": "token_da_resposta" }

Dispara webhook form.confirmed.

POST /v1/forms/subscriptions/{subscriptionId}/cancel
Authorization: Bearer sk_live_xxxxx

{ "source": "api" }

Dispara form.unsubscribed.

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

POST /w/forms/{id}/subscribe
Content-Type: application/json

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

Add-ons

Forms

Links curtos

Links curtos (Short Links)

Conversões (Smart Links)

Em poucas palavras

1. Criar formulário

1A, Pelo painel

1B, Pela API

2. Pausar ou encerrar

3. Listar formulários e inscrições

4. Inscrever alguém

5. Confirmar double opt-in

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

Próximos passos

​Em poucas palavras

​1. Criar formulário

​1A, Pelo painel

​1B, Pela API

​2. Pausar ou encerrar

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

​4. Inscrever alguém

​5. Confirmar double opt-in

​6. Cancelar inscrição (newsletter)

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

​Próximos passos

Em poucas palavras

1. Criar formulário

1A, Pelo painel

1B, Pela API

2. Pausar ou encerrar

3. Listar formulários e inscrições

4. Inscrever alguém

5. Confirmar double opt-in

6. Cancelar inscrição (newsletter)

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

Próximos passos