Waitlist management

In this section, the endpoints guides you on how to create, edit, list and delete waitlists

Create Waitlist

The create waitlist endpoint takes the following payload.

The HTTP Verb for the endpoint is POST

Base Url: https://api.waitstream.com

Endpoint: `/api/v1/lists/create`

{
  "name": "string",
  "redirect_url": "string",
  "email_sign_ups": true,
  "verify_new_signups": true,
  "image_url": "string"
}

Sample python code

# Sample Python Request

import requests

url = "https://api.waitstream.com/api/v1/waitlist/sign-up"

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "X-API-KEY": "Your-API-Key"
}
paylod = {
  "name": "string",
  "redirect_url": "string",
  "email_sign_ups": true,
  "verify_new_signups": true,
  "image_url": "string"
}

response = requests.post(url, json=payload, headers=headers)

print(response.status_code)
print(response.json())

Get All Waitlists

You make a GET Request to this endpoint

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "X-API-KEY": "Your-API-Key"
}

https://api.waitstream.com/api/v1/lists/all?page=1&limit=10

Edit A Waitlist

Thie is where you edit your waitlist using a POST Request

URL: https://api.waitstream.com/api/v1/lists/edit/{waitlist_id}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "X-API-KEY": "Your-API-Key"
}

Payload: 
        {
          "name": "string",
          "redirect_url": "string",
          "email_sign_ups": true,
          "verify_new_signups": true,
          "image_url": "string"
        }

All fields are optional, you only send what you want to edit.

Delete A Waitlist

You delete a waitlist here using a POST request

URL: https://api.waitstream.com/api/v1/lists/delete/{waitlist_id}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "X-API-KEY": "Your-API-Key"
}

List all signups

This is where you GET all the signups on your waitlist...

URL: https://api.waitstream.com/api/v1/lists/signups/{waitlist_id}

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "X-API-KEY": "Your-API-Key"
}

Query Parameters:

`page`: Integer
`limit`: Integer
`offboarded`: bool
`start_date`: datetime (yyyy-mm-dd hh:mm:ss)
`end_date`: datetime (yyyy-mm-dd hh:mm:ss)
`search`: String