候补名单

管理项目的发布前候补名单。需要为该项目启用候补名单功能。

GET/v1/waitlist/signups

Parameter	Type	Description
`search`	`string`	按邮箱子串筛选。
`status`	`string`	按状态筛选:waiting、invited 或 joined。
`limit`	`integer`	每页数量。默认 25。
`offset`	`integer`	跳过的条数。默认 0。

POST/v1/waitlist/signups

Parameter	Type	Description
`email`required	`string`	加入者的邮箱。
`referral_code`	`string`	来自其他记录分享链接(`?ref=`)的推荐码。

GET/v1/waitlist/signups/:id

PATCH/v1/waitlist/signups/:id

Parameter	Type	Description
`status`required	`string`	新状态:waiting、invited 或 joined。invited 会记录 invited_at;joined 会记录 joined_at。

DELETE/v1/waitlist/signups/:id

创建注册需要付费套餐的写入权限。API 不发送邮件 —— 使用返回的 token 构建门户排名链接(/waitlist/status?token=...),用 referral_code 构建分享链接。

列出注册


curl "https://api.supdesk.app/v1/waitlist/signups?status=waiting&limit=10" \
  -H "Authorization: Bearer sd_live_..."


{
  "data": [
    {
      "id": "8f7a...",
      "email": "jamie@example.com",
      "status": "waiting",
      "position": 42,
      "referral_count": 3,
      "referral_code": "a1b2c3",
      "token": "9d8c7b...",
      "source": "api",
      "created_at": "2026-07-01T09:12:00Z",
      "invited_at": null,
      "joined_at": null
    }
  ],
  "pagination": { "limit": 25, "offset": 0, "has_more": false }
}

排名对等待中的记录实时计算;invited 和 joined 记录的 position 为 null。

创建注册


curl -X POST https://api.supdesk.app/v1/waitlist/signups \
  -H "Authorization: Bearer sd_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "email": "jamie@example.com" }'


{
  "data": {
    "id": "8f7a...",
    "email": "jamie@example.com",
    "status": "waiting",
    "position": 42,
    "referral_count": 0,
    "referral_code": "a1b2c3",
    "token": "9d8c7b...",
    "source": "api",
    "created_at": "2026-07-01T09:12:00Z",
    "invited_at": null,
    "joined_at": null
  }
}

获取单条注册


curl "https://api.supdesk.app/v1/waitlist/signups/8f7a..." \
  -H "Authorization: Bearer sd_live_..."


{
  "data": {
    "id": "8f7a...",
    "email": "jamie@example.com",
    "status": "waiting",
    "position": 42,
    "referral_count": 3,
    "referral_code": "a1b2c3",
    "token": "9d8c7b...",
    "source": "api",
    "created_at": "2026-07-01T09:12:00Z",
    "invited_at": null,
    "joined_at": null
  }
}

返回单条注册;若 id 不存在则返回 404。

更新注册


curl -X PATCH https://api.supdesk.app/v1/waitlist/signups/8f7a... \
  -H "Authorization: Bearer sd_live_..." \
  -H "Content-Type: application/json" \
  -d '{ "status": "invited" }'


{
  "data": {
    "id": "8f7a...",
    "email": "jamie@example.com",
    "status": "invited",
    "position": null,
    "referral_count": 3,
    "referral_code": "a1b2c3",
    "token": "9d8c7b...",
    "source": "api",
    "created_at": "2026-07-01T09:12:00Z",
    "invited_at": "2026-07-02T10:00:00Z",
    "joined_at": null
  }
}

只能修改 status。切换为 invited 会记录 invited_at;切换为 joined 会记录 joined_at。需要付费套餐的写入权限。

删除注册


curl -X DELETE https://api.supdesk.app/v1/waitlist/signups/8f7a... \
  -H "Authorization: Bearer sd_live_..."

永久删除该注册并返回 204。同一邮箱可以重新注册。