Waitlist API reference

Waitlist API · Entries

post/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/invite-to-appAuth

Invite an entry into a linked Auth app

One-click handoff from Waitlist to Auth: creates an invite in the Auth consumer app (`app_slug`, else the workspace default) and, unless `send_email: false`, sends the approval email with the invite link. Stamps `invited_at` and `invited_to_app_slug` on the entry.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

entry_id*string · uuid

Id of the entry.

Headers

Idempotency-Keystring

Idempotency key (24 h). A retry with the same key and body returns the first response instead of acting twice.

Request body

app_slugstring

Auth app slug to invite into; defaults to the workspace Waitlist settings default (`default_heimdall_app_slug`)

Example: "acme-product"

send_emailboolean

Send the approval email with the Auth invite link baked in

Example: true

Response · 200 Invite created in Auth

entry*object

The entry row after `invited_at` / `invited_to_app_slug` were stamped.

invite_id*string

Auth invite id created in the linked app.

invite_urlstring

Invite acceptance URL, when the Auth app returned one. Baked into the approval email when send_email is enabled.

Example

Request

POST https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/entries/{entry_id}/invite-to-app
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "app_slug": "acme-product",
  "send_email": true
}

Response

{
  "entry": {},
  "invite_id": "string",
  "invite_url": "string"
}