Skip to Content
مرجع APIقائمة الانتظار

قائمة الانتظار

أدر قائمة انتظار ما قبل الإطلاق في مشروعك. يتطلّب تفعيل ميزة قائمة الانتظار للمشروع.

GET/v1/waitlist/signups

ParameterTypeDescription
searchstringالتصفية حسب جزء من البريد الإلكتروني.
statusstringالتصفية حسب الحالة: waiting أو invited أو joined.
limitintegerحجم الصفحة. الافتراضي 25.
offsetintegerعدد العناصر المراد تخطّيها. الافتراضي 0.

POST/v1/waitlist/signups

ParameterTypeDescription
emailrequiredstringالبريد الإلكتروني للشخص المنضم.
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 عندما يكون المعرّف غير معروف.

تحديث تسجيلة

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. ويمكن للبريد الإلكتروني نفسه التسجيل مرة أخرى.

Last updated on