identity
PUT /v1/me/overview-shortcuts
Replace this person's Overview shortcut cards.
Аутентификация
Передайте API-ключ в качестве маркера носителя (bearer token). Эта конечная точка не указывает конкретное разрешение в спецификации, поэтому предоставьте своему ключу минимум необходимых прав и проверьте ответ, вместо того чтобы делать предположения.
Этот эндпоинт не принимает идентификатор организации. Ваш ключ уже определяет организацию, к которой он принадлежит, и ответ ограничивается ее рамками.
Попробовать
Замените всё в угловых скобках на собственные значения, а плейсхолдер ключа — на ключ из вашей панели управления.
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