<aside> 💡 Our well-documented API is quick and easy to integrate. Highly flexible so you can add on your custom logic around the process. Just remember to showcase the response [see response object below] to the user once they sign up. That way, they receive their referral link to refer friends and see their spot on the waitlist.
If you need a route for users to check their status later, consider using [x] Querying User Information.
</aside>
POST <https://getwaitlist.com/api/v1/waitlists/submit>
email [string]: The email of the user who is signing up on your waitlist.
api_key [string]: Your API key
referral_link [string]: Please fetch the CURRENT website link. In javascript, I used document.URL; to fetch this. It's important to fetch the full link as this is how we fetch potential referral ids.
{
"api_key": "key_123",
"email": "[email protected]",
"referral_link": "www.mywebsite.com?&ref_id=1234"
}
current_priority [integer]: Current priority of user on the Waitlist (if you're using it for the purpose of a waitlist)
referral_link [string]: The referral link of the user who signed up
registered_email [string]: Email of the user that signed up. We return this so it's easier for you to show.
total_users [integer]: Total users on the waitlist. It gives the users an idea of how far ahead or behind on the waitlist they are.
total_referrals [integer]: Total number of successful referrals for this specific user (it will be 0 at first, but if the user signs up again by accident, we show their number of referral)
user_id [string]: A hash-value for the user on your waitlist. If you wish to create a traceable, yet unique, link for users, feel free to use this.
{
"current_priority": 1,
"referral_link": "<https://yaywaitlist.com?&ref_id=CQGBZ6M5Y>",
"registered_email": "[email protected]",
"total_referrals": 0,
"total_users": 10321,
"user_id": "577a68e3fbf501fda5e7959518c3bc3d"
}
400: Validation error or missing parameter. Please check that the email or api_key is wrong