identity
PUT /v1/me/overview-shortcuts
Replace this person's Overview shortcut cards.
認証
ベアラー トークンとして API キーを送信します。このエンドポイントでは仕様に特定の権限が記載されていないため、キーに必要な最小限の権限を付与し、推測するのではなくレスポンスを確認してください。
このエンドポイントは組織IDを受け付けません。お使いのキーによって所属する組織がすでに特定されており、レスポンスはその組織にスコープされます。
試してみる
アングルブラケット内のすべてをご自身の値に置き換え、キーのプレースホルダーをご利用中のダッシュボードのキーに置き換えてください。
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コンソールでは、実際の組織IDやお客様ご自身のキーが自動入力され、ライブ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