Waitlist

PropertiesCopy Anchor Link

ObjectCopy Anchor Link

{
  "$id": "https://api.sb/patentpad.com/waitlists/waitlist_1",
  "$type": "Waitlist",
  "invited": 1,
  "rank": "signup"
}

RelationshipsCopy Anchor Link

• A Waitlist awaits one Offer: a Waitlist admits its Leads to one Offer once that Offer opens. awaits, inverse waitlist.
• A Waitlist holds many Leads: Leads wait on a Waitlist in the order its Setting ranks them. holds, inverse waitsOn.

VerbsCopy Anchor Link

1. createCreates a Waitlist.
   POST /{namespace}/waitlistsdoWaitlist.created
2. getReturns one Waitlist by id.
   GET /{namespace}/waitlists/{id}readNo Event
3. listReturns Waitlists, newest first, one page at a time.
   GET /{namespace}/waitlistsreadNo Event
4. updateChanges the given properties of a Waitlist.
   PATCH /{namespace}/waitlists/{id}doWaitlist.updated
5. deleteDeletes a Waitlist; its history is kept.
   DELETE /{namespace}/waitlists/{id}doWaitlist.deleted
6. admitAdmit releases Leads from a Waitlist to the Offer they waited for, in the order the Waitlist ranks them.
   POST /{namespace}/waitlists/{waitlist}/admitdoWaitlist.admitted
7. joinJoin adds a Lead to a Waitlist for an Offer that is not open to them.
   POST /{namespace}/waitlists/{waitlist}/joindoWaitlist.joined

PermissionsCopy Anchor Link

Which Access level may call each Verb. One-way Verbs wait their delay window.

Call itCopy Anchor Link

Join the latest waitlist.

ExampleCopy Anchor Link

The team Offer of a lesson-booking App has a Waitlist of 120 Leads. A Setting admits 15 a week, in signup order.