Boltmesh Docs
OpenAPI

Create a waitlist project

Create a waitlist project.

POST
/v1/waitlists

Authorization

Authorization

AuthorizationBearer <token>

Your team's root key.

In: header

Request Body

application/jsonRequired
discordEnabled?boolean | null
discordMessageType? | null
discordChannelId?string | null
discordUserId?string | null
slackEnabled?boolean | null
slackWorkspaceId?string | null
slackMessageType? | null
slackChannelId?string | null
slackUserId?string | null
namestring

Name

Length1 <= length <= 35
descriptionstring

Description

Length2 <= length <= 300

Response Body

OK

TypeScript Definitions

Use the response body type in TypeScript.

okboolean

The response status.

messagestring

The reponse messgae.

projectobject
curl -X POST "https://api.boltmesh.com/v1/waitlists" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "This is a name.",
    "description": "This is a description."
  }'
const body = JSON.stringify({
  "name": "This is a name.",
  "description": "This is a description."
})

fetch("https://api.boltmesh.com/v1/waitlists", {
  body
})
package main

import (
  "fmt"
  "net/http"
  "io/ioutil"
  "strings"
)

func main() {
  url := "https://api.boltmesh.com/v1/waitlists"
  body := strings.NewReader(`{
    "name": "This is a name.",
    "description": "This is a description."
  }`)
  req, _ := http.NewRequest("POST", url, body)
  req.Header.Add("Content-Type", "application/json")
  res, _ := http.DefaultClient.Do(req)
  defer res.Body.Close()
  body, _ := ioutil.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))
}
import requests

url = "https://api.boltmesh.com/v1/waitlists"
body = {
  "name": "This is a name.",
  "description": "This is a description."
}
response = requests.request("POST", url, json = body, headers = {
  "Content-Type": "application/json"
})

print(response.text)
{
  "ok": true,
  "message": "string",
  "project": {
    "id": "string",
    "name": "string",
    "description": "string",
    "teamId": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "createdWay": "dashboard",
    "discordEnabled": true,
    "discordMessageType": "channel_message",
    "discordChannelId": "string",
    "discordUserId": "string",
    "slackEnabled": true,
    "slackWorkspaceId": "string",
    "slackMessageType": "channel_message",
    "slackChannelId": "string",
    "slackUserId": "string"
  }
}