Hitelesítés
Küldjön egy API-kulcsot bearer tokenként. Ez a végpont nem határoz meg konkrét jogosultságot a specifikációban, ezért adja meg a kulcsnak a legkevesebbet, amire szüksége van, és a feltételezés helyett ellenőrizze a választ.
A szervezet azonosítójának helye
Ez a végpont a(z) org_id paramétert lekérdezési paraméterként várja. Hagyja ki, ha a hívás az Ön teljes bérlői részfáját lefedje; küldje el a hívás egyetlen szervezetre történő szűkítéséhez.
A szervezeted azonosítója a vezérlőpult API-kulcsok képernyőjén található, közvetlenül a kulcs mellett. Ez ugyanaz az azonosító minden indított hívásban.
Próbálja ki
Cserélje ki a hegyes zárójelek közötti részt a saját értékeivel, a kulcshelyőrzőt pedig a vezérlőpultján található kulccsal.
curl -X POST https://api.zinndigital.com/v1/inbox/threads/{threadKey} \
-H "Authorization: Bearer zdk_live_…" \
-H "Content-Type: application/json" \
-d '{ "action": <string<read, archive>> }'Be van jelentkezve? A vezérlőpultban lévő API-konzol kitölti a valós szervezetazonosítóját és a saját kulcsát, és a kérést az éles API-n futtatja, hogy láthassa a tényleges választ. Nyissa meg ezt a végpontot az API konzolban
Részletek
A POST and not a GET, because a read receipt is a write — a GET that mutates is one a prefetcher, a crawler or the back button fires on the customer's behalf.
Paraméterek
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
threadKey (path) | string | Igen | — |
org_id (query) | Uuid | Nem | The organization this call acts on. Optional for a caller with exactly one direct membership; **required** for anyone with more than one — which is every reseller and every agen… |
Kérés törzse
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
action | string<read, archive> | Igen | — |
Válasz
| Név | Típus | Kötelező | Mi ez |
|---|---|---|---|
marked_read | integer | Nem | — |
archived | integer | Nem | — |
unread | integer | Nem | — |
capped | boolean | Nem | — |
Hibák, amelyeket ez a végpont visszaadhattatlan
401 · 403 · 422