Waitlist API reference

Waitlist API · Waitlist-Invites

post/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}/cancelAuth

Cancel a scheduled invite wave

Stops future runs and drops its saved API key. Invites already sent stay sent.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

wave_id*string · uuid

Id of the wave.

Response · 200 Canceled.

id*string · uuid

Wave id.

waitlist_id*string · uuid

The waitlist.

size*integer

People per run.

method*object

`auth` (Auth app invites) or `code` (access codes).

app_slug*string

Auth app (`auth`).

send_email*boolean

Whether invitees are emailed.

status*object

`scheduled` waits for `next_run_at` (a repeating wave goes back to it after each run); `running`; `done`; `failed` (nothing could be invited, see `last_error`); `canceled`.

next_run_at*string · date-time

When it runs next (scheduled waves); null otherwise.

repeat_every_hours*integer

Repeats every N hours; null runs once.

runs*integer

Runs so far.

invited_total*integer

Invited across all runs.

failed_total*integer

Failed across all runs.

last_run_at*string · date-time

When it last ran.

last_error*string

The last failure, if any.

has_api_key*boolean

Whether an API key is saved for scheduled `auth` runs (never returned).

created_by*string · uuid

Who created it (platform user or API key subject).

created_at*string · date-time

When it was created.

updated_at*string · date-time

When it last changed.

Example

Request

POST https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/invite-waves/{wave_id}/cancel
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "waitlist_id": "00000000-0000-0000-0000-000000000000",
  "size": 0,
  "method": {},
  "app_slug": "string",
  "send_email": false,
  "status": {},
  "next_run_at": "2026-01-01T00:00:00.000Z",
  "repeat_every_hours": 0,
  "runs": 0,
  "invited_total": 0,
  "failed_total": 0,
  "last_run_at": "2026-01-01T00:00:00.000Z",
  "last_error": "string",
  "has_api_key": false,
  "created_by": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z"
}