Waitlist methods: update, delete

Reference for Waitlist, one group of Waitlist methods.

Waitlist.update

Changes the given properties of a Waitlist. Verb page.

TypeScript

interface WaitlistVerbs {
  update(input: WaitlistUpdateInput, options?: SB.CallOptions): SB.Call<Waitlist>
}

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

TypeScript

import { $ } from 'startup-builder'

const waitlist = await $.Waitlist.update({ id: 'waitlist_rBixb72HGB', invited: 1 })

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

TypeScript

interface WaitlistVerbs {
  delete(input: WaitlistDeleteInput, options?: SB.CallOptions): SB.Call<Waitlist>
}

Emits Waitlist.deleted.

Inputs

Input	Type	Required	Description
`id`	`string`	required	The id of the Waitlist.

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

TypeScript

import { $ } from 'startup-builder'

const waitlist = await $.Waitlist.delete({ id: 'waitlist_rBixb72HGB' })