identity
PUT /v1/me/overview-shortcuts
Replace this person's Overview shortcut cards.
Authentication
Send an API key as a bearer token. This endpoint does not state a specific permission in the specification, so give your key the least it needs and check the response rather than assuming.
This endpoint takes no organisation id. Your key already identifies the organisation it belongs to, and the response is scoped to it.
Try it
Replace anything in angle brackets with your own values, and the key placeholder with a key from your dashboard.
curl -X PUT https://api.zinndigital.com/v1/me/overview-shortcuts \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "shortcuts": <OverviewShortcutIds> }'Signed in? The API console in your dashboard fills in your real organisation id and your own key, and runs the request against the live API so you can see the actual response. Open this endpoint in the API console
Details
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.
Request body
| Name | Type | Required | What it is |
|---|---|---|---|
shortcuts | OverviewShortcutIds | Yes | 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… |
Response
| Name | Type | Required | What it is |
|---|---|---|---|
shortcuts | OverviewShortcutIds | Yes | 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 | Yes | 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… |
Errors this endpoint can return
401 · 403 · 422 · 429