Waitlists tools

An operation tool runs one API operation and takes its variables, so the operation's page says what each accepts. Two differences: the server fills in workspaceId and updatedBy, and campaignId, partnerId, formId, discountCodeId, socialNetworkId, waitlistId, incentiveId, channelId also take the record's name. A task tool chains several operations and is described here in full. Every tool's input schema, keyed by tool name: waitlists.schema.json.

Operation tools

Tool	Operation	Access	Toolset	Hints	What it does
add_discount_pool_codes	AddDiscountPoolCodes	Write	waitlists		Add codes to an incentive rule's discount-code pool.
archive_waitlist	ArchiveWaitlist	Write	waitlists	destructive	Archive a waitlist so it stops collecting signups. SetWaitlistStatus restores it.
get_consent_wordings	ConsentWordings	Read	waitlists	read-only, idempotent	List saved consent wordings used by waitlist signup forms.
create_consent_wording	CreateConsentWording	Write	waitlists		Save a consent wording for waitlist signup forms.
create_waitlist	CreateWaitlist	Write	waitlists		Create a waitlist and, when needed, its signup form.
erase_waitlist_signups	EraseWaitlistSignups	Write	waitlists	destructive	Permanently erase signups and their personal data (a data-subject request). Irreversible.
release_waitlist	ReleaseWaitlist	Write	waitlists		Release a waitlist: issue every signup's incentive as a background job.
resume_waitlist_release	ResumeWaitlistRelease	Write	waitlists		Resume a stalled waitlist release.
retry_waitlist_grants	RetryWaitlistGrants	Write	waitlists		Retry a waitlist's failed grants.
set_waitlist_status	SetWaitlistStatus	Write	waitlists	idempotent	Change a waitlist's status: pause or resume, back to draft (no signups yet), archive, or restore an archived one. Releasing is ReleaseWaitlist.
start_waitlist	StartWaitlist	Write	waitlists		Start collecting signups on a waitlist.
update_waitlist	UpdateWaitlist	Write	waitlists		Update a waitlist's settings.
backfill_waitlist_destination	WaitlistDestinationBackfill	Write	waitlists		Queue a backfill of existing signups to a destination.
get_waitlist_destination_backfill_count	WaitlistDestinationBackfillCount	Read	waitlists	read-only, idempotent	How many signups a destination backfill would push.
create_waitlist_destination	WaitlistDestinationCreate	Write	waitlists		Add a sync destination (an email list) to a waitlist.
get_waitlist_destination_lists	WaitlistDestinationLists	Read	waitlists	read-only, idempotent	List the audience lists on an email connection that a waitlist can sync to.
get_waitlist_destination_members	WaitlistDestinationMembers	Read	waitlists	read-only, idempotent	Page through a destination's members by sync state.
remove_waitlist_destination	WaitlistDestinationRemove	Write	waitlists	destructive	Remove a waitlist sync destination.
retry_waitlist_destination	WaitlistDestinationRetry	Write	waitlists		Retry the failed pushes to a destination.
apply_waitlist_destination_review	WaitlistDestinationReviewApply	Write	waitlists		Apply a reviewed set of pending destination changes.
open_waitlist_destination_review	WaitlistDestinationReviewOpen	Write	waitlists		Open a review of pending destination changes.
get_waitlist_destinations	WaitlistDestinations	Read	waitlists	read-only, idempotent	List one waitlist's sync destinations and their state.
update_waitlist_destination	WaitlistDestinationUpdate	Write	waitlists		Update a waitlist sync destination.
get_waitlist	WaitlistDetail	Read	waitlists	read-only, idempotent	Get one waitlist by slug with its settings and verified domains.
get_waitlist_discount_shopify	WaitlistDiscountShopify	Read	waitlists	read-only, idempotent	The Shopify placement of a waitlist's discount code.
get_waitlist_form_snapshot	WaitlistFormSnapshot	Read	waitlists	read-only, idempotent	Get the first published snapshot of a waitlist's signup form, by form id: what the signup page renders.
get_waitlist_pending_changes	WaitlistPendingChanges	Read	waitlists	read-only, idempotent	Changes pending review before they sync to a destination.
get_waitlist_release_progress	WaitlistReleaseProgress	Read	waitlists	read-only, idempotent	Progress of a waitlist release: grants by status.
get_waitlist_signup_evidence	WaitlistSignupEvidence	Read	waitlists	read-only, idempotent	Consent evidence and entries for one waitlist signup.
get_waitlist_signups	WaitlistSignups	Read	waitlists	read-only, idempotent	List one waitlist's signups with filter and sort.
list_waitlists	WaitlistsList	Read	waitlists	read-only, idempotent	List waitlists with status, incentive and signup counts by status.