identity
PUT /v1/me/overview-shortcuts
Replace this person's Overview shortcut cards.
אימות
שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.
נקודת קצה זו אינה דורשת מזהה ארגון. המפתח שלך כבר מזהה את הארגון שאליו הוא שייך, והתגובה מוגבלת אליו בלבד.
נסה זאת
החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.
curl -X PUT https://api.zinndigital.com/v1/me/overview-shortcuts \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "shortcuts": <OverviewShortcutIds> }'מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API
פרטים
Replaces the whole list. ⛔ PUT rather than PATCH, and the verb is load-bearing: the ORDER is the preference, so a merge semantic could not express "move the third card above the first". Idempotent by construction, so it takes no Idempotency-Key. An empty list is accepted and is a real choice — it clears the strip and stops the presets coming back. Duplicate ids are REFUSED rather than de-duplicated: two cards for one section is a client bug, and repairing it quietly would leave the customer with one fewer card than they dragged in and nothing to read about why.
גוף הבקשה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
shortcuts | OverviewShortcutIds | כן | Dashboard navigation ids, in the order the cards appear. Opaque to the engine: it bounds the count, the length and the charset and stores the rest verbatim, because the section… |
תשובה
| שם | סוג | נדרש | מה זה |
|---|---|---|---|
shortcuts | OverviewShortcutIds | כן | Dashboard navigation ids, in the order the cards appear. Opaque to the engine: it bounds the count, the length and the charset and stores the rest verbatim, because the section… |
chosen | boolean | כן | Whether this person has ever chosen. ⛔ Not inferable from an empty list, which is why it is on the wire: false with an empty list means nobody has chosen and the client shows… |
שגיאות שנקודה קצה זו עשויה להחזיר
401 · 403 · 422 · 429