API
Join Waitlist
POST /api/waitlist/:slug/join — Add a subscriber to the waitlist.
Adds a new subscriber entry to the waitlist identified by the project slug.
Send this request from the client-side. Proxying it through your own server will record your deployment's IP and location instead of the actual subscriber's. See Integration Guide.
curl -X POST https://api.waitkit.dev/api/waitlist/my-project/join \
-H "Authorization: Bearer wk_..." \
-H "Content-Type: application/json" \
-d '{"email": "user@example.com"}'Request
| Param | Type | Required | Description |
|---|---|---|---|
email | string | yes | Subscriber email |
name | string | no | Subscriber name |
source | string | no | Signup source (default: landing-page) |
metadata | Record<string, unknown> | no | Arbitrary metadata |
Response
{
"id": "clx...",
"email": "user@example.com",
"name": null,
"source": "landing-page",
"metadata": null,
"createdAt": "2025-06-11T12:00:00.000Z"
}Status codes
| Code | Description |
|---|---|
201 | Subscriber created |
400 | Invalid request body (missing email, invalid format) |
401 | Missing or invalid API key |
404 | Project not found |
409 | Email already registered for this project |