Skip to Content
Документация APIСписок ожидания

Список ожидания

Управляйте предзапусковым списком ожидания проекта. Требуется, чтобы функция списка ожидания была включена для проекта.

GET/v1/waitlist/signups

ParameterTypeDescription
searchstringФильтр по подстроке email.
statusstringФильтр по статусу: waiting, invited или joined.
limitintegerРазмер страницы. По умолчанию 25.
offsetintegerСколько элементов пропустить. По умолчанию 0.

POST/v1/waitlist/signups

ParameterTypeDescription
emailrequiredstringEmail присоединяющегося.
referral_codestringРеферальный код из ссылки другой записи (`?ref=`).

GET/v1/waitlist/signups/:id

PATCH/v1/waitlist/signups/:id

ParameterTypeDescription
statusrequiredstringНовый статус: 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 имеют позицию 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 } }

Возвращает одну запись или 404, если id неизвестен.

Обновление записи

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. Тот же email может записаться снова.

Last updated on