Users

users_waitlist_invite

Tool

users_waitlist_invite

Promote waitlisted users by sending them the STANDARD invite email — the same one-time invite link `users_users_invite` sends, so accepting it sets their first password, verifies their address and turns the entry into `registered`. Batched: pass up to 100 user ids. Entries that already registered, that belong to another product, or whose address is on the suppression list (they withdrew) are SKIPPED with a reason rather than mailed. Requires a verified sender in this product's mail toolkit (config `email.from`).

Behavior

HTTP: POST /users/waitlist/invite

Arguments

Name	Type	Required	Description
userIds	array	•	The waitlisted users to promote, up to 100 per call. Each gets the STANDARD invite email; accepting it is what creates their credential.

Response

Field	Type	Always
invited	integer	•
results	array	•
skipped	integer	•

Try it

Promote waitlisted users by sending them the STANDARD invite email — the same one-time invite link `users_users_invite` sends, so accepting it sets their first password, verifies their address and turns the entry into `registered`.

When to use

Example

Ask your agent something like this:

Promote waitlisted users by sending them the STANDARD invite email — the same one-time invite link `users_users_invite` sends, so accepting it sets their first password, verifies their address and turns the entry into `registered`.

The agent will invoke users_waitlist_invite with these arguments:

{
  "userIds": "<userIds>"
}