Inbox

POST `/v1/inbox/threads/{threadKey}`

Mark a conversation read, or archive it.

אימות

שלח מפתח API כטוקן Bearer. נקודת קצה זו אינה מציינת הרשאת ספציפית במפרט, לכן הקצה למפתח שלך את המינימום הנדרש ובדוק את התגובה במקום להניח הנחות.

המקום שבו מזהה הארגון שלך נכנס

נקודת קצה זו מקבלת את org_id כפרמטר שאילתת חיפוש. השאר אותו ריק והקריאה תכסה את כל תת-עץ הדיירות שלך; שלח אותו כדי לצמצם את הקריאה לארגון אחד.

מזהה הארגון שלך נמצא במסוף מפתחות ה-API בלוח הבקרה שלך, לצד המפתח עצמו. זהו אותו מזהה בכל קריאה שאתה מבצע.

נסה זאת

החלף כל דבר בסוגריים זוויתיים בערכים משלך, ואת מציין מיקום המפתח במפתח מלוח הבקרה שלך.

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>> }'

מחובר? קונסולת ה-API בלוח הבקרה שלך מזינה את מזהה הארגון האמיתי שלך ואת המפתח שלך, ומריצה את הבקשה מול ה-API הפיזי כך שתוכל לראות את התגובה בפועל. פתח נקודת קצה זו במסוף ה-API

פרטים

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.

פרמטרים

שם	סוג	נדרש	מה זה
`threadKey (path)`	`string`	כן	—
`org_id (query)`	`Uuid`	לא	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…

גוף הבקשה

שם	סוג	נדרש	מה זה
`action`	`string<read, archive>`	כן	—

תשובה

שם	סוג	נדרש	מה זה
`marked_read`	`integer`	לא	—
`archived`	`integer`	לא	—
`unread`	`integer`	לא	—
`capped`	`boolean`	לא	—

שגיאות שנקודה קצה זו עשויה להחזיר

401 · 403 · 422