Skip to content

Waitlist

waitlist_invites_send

Send waitlist invites.

Tool

waitlist_invites_send

Send waitlist invites.

Send invite emails to waitlist signups. Provide an explicit email list and/or a filter over signups (by status or email prefix). Set force to resend when a live invite token already exists.

Arguments

Name Type Required Description
emails array Explicit recipient emails. Combined with filter if both are given.
filter object Selection filter over signups: { q (email prefix), status }.
force boolean Resend even when a live invite token already exists. default: false

Try it

Invite all pending waitlist signups.

When to use

Send invite emails to waitlist signups. Provide an explicit email list and/or a filter over signups (by status or email prefix). Set force to resend when a live invite token already exists.

Example

Ask your agent something like this:

Invite all pending waitlist signups.

The agent will invoke waitlist_invites_send with these arguments:

{
  "filter": {
    "status": "pending"
  }
}

Esc

Start typing to search the docs.

navigate select