Inbox
POST /v1/inbox/threads/{threadKey}
Mark a conversation read, or archive it.
പ്രമാണീകരണം
ബെയറർ ടോക്കണായി ഒരു API കീ അയക്കുക. ഈ എൻഡ്പോയിന്റ് അതിന്റെ സ്പെസിഫിക്കേഷനിൽ ഒരു പ്രത്യേക അനുമതി വ്യക്തമാക്കിയിട്ടില്ല, അതിനാൽ അനുമാനിക്കുന്നതിന് പകരം നിങ്ങളുടെ കീയ്ക്ക് ഏറ്റവും കുറഞ്ഞത് ആവശ്യമുള്ളത് നൽകുകയും പ്രതികരണം പരിശോധിക്കുകയും ചെയ്യുക.
നിങ്ങളുടെ ഓർഗനൈസേഷൻ ഐഡി നൽകേണ്ട ഇടം
ഈ എൻഡ്പോയിന്റ് 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 കൺസോൾ നിങ്ങളുടെ യഥാർത്ഥ ഓർഗനൈസേഷൻ ഐഡിയും നിങ്ങളുടെ സ്വന്തം കീയും പൂരിപ്പിക്കുകയും, യഥാർത്ഥ പ്രതികരണം (response) നിങ്ങൾക്ക് കാണുന്നതിനായി ലൈവ് API-ലേക്ക് അഭ്യർത്ഥന (request) പ്രവർത്തിപ്പിക്കുകയും ചെയ്യുന്നു. ഈ എൻഡ്പോയിന്റ് 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