Quick Start

Create needs forms:manage. Subscribe needs forms:submit. Waitlist and newsletter are just the template on create, same endpoints.

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.

1. Create form

1A, Dashboard

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

1B, API

Scope: forms:manage.

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

Waitlist example:

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

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

{ "status": "PAUSED" }

Values: ACTIVE, PAUSED, CLOSED, ENDED.

3. List forms and subscriptions

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

Scope: forms:manage.

Scope: forms:submit.

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

{
  "listId": "cmuxxxform",
  "email": "person@example.com",
  "name": "Maria",
  "answers": { "company": "Acme" }
}

5. Confirm double opt-in

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

{ "confirmationToken": "token_from_subscribe" }

Fires form.confirmed webhook.

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

{ "source": "api" }

Fires form.unsubscribed.

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

Body: form fields + empty website honeypot.

Add-ons

Forms

Short links

Links curtos (Short Links)

Conversions (Smart Links)

In short

1. Create form

1A, Dashboard

1B, API

2. Pause or end

3. List forms and subscriptions

5. Confirm double opt-in

Next steps

​In short

​1. Create form

​1A, Dashboard

​1B, API

​2. Pause or end

​3. List forms and subscriptions

​4. Subscribe someone

​5. Confirm double opt-in

​6. Cancel subscription (newsletter)

​Public subscribe (no API Key)

​Next steps

In short

1. Create form

1A, Dashboard

1B, API

2. Pause or end

3. List forms and subscriptions

4. Subscribe someone

5. Confirm double opt-in

6. Cancel subscription (newsletter)

Public subscribe (no API Key)

Next steps