Api reference/Subscriber
Create
➕ Create a Subscriber
The Create Subscriber endpoint allows you to add new subscribers to a waitlist.
📌 Endpoint
🔑 Authentication
Include your API key in the request header:
🔤 Request Body
Field | Type | Required | Description |
---|---|---|---|
email | String | ✅ Yes | The subscriber's email address |
subscribedTo | String | ✅ Yes | The ID of the waitlist the subscriber is joining |
metaData | Object | ❌ No | Optional metadata (e.g., {"source": "landing_page"} ) |
firstName | String | ❌ No | Subscriber's first name |
lastName | String | ❌ No | Subscriber's last name |
⚠️ If firstName
and lastName
are not provided, they will default to "Not provided".
🔄 Status Logic
- If Require Approval is enabled → Status =
Pending
- If Require Approval is disabled and Use DOI is also disabled → Status =
Approved
- If Use DOI is enabled and Require Approval is disabled → Status =
Pending
until the user verifies their email, then it changes toApproved
.
✅ Successful Response
🔗 For more details on DOI tokens, visit /api-reference/doi.
❌ Possible Errors
Error Code | Message | Status |
---|---|---|
MAXIMUM_SUBSCRIBERS_REACHED | The maximum sign-ups for this waitlist have been reached | 400 |
USER_ALREADY_SUBSCRIBED | This user joined this waitlist already | 400 |
MISSING_SUBSCRIBER_ID | No Subscriber Id provided | 400 |
SUBSCRIBER_NOT_EXISTING | This subscriber does not exist | 404 |
WAITLIST_NOT_LIVE | This waitlist is currently not live. Please try again later | 400 |
For further API details, check out the API Reference.