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