Inbox

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

Mark a conversation read, or archive it.

ప్రమాణీకరణ

ఒక API కీని బేరర్ టోకెన్‌గా పంపండి. ఈ ఎండ్‌పాయింట్ స్పెసిఫికేషన్‌లో నిర్దిష్ట అనుమతిని పేర్కొనలేదు, కాబట్టి ఊహించడం కంటే మీ కీకి అవసరమైన కనిష్ట అనుమతిని ఇవ్వండి మరియు ప్రతిస్పందనను తనిఖీ చేయండి.

మీ సంస్థ ఐడీ ఎక్కడ ఉందో అక్కడ

ఈ ఎండ్‌పాయింట్ క్వరీ పారామీటర్‌గా org_idని తీసుకుంటుంది. దీనిని వదిలేస్తే కాల్ మీ మొత్తం టెనెన్సీ సబ్‌ట్రీని కవర్ చేస్తుంది; ఒకే సంస్థకు కాల్‌ని పరిమితం చేయడానికి దీన్ని పంపండి.

మీ సంస్థ ఐడి (organisation 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 కాన్సోల్ మీ అసలైన సంస్థ ID మరియు మీ స్వంత కీని నింపుతుంది, అలాగే మీరు అసలైన ప్రతిస్పందనను చూడటానికి లైవ్ 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

POST /v1/inbox/threads/{threadKey}