Join Waitlist
POST /v1/waitlist/:slug/join endpoint. Add a subscriber email to your waitlist with name, source tracking, and custom metadata. Request params, response format, and HTTP status codes.
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/v1/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
All endpoints return a uniform JSON envelope.
{
"status": "success",
"message": "Thank you for joining the waitlist!",
"data": {
"email": "user@example.com"
},
"timestamp": 1686500000000
}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 |
REST API
WaitKit REST API reference. Base URL, Bearer token authentication, rate limiting, and available endpoints for collecting waitlist signups and querying subscriber counts.
Get Count
GET /v1/waitlist/:slug/count endpoint. Retrieve the total subscriber count for your waitlist project. Authenticated via Bearer token, returns JSON with the current signup total.