Waitlist API reference

Waitlist API · Waitlist-Rewards

patch/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/milestone-awards/{award_id}Auth

Mark a reward handed out (or not)

Sets `fulfilled_at` when `fulfilled` is true, clears it when false. Nothing is sent.

Path parameters

workspace_id*string · uuid

Id of the workspace.

waitlist_id*string · uuid

Id of the waitlist.

award_id*string · uuid

Id of the award.

Request body

fulfilled*boolean

`true` marks the reward handed out (sets `fulfilled_at`), `false` clears it.

Example: true

Response · 200 Updated.

id*string · uuid

Award id.

waitlist_id*string · uuid

The waitlist.

entry_id*string · uuid

The entry that reached the milestone.

milestone_count*integer

Referrals the milestone needs.

Example: 3

reward*string

The reward, as configured when it was reached.

Example: "Skip the line"

awarded_at*string · date-time

When the entry reached it.

fulfilled_at*string · date-time

When you marked the reward as handed out; null until then.

email*string

The entry email (to deliver the reward).

Example: "ada@example.com"

name*string

The entry name.

Example: "Ada"

referral_count*integer

The entry referral count now.

Example: 3

Example

Request

PATCH https://api.waitlist.productcraft.co/v1/workspaces/{workspace_id}/waitlists/{waitlist_id}/milestone-awards/{award_id}
Authorization: Bearer YOUR_TOKEN
Content-Type: application/json

{
  "fulfilled": true
}

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "waitlist_id": "00000000-0000-0000-0000-000000000000",
  "entry_id": "00000000-0000-0000-0000-000000000000",
  "milestone_count": 3,
  "reward": "Skip the line",
  "awarded_at": "2026-01-01T00:00:00.000Z",
  "fulfilled_at": "2026-01-01T00:00:00.000Z",
  "email": "ada@example.com",
  "name": "Ada",
  "referral_count": 3
}