Waitlist routes: update, delete

Reference for Waitlist, one group of Waitlist routes.

Waitlist.update

Changes the given properties of a Waitlist. Verb page.

Text

PATCH /{namespace}/waitlists/{id}

Path: id. Body, as JSON: the other inputs. Emits Waitlist.updated.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Waitlist.
`invited`	`integer`		How many Leads have been invited.
`rank`	`string`		The invite order: first come, best ICP fit, or most referrals first.

Returns

Output	Type	Required	Description
`waitlist`	Waitlist	required	The Waitlist.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	None.

Example

Terminal

curl -X PATCH https://api.sb/leaseline.app/waitlists/waitlist_rBixb72HGB \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"invited":1}'

JSON

{
  "api": "https://api.sb/leaseline.app",
  "waitlist": {
    "$id": "https://api.sb/leaseline.app/waitlists/waitlist_rBixb72HGB",
    "$type": "Waitlist",
    "invited": 1,
    "rank": "signup"
  },
  "action": {
    "$id": "https://api.sb/leaseline.app/actions/act_br07HsG8MG",
    "operation": "Waitlist.update",
    "status": "done"
  },
  "links": {
    "self": "https://api.sb/leaseline.app/actions/act_br07HsG8MG"
  }
}

Waitlist.delete

Deletes a Waitlist: a soft delete that keeps its history, undone by Thing.restore. Verb page.