CINXE.COM

<!DOCTYPE html><html><head><meta name="viewport" content="width=device-width"/><meta charSet="utf-8"/><title>Configuration API | Commands & Methods List</title><link rel="canonical" href="https://platform.text.com/docs/management/configuration-api"/><link rel="preconnect" href="https://LATDYRDX9J-dsn.algolia.net" crossorigin="true"/><meta name="description" content="Reach out for the Configuration API to create Bots, webhooks, or properties. Check types of features and available methods."/><meta property="og:title" content="Configuration API"/><meta property="og:description" content="Reach out for the Configuration API to create Bots, webhooks, or properties. Check types of features and available methods."/><meta property="og:type" content="website"/><meta property="og:image" content="https://platform.text.com/docs/images/text-docs-og.png"/><link rel="icon" href="/docs/images/favicon.ico"/><meta name="twitter:card" content="summary_large_image"/><meta name="twitter:creator" content="@textplatform"/><meta name="twitter:title" content="Configuration API"/><meta name="twitter:description" content="Reach out for the Configuration API to create Bots, webhooks, or properties. Check types of features and available methods."/><meta name="twitter:image" content="https://platform.text.com/docs/images/livechat-docs-og.png"/><script type="text/javascript"> window.__lc = window.__lc || {}; window.__lc.license = 1520; ;(function(n,t,c){function i(n){return e._h?e._h.apply(null,n):e._q.push(n)}var e={_q:[],_h:null,_v:"2.0",on:function(){i(["on",c.call(arguments)])},once:function(){i(["once",c.call(arguments)])},off:function(){i(["off",c.call(arguments)])},get:function(){if(!e._h)throw new Error("[LiveChatWidget] You can't use getters before load.");return i(["get",c.call(arguments)])},call:function(){i(["call",c.call(arguments)])},init:function(){var n=t.createElement("script");n.async=!0,n.type="text/javascript",n.src="https://cdn.livechatinc.com/staging/tracking.js",t.head.appendChild(n)}};!n.__lc.asyncInit&&e.init(),n.LiveChatWidget=n.LiveChatWidget||e}(window,document,[].slice)) </script><meta name="next-head-count" content="17"/><link rel="preload" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" as="style"/><link rel="stylesheet" href="/docs/_next/static/css/5c94b719b441ef6e576e.css" data-n-g=""/><noscript data-n-css=""></noscript><link rel="preload" href="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" as="script"/><link rel="preload" href="/docs/_next/static/chunks/pages/management/configuration-api-1723fba76e329d55e33f.js" as="script"/> <script>!function(e){var n="https://s.go-mpulse.net/boomerang/";if("False"=="True")e.BOOMR_config=e.BOOMR_config||{},e.BOOMR_config.PageParams=e.BOOMR_config.PageParams||{},e.BOOMR_config.PageParams.pci=!0,n="https://s2.go-mpulse.net/boomerang/";if(window.BOOMR_API_key="SWHJY-Y2PHV-NVPM2-PDH42-VMPQS",function(){function e(){if(!o){var e=document.createElement("script");e.id="boomr-scr-as",e.src=window.BOOMR.url,e.async=!0,i.parentNode.appendChild(e),o=!0}}function t(e){o=!0;var n,t,a,r,d=document,O=window;if(window.BOOMR.snippetMethod=e?"if":"i",t=function(e,n){var t=d.createElement("script");t.id=n||"boomr-if-as",t.src=window.BOOMR.url,BOOMR_lstart=(new Date).getTime(),e=e||d.body,e.appendChild(t)},!window.addEventListener&&window.attachEvent&&navigator.userAgent.match(/MSIE [67]\./))return window.BOOMR.snippetMethod="s",void t(i.parentNode,"boomr-async");a=document.createElement("IFRAME"),a.src="about:blank",a.title="",a.role="presentation",a.loading="eager",r=(a.frameElement||a).style,r.width=0,r.height=0,r.border=0,r.display="none",i.parentNode.appendChild(a);try{O=a.contentWindow,d=O.document.open()}catch(_){n=document.domain,a.src="javascript:var d=document.open();d.domain='"+n+"';void(0);",O=a.contentWindow,d=O.document.open()}if(n)d._boomrl=function(){this.domain=n,t()},d.write("<bo"+"dy onload='document._boomrl();'>");else if(O._boomrl=function(){t()},O.addEventListener)O.addEventListener("load",O._boomrl,!1);else if(O.attachEvent)O.attachEvent("onload",O._boomrl);d.close()}function a(e){window.BOOMR_onload=e&&e.timeStamp||(new Date).getTime()}if(!window.BOOMR||!window.BOOMR.version&&!window.BOOMR.snippetExecuted){window.BOOMR=window.BOOMR||{},window.BOOMR.snippetStart=(new Date).getTime(),window.BOOMR.snippetExecuted=!0,window.BOOMR.snippetVersion=12,window.BOOMR.url=n+"SWHJY-Y2PHV-NVPM2-PDH42-VMPQS";var i=document.currentScript||document.getElementsByTagName("script")[0],o=!1,r=document.createElement("link");if(r.relList&&"function"==typeof r.relList.supports&&r.relList.supports("preload")&&"as"in r)window.BOOMR.snippetMethod="p",r.href=window.BOOMR.url,r.rel="preload",r.as="script",r.addEventListener("load",e),r.addEventListener("error",function(){t(!0)}),setTimeout(function(){if(!o)t(!0)},3e3),BOOMR_lstart=(new Date).getTime(),i.parentNode.appendChild(r);else t(!1);if(window.addEventListener)window.addEventListener("load",a,!1);else if(window.attachEvent)window.attachEvent("onload",a)}}(),"".length>0)if(e&&"performance"in e&&e.performance&&"function"==typeof e.performance.setResourceTimingBufferSize)e.performance.setResourceTimingBufferSize();!function(){if(BOOMR=e.BOOMR||{},BOOMR.plugins=BOOMR.plugins||{},!BOOMR.plugins.AK){var n=""=="true"?1:0,t="",a="bdpnbeqxglupcz2ckhnq-f-5b72d3ba1-clientnsv4-s.akamaihd.net",i="false"=="true"?2:1,o={"ak.v":"39","ak.cp":"1461330","ak.ai":parseInt("908031",10),"ak.ol":"0","ak.cr":1,"ak.ipv":4,"ak.proto":"http/1.1","ak.rid":"29bd8d1","ak.r":40747,"ak.a2":n,"ak.m":"b","ak.n":"essl","ak.bpcip":"8.222.208.0","ak.cport":36122,"ak.gh":"23.50.232.237","ak.quicv":"","ak.tlsv":"tls1.2","ak.0rtt":"","ak.0rtt.ed":"","ak.csrc":"-","ak.acc":"reno","ak.t":"1732399579","ak.ak":"hOBiQwZUYzCg5VSAfCLimQ==s7w7+sAix7flSlbxqBlThCM7Sa0Rsgxs9PYh8Y3Y8esI4JBn2r81V55I4GsZlHUbjC72B+OEqYOfejV5N1Rz7ZmE1rlfmfVK3ztFWRlqeg84pHmEwIw2qLnq6mUGPWyPxFKRptNNU+OWH9MnwTEqbw9nsyhqsRYYkOIcZsZ+rQt4M37yW1PMwjfJGH+ZHks8J8oqJVrWqfY0f9sVkmcf9H9reCMieojwCZiYq5OpmcVAXcG+miBDaOiN5uaCVfZDWoKP0p+QJWfzlXaqzvtvtz99k8ueBwzzMhrQWEh8QpVPU6SmuvisXQmrK2NP1diMQn430vMMK4d/EWU8GsgBftQYvgzGRqqJ9OfSyMd97tS1B5R3igdiR1ePGYqcTXKTk27r+wnVi++BQxywGlMTk8OBrGgY6kFOXbP1ka/LABM=","ak.pv":"55","ak.dpoabenc":"","ak.tf":i};if(""!==t)o["ak.ruds"]=t;var r={i:!1,av:function(n){var t="http.initiator";if(n&&(!n[t]||"spa_hard"===n[t]))o["ak.feo"]=void 0!==e.aFeoApplied?1:0,BOOMR.addVar(o)},rv:function(){var e=["ak.bpcip","ak.cport","ak.cr","ak.csrc","ak.gh","ak.ipv","ak.m","ak.n","ak.ol","ak.proto","ak.quicv","ak.tlsv","ak.0rtt","ak.0rtt.ed","ak.r","ak.acc","ak.t","ak.tf"];BOOMR.removeVar(e)}};BOOMR.plugins.AK={akVars:o,akDNSPreFetchDomain:a,init:function(){if(!r.i){var e=BOOMR.subscribe;e("before_beacon",r.av,null,null),e("onbeacon",r.rv,null,null),r.i=!0}return this},is_complete:function(){return!0}}}}()}(window);</script></head><body><div id="__next"><style data-emotion-css="cvn8wj">.css-cvn8wj{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;background-color:#4a4a55;height:60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;position:fixed;top:0;width:100%;z-index:99;}@media (min-width:768px){.css-cvn8wj{height:60px;}}</style><div class="css-cvn8wj"><style data-emotion-css="y9662z">.css-y9662z{background:#4a4a55;width:100%;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;}</style><div class="css-y9662z"><style data-emotion-css="qqcdow">.css-qqcdow{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;font-size:15px;margin:0 20px;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:60px;}.css-qqcdow > a > svg{margin:0;display:block;height:24px;}</style><nav class="css-qqcdow"><style data-emotion-css="c2yzgf">.css-c2yzgf{color:white;-webkit-text-decoration:none;text-decoration:none;font-weight:500;white-space:nowrap;margin-left:8px;}.css-c2yzgf:hover{-webkit-text-decoration:none;text-decoration:none;color:white;}</style><a href="https://text.com/" class="css-c2yzgf"><style data-emotion-css="ofqsza">.css-ofqsza{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;justify-items:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:0.8em;height:40px;}.css-ofqsza .logo{margin:0;font-size:2em;font-weight:500;-webkit-letter-spacing:-0.01em;-moz-letter-spacing:-0.01em;-ms-letter-spacing:-0.01em;letter-spacing:-0.01em;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-ofqsza .adjacent{margin:0;font-size:1.8em;font-weight:500;line-height:34px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-letter-spacing:-0.5px;-moz-letter-spacing:-0.5px;-ms-letter-spacing:-0.5px;letter-spacing:-0.5px;}.css-ofqsza .carrier{font-weight:500;-webkit-animation-name:blink;animation-name:blink;-webkit-animation-duration:0.9s;animation-duration:0.9s;-webkit-animation-iteration-count:infinite;animation-iteration-count:infinite;}</style><header class="css-ofqsza"><span class="logo">text<span class="carrier">|</span></span></header></a><a href="/docs" class="css-c2yzgf">Platform Docs</a></nav><style data-emotion-css="16b59id">.css-16b59id{margin:0;padding:0;max-width:calc(100% - 60px);width:calc(100% - 60px);overflow-x:auto;overflow-y:hidden;display:none;margin-right:10px;margin-left:40px;}@media (min-width:1024px){.css-16b59id{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;gap:32px;}}</style><div class="css-16b59id"><style data-emotion-css="11hjr56">.css-11hjr56{font-family:Colfax,colfax-web,Proxima Nova,Open Sans,Gill Sans MT, Gill Sans,Corbel,Arial,sans-serif;position:relative;display:inline-block;height:100%;color:#ffffff;font-weight:400;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}.css-11hjr56:hover{cursor:default;}</style><div class="css-11hjr56">Platform<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">APIs & SDKs<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div><div class="css-11hjr56">Resources<svg width="24" height="24" fill="#FFFFFF" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div><style data-emotion-css="1hppjzv">.css-1hppjzv{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1hppjzv"><style data-emotion-css="7wgbw1">.css-7wgbw1{display:none;}@media (min-width:1024px){.css-7wgbw1{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;width:192px;margin-right:16px;}}</style><div class="DocSearch-Button-Desktop css-7wgbw1"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><style data-emotion-css="1i8rrts">.css-1i8rrts{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;height:100%;}@media (min-width:1024px){.css-1i8rrts{display:none;}}</style><div class="DocSearch-Button-Mobile css-1i8rrts"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><svg width="20" height="20" class="DocSearch-Search-Icon" viewBox="0 0 20 20"><path d="M14.386 14.386l4.0877 4.0877-4.0877-4.0877c-2.9418 2.9419-7.7115 2.9419-10.6533 0-2.9419-2.9418-2.9419-7.7115 0-10.6533 2.9418-2.9419 7.7115-2.9419 10.6533 0 2.9419 2.9418 2.9419 7.7115 0 10.6533z" stroke="currentColor" fill="none" fill-rule="evenodd" stroke-linecap="round" stroke-linejoin="round"></path></svg><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"></span></button></div><p>...</p><style data-emotion-css="pskeb7">@media (min-width:1024px){.css-pskeb7{display:none;}}</style><style data-emotion-css="19rp0xe">.css-19rp0xe{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;margin-right:16px;cursor:pointer;}@media (min-width:1024px){.css-19rp0xe{display:none;}}@media (min-width:1024px){.css-19rp0xe{display:none;}}</style><svg width="32px" height="28px" fill="#ffffff" class="rmi rmi-menu css-19rp0xe" viewBox="0 0 24 24"><path d="M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2z"></path></svg></div></div></div><style data-emotion-css="ov1ktg">.css-ov1ktg{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;}</style><div class="css-ov1ktg"><style data-emotion-css="hpx2k5">.css-hpx2k5{border-right:1px solid #e2e2e4;height:50px;position:fixed;-webkit-transition:height 300ms;transition:height 300ms;display:block;bottom:0%;width:100%;opacity:1;z-index:10;box-shadow:0px 0px 8px rgba(0,0,0,0.25);background-color:white;}@media (min-width:768px){.css-hpx2k5{box-shadow:none;height:100vh;max-height:100vh;position:-webkit-sticky;position:sticky;top:60px;-webkit-transition:all 0s;transition:all 0s;width:260px;}}</style><aside class="css-hpx2k5"><style data-emotion-css="y8dejn">.css-y8dejn{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;background-color:white;padding:10px 14px;cursor:pointer;}@media (min-width:768px){.css-y8dejn{display:none;}}</style><div class="css-y8dejn"><svg style="transform:rotate(270deg);transition:transform 300ms" xmlns="http://www.w3.org/2000/svg" width="20" height="20" viewBox="0 0 24 24"><path d="M10 6L8.59 7.41 13.17 12l-4.58 4.59L10 18l6-6z" fill="currentColor"></path><path d="M0 0h24v24H0z" fill="none"></path></svg>Configuration API</div><style data-emotion-css="v8mm6">.css-v8mm6{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}@media (min-width:768px){.css-v8mm6{display:none;}}</style><div class="css-v8mm6"><style data-emotion-css="1pjh3pd">.css-1pjh3pd{width:100%;color:#62626D;}.css-1pjh3pd:hover{cursor:pointer;-webkit-text-decoration:none;text-decoration:none;background-color:#f6f6f7;}</style><a class="css-1pjh3pd"><style data-emotion-css="1yw2pv4">.css-1yw2pv4{padding:4px 14px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;font-size:16px;}</style><div class="css-1yw2pv4"><style data-emotion-css="5c7uuc">.css-5c7uuc{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:start;-webkit-justify-content:start;-ms-flex-pack:start;justify-content:start;}</style><div class="css-5c7uuc"><svg width="24" height="20px" fill="#62626D" class="rmi rmi-home undefined" viewBox="0 0 24 24"><path d="M10 20v-6h4v6h5v-8h3L12 3 2 12h3v8h5z"></path></svg></div>Home</div></a></div><style data-emotion-css="1ln71vl">.css-1ln71vl{overflow:scroll;height:calc(100% - 90px);}@media (min-width:768px){.css-1ln71vl{height:calc(100% - 60px);position:fixed;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;height:100%;max-height:100vh;position:-webkit-sticky;position:-webkit-sticky;position:sticky;top:0;margin-top:8px;}}</style><div class="css-1ln71vl"><style data-emotion-css="1psvkz3">.css-1psvkz3{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1psvkz3:hover{background-color:#f6f6f7;}</style><div class="css-1psvkz3"><style data-emotion-css="19nl305">.css-19nl305{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#62626D;width:100%;}.css-19nl305:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-19nl305"><style data-emotion-css="2hhlpj">.css-2hhlpj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:6px 16px 6px 20px;margin-right:10px;font-weight:500;font-size:16px;border-radius:0px 8px 8px 0px;width:100%;}.css-2hhlpj:hover{background-color:#f6f6f7;}</style><div class="css-2hhlpj"><style data-emotion-css="oe3dsw">.css-oe3dsw{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;margin-right:8px;}</style><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Management Overview</div></a></div><style data-emotion-css="1gg9bms">.css-1gg9bms{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;margin-right:10px;font-weight:600;font-size:16px;border-radius:0px 8px 8px 0px;}.css-1gg9bms:hover{background-color:#f6f6f7;}</style><div class="css-1gg9bms"><style data-emotion-css="17iyluq">.css-17iyluq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;color:#4284F5;width:100%;}.css-17iyluq:hover{color:#4284F5;cursor:pointer;-webkit-text-decoration:none;text-decoration:none;}</style><a class="css-17iyluq"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Configuration API</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Webhooks</div></a></div><div class="css-1psvkz3"><a class="css-19nl305"><div class="css-2hhlpj"><div class="css-oe3dsw"><svg fill="#424D57" width="12px" height="16px" viewBox="0 0 12 16" version="1.1" xmlns="http://www.w3.org/2000/svg" xlink="http://www.w3.org/1999/xlink"><path d="M1.5,0.5 C0.675,0.5 0.0075,1.175 0.0075,2 L0,14 C0,14.825 0.6675,15.5 1.4925,15.5 L10.5,15.5 C11.325,15.5 12,14.825 12,14 L12,5 L7.5,0.5 L1.5,0.5 Z M6.75,5.75 L6.75,1.625 L10.875,5.75 L6.75,5.75 Z" fill-rule="nonzero" fill="currentColor"></path></svg></div>Changelog</div></a></div></div></aside><style data-emotion-css="1g06r20">.css-1g06r20{padding-bottom:30vh;position:relative;width:100%;}@media (min-width:768px){.css-1g06r20{width:calc(100% - 258px);max-width:900px;}}</style><div class="css-1g06r20"><style data-emotion-css="yofbie">.css-yofbie{width:100%;position:fixed;top:60px;right:0;z-index:40;-webkit-transition:left 0.3s ease-out;transition:left 0.3s ease-out;}@media (min-width:768px){.css-yofbie{left:260px;width:calc(100% - 260px);top:60px;}}</style><div class="css-yofbie"><style data-emotion-css="9hc061">.css-9hc061{padding:20px 24px 32px 60px;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:10px;}@media (max-width:1270px){.css-9hc061{background-color:#fff;padding-bottom:24px;}}@media (max-width:768px){.css-9hc061{-webkit-box-pack:start;-webkit-justify-content:flex-start;-ms-flex-pack:start;justify-content:flex-start;padding-left:30px;}}</style><div class="css-9hc061"><style data-emotion-css="7fagxn">.css-7fagxn{font-weight:400;font-size:15px;line-height:22px;padding:7px 8px 7px 16px;}</style><button class="lc-btn lc-btn--secondary css-7fagxn" type="button"><div><style data-emotion-css="44gx6g">.css-44gx6g{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;gap:4px;}</style><div class="css-44gx6g"><span>API version:</span><span>3.5 (stable)</span><svg width="20px" height="20px" fill="#424D57" class="rmi rmi-chevron-down undefined" viewBox="0 0 24 24"><path d="M7.41 8.58 12 13.17l4.59-4.59L18 10l-6 6-6-6 1.41-1.42z"></path></svg></div></div></button></div></div><style data-emotion-css="c8i9h7">.css-c8i9h7{margin-top:120px;padding:0px 30px;}@media (min-width:768px){.css-c8i9h7{padding:0px 60px;}}.css-c8i9h7.redoc{margin-top:60px;display:block;}</style><article class=" css-c8i9h7"><style data-emotion-css="1lyzzun">.css-1lyzzun{margin:3em 0 1em;padding:2em 0 1em;}</style><div class="css-1lyzzun"><style data-emotion-css="12qxxrf">.css-12qxxrf{margin:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;font-weight:500;text-rendering:optimizeLegibility;font-size:2.25rem;line-height:1.1;-webkit-letter-spacing:-0.02em;-moz-letter-spacing:-0.02em;-ms-letter-spacing:-0.02em;letter-spacing:-0.02em;}@media (min-width:768px){.css-12qxxrf{-webkit-flex-direction:row;-ms-flex-direction:row;flex-direction:row;}}</style><h2 id="configuration-api" class="css-12qxxrf"><span>Configuration API</span><style data-emotion-css="1g0dr3m">.css-1g0dr3m{margin-top:8px;}.css-1g0dr3m > label{margin:0 0 5px 0;}.css-1g0dr3m label + div{-webkit-box-pack:end;-webkit-justify-content:flex-end;-ms-flex-pack:end;justify-content:flex-end;}</style></h2></div><style data-emotion-css="1679d3t">.css-1679d3t{border-bottom:1px solid #e0e4e9;padding-bottom:0.5em;}</style><h2 class="heading css-1679d3t"><style data-emotion-css="180507a">.css-180507a{color:inherit;-webkit-text-decoration:none;text-decoration:none;position:relative;}.css-180507a:hover{color:inherit;-webkit-text-decoration:none;text-decoration:none;}.css-180507a:hover:before{content:"#";position:absolute;font-weight:300;left:-1em;top:1px;opacity:0.3;}.css-180507a:focus-visible{outline-width:0px;}</style><a id="introduction" href="#introduction" class="reference css-180507a"><a href="/docs/management/configuration-api#introduction"><span class="icon icon-link"></span></a>Introduction</a></h2><p>Configuration API is a service for storing configuration of license. You can set up here different types of features such as properties or webhooks.</p><h3 class="heading"><a id="versioning" href="#versioning" class="reference css-180507a"><a href="/docs/management/configuration-api#versioning"><span class="icon icon-link"></span></a>Versioning</a></h3><p>This document describes the <strong>Configuration API v3.5</strong>. This is the latest stable version recommended for the production use. <a href="/docs/management#api-versioning">Read more about versioning...</a></p><h3 class="heading"><a id="authentication" href="#authentication" class="reference css-180507a"><a href="/docs/management/configuration-api#authentication"><span class="icon icon-link"></span></a>Authentication</a></h3><p>Authentication for Configuration API is handled by access tokens. Find out how to get an access token from <a href="/docs/authorization/agent-authorization">Agent authorization flows</a>. If a method requires particular authorization scopes, you’ll find them included in the method description. Each request should contain the <code>Authorization: Bearer <your_access_token></code> header.</p><h3 class="heading"><a id="data-centers" href="#data-centers" class="reference css-180507a"><a href="/docs/management/configuration-api#data-centers"><span class="icon icon-link"></span></a>Data centers</a></h3><p>LiveChat system operates in two data centers: <code>dal</code> (USA) and <code>fra</code> (Europe). The default data center is <code>dal</code>.</p><p>All the LiveChat OAuth 2.1 access tokens have a prefix: <code>dal:</code> or <code>fra:</code>. This prefix indicates the data center they belong to. If you need to specify the data center while making an API call, simply add the <code>X-Region: <token_prefix></code> optional header.</p><p>Summing up, if the user token starts with <code>fra</code>, you should add the <code>X-Region: fra</code> header. If the token starts with <code>dal</code>, you don’t have to specify the header.</p><p>If you get the <style data-emotion-css="kbi7q3">.css-kbi7q3{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3 svg{vertical-align:middle;margin-left:2px;margin-right:4px;color:#4284F5;}.css-kbi7q3 code{color:#4284F5;}.css-kbi7q3:hover,.css-kbi7q3:active{-webkit-text-decoration:none;text-decoration:none;}.css-kbi7q3:hover code,.css-kbi7q3:active code{color:#4284F5;-webkit-text-decoration:underline;text-decoration:underline;}</style><a href="/docs/management/configuration-api#possible-errors" class="css-kbi7q3"><code>misdirected_request</code></a> error, use the prefix returned in the error as the value of <code>X-Region</code>.</p><h3 class="heading"><a id="propagation-delay" href="#propagation-delay" class="reference css-180507a"><a href="/docs/management/configuration-api#propagation-delay"><span class="icon icon-link"></span></a>Propagation delay</a></h3><p>All configurations set by this API will have action in system after max 2 minutes. This delay will be removed in the future.</p><h3 class="heading"><a id="postman-collection" href="#postman-collection" class="reference css-180507a"><a href="/docs/management/configuration-api#postman-collection"><span class="icon icon-link"></span></a>Postman collection</a></h3><p>You can find all the requests from the Configuration API v3.5 in Postman. In our collection, we use <a href="https://learning.getpostman.com/docs/postman/environments_and_globals/manage_environments/">environment variables</a> that store, for example, the access token. Importing the collection from the link below downloads the environment as well. Remember to replace sample tokens with your own.</p><p><a href="https://god.gw.postman.com/run-collection/20754404-64151b88-db16-46f5-a00f-296fe4d26576?action=collection%2Ffork&collection-url=entityId%3D20754404-64151b88-db16-46f5-a00f-296fe4d26576%26entityType%3Dcollection%26workspaceId%3D5e6fb31b-587b-4258-b215-4dccaae38a38#?env%5BLiveChat%20APIs%5D=W3sia2V5IjoiZGF0ZV9mcm9tIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MH0seyJrZXkiOiJkYXRlX3RvIiwidmFsdWUiOiIyMDEzLTAxLTI5IiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMjAxMy0wMS0yOSIsInNlc3Npb25JbmRleCI6MX0seyJrZXkiOiJhZ2VudCIsInZhbHVlIjoiam9obi5kb2VAbXljb21wYW55LmNvbSIsImVuYWJsZWQiOnRydWUsInNlc3Npb25WYWx1ZSI6ImpvaG4uZG9lQG15Y29tcGFueS5jb20iLCJzZXNzaW9uSW5kZXgiOjJ9LHsia2V5IjoiZ3JvdXBfYnkiLCJ2YWx1ZSI6ImhvdXIiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJob3VyIiwic2Vzc2lvbkluZGV4IjozfSx7ImtleSI6Imdyb3VwIiwidmFsdWUiOiIyIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMiIsInNlc3Npb25JbmRleCI6NH0seyJrZXkiOiJ3ZWVrZGF5IiwidmFsdWUiOiJtb24iLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJtb24iLCJzZXNzaW9uSW5kZXgiOjV9LHsia2V5IjoiYXBpX3ZlcnNpb24iLCJ2YWx1ZSI6InYzLjUiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJ2My41Iiwic2Vzc2lvbkluZGV4Ijo2fSx7ImtleSI6ImFjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3RfLUF2WlNTT0RLa1pzcmpvUGtRIiwic2Vzc2lvbkluZGV4Ijo3fSx7ImtleSI6ImN1c3RvbWVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3RfcHE3UVllVlpMRkV6RE5CVGciLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJkYWw6dGVzdF9wcTdRWWVWWkxGRXpETkJUZyIsInNlc3Npb25JbmRleCI6OH0seyJrZXkiOiJhY2NvdW50X2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJzZXNzaW9uVmFsdWUiOiJiN2VmZjc5OC1mOGRmLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJzZXNzaW9uSW5kZXgiOjl9LHsia2V5IjoibGljZW5zZV9pZCIsInZhbHVlIjoiMTA0MTMwNjIzIiwiZW5hYmxlZCI6dHJ1ZSwic2Vzc2lvblZhbHVlIjoiMTA0MTMwNjIzIiwic2Vzc2lvbkluZGV4IjoxMH0seyJrZXkiOiJwYXJ0bmVyX2FwaV91cmwiLCJ2YWx1ZSI6Imh0dHBzOi8vYXBpLmxpdmVjaGF0aW5jLmNvbS92Mi9wYXJ0bmVycyIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiaHR0cHM6Ly9hcGkubGl2ZWNoYXRpbmMuY29tL3YyL3BhcnRuZXJzIiwic2Vzc2lvbkluZGV4IjoxMX0seyJrZXkiOiJwYXJ0bmVyX2FjY2Vzc190b2tlbiIsInZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsImVuYWJsZWQiOnRydWUsInR5cGUiOiJkZWZhdWx0Iiwic2Vzc2lvblZhbHVlIjoiZGFsOnRlc3Rfb3VoZWZnMzQ4N3dlcnRxM0pFQiIsInNlc3Npb25JbmRleCI6MTJ9LHsia2V5Ijoib3JnYW5pemF0aW9uX2lkIiwidmFsdWUiOiJiN2VmZjc5OC1mOGxqLTQzNjQtODA1OS02NDljMzVjOWVkMGMiLCJlbmFibGVkIjp0cnVlLCJ0eXBlIjoiZGVmYXVsdCIsInNlc3Npb25WYWx1ZSI6ImI3ZWZmNzk4LWY4bGotNDM2NC04MDU5LTY0OWMzNWM5ZWQwYyIsInNlc3Npb25JbmRleCI6MTN9XQ=="><div style="max-width:123px"><style data-emotion-css="v3memn">.css-v3memn{display:block;max-width:100%;overflow:hidden;position:relative;box-sizing:border-box;margin-top:0;margin-left:0;margin-right:0;margin-bottom:10px;}</style><div class="css-v3memn"><style data-emotion-css="sa8835">.css-sa8835{box-sizing:border-box;display:block;max-width:100%;padding-top:calc(30 / 123 * 100%);}</style><div class="css-sa8835"><style data-emotion-css="5r33xa">.css-5r33xa{position:absolute;top:0;left:0;bottom:0;right:0;box-sizing:border-box;padding:0;border:none;margin:auto;display:block;width:0;height:0;min-width:100%;max-width:100%;min-height:100%;max-height:100%;}</style><img alt="Run in Postman" src="https://run.pstmn.io/button.svg" decoding="async" class="css-5r33xa"/></div></div></div></a></p><h2 class="heading css-1679d3t"><a id="methods" href="#methods" class="reference css-180507a"><a href="/docs/management/configuration-api#methods"><span class="icon icon-link"></span></a>Methods</a></h2><h3 class="heading"><a id="available-methods" href="#available-methods" class="reference css-180507a"><a href="/docs/management/configuration-api#available-methods"><span class="icon icon-link"></span></a>Available methods</a></h3><style data-emotion-css="v24v0q">.css-v24v0q{max-width:830px;}</style><section class="css-v24v0q"><style data-emotion-css="q76ucn">.css-q76ucn{width:100%;overflow-x:auto;}</style><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td><strong>Agents</strong></td><td><a href="/docs/management/configuration-api#create-agent" class="css-kbi7q3"><code>create_agent</code></a> <a href="/docs/management/configuration-api#get-agent" class="css-kbi7q3"><code>get_agent</code></a> <a href="/docs/management/configuration-api#list-agents" class="css-kbi7q3"><code>list_agents</code></a> <a href="/docs/management/configuration-api#update-agent" class="css-kbi7q3"><code>update_agent</code></a> <a href="/docs/management/configuration-api#delete-agent" class="css-kbi7q3"><code>delete_agent</code></a> <a href="/docs/management/configuration-api#suspend-agent" class="css-kbi7q3"><code>suspend_agent</code></a> <a href="/docs/management/configuration-api#unsuspend-agent" class="css-kbi7q3"><code>unsuspend_agent</code></a> <a href="/docs/management/configuration-api#request-agent-unsuspension" class="css-kbi7q3"><code>request_agent_unsuspension</code></a> <a href="/docs/management/configuration-api#approve-agent" class="css-kbi7q3"><code>approve_agent</code></a></td></tr><tr><td><strong>Auto access</strong></td><td><a href="/docs/management/configuration-api#add-auto-access" class="css-kbi7q3"><code>add_auto_access</code></a> <a href="/docs/management/configuration-api#list-auto-access" class="css-kbi7q3"><code>list_auto_access</code></a> <a href="/docs/management/configuration-api#delete-auto-access" class="css-kbi7q3"><code>delete_auto_access</code></a> <a href="/docs/management/configuration-api#update-auto-access" class="css-kbi7q3"><code>update_auto_access</code></a></td></tr><tr><td><strong>Bots</strong></td><td><a href="/docs/management/configuration-api#create-bot-template" class="css-kbi7q3"><code>create_bot_template</code></a> <a href="/docs/management/configuration-api#create-bot" class="css-kbi7q3"><code>create_bot</code></a> <a href="/docs/management/configuration-api#delete-bot-template" class="css-kbi7q3"><code>delete_bot_template</code></a> <a href="/docs/management/configuration-api#delete-bot" class="css-kbi7q3"><code>delete_bot</code></a> <a href="/docs/management/configuration-api#update-bot-template" class="css-kbi7q3"><code>update_bot_template</code></a> <a href="/docs/management/configuration-api#update-bot" class="css-kbi7q3"><code>update_bot</code></a> <a href="/docs/management/configuration-api#list-bot-templates" class="css-kbi7q3"><code>list_bot_templates</code></a> <a href="/docs/management/configuration-api#get-bot" class="css-kbi7q3"><code>get_bot</code></a> <a href="/docs/management/configuration-api#list-bots" class="css-kbi7q3"><code>list_bots</code></a> <a href="/docs/management/configuration-api#issue-bot-token" class="css-kbi7q3"><code>issue_bot_token</code></a> <a href="/docs/management/configuration-api#reset-bot-template-secret" class="css-kbi7q3"><code>reset_bot_template_secret</code></a> <a href="/docs/management/configuration-api#reset-bot-secret" class="css-kbi7q3"><code>reset_bot_secret</code></a></td></tr><tr><td><strong>Groups</strong></td><td><a href="/docs/management/configuration-api#create-group" class="css-kbi7q3"><code>create_group</code></a> <a href="/docs/management/configuration-api#get-group" class="css-kbi7q3"><code>get_group</code></a> <a href="/docs/management/configuration-api#list-groups" class="css-kbi7q3"><code>list_groups</code></a> <a href="/docs/management/configuration-api#update-group" class="css-kbi7q3"><code>update_group</code></a> <a href="/docs/management/configuration-api#delete-group" class="css-kbi7q3"><code>delete_group</code></a></td></tr><tr><td><strong>Properties</strong></td><td><a href="/docs/management/configuration-api#register-properties" class="css-kbi7q3"><code>register_properties</code></a> <a href="/docs/management/configuration-api#unregister-properties" class="css-kbi7q3"><code>unregister_properties</code></a> <a href="/docs/management/configuration-api#publish-properties" class="css-kbi7q3"><code>publish_properties</code></a> <a href="/docs/management/configuration-api#list-properties" class="css-kbi7q3"><code>list_properties</code></a> <a href="/docs/management/configuration-api#update-license-properties" class="css-kbi7q3"><code>update_license_properties</code></a> <a href="/docs/management/configuration-api#delete-license-properties" class="css-kbi7q3"><code>delete_license_properties</code></a> <a href="/docs/management/configuration-api#list-license-properties" class="css-kbi7q3"><code>list_license_properties</code></a> <a href="/docs/management/configuration-api#update-group-properties" class="css-kbi7q3"><code>update_group_properties</code></a> <a href="/docs/management/configuration-api#delete-group-properties" class="css-kbi7q3"><code>delete_group_properties</code></a> <a href="/docs/management/configuration-api#list-groups-properties" class="css-kbi7q3"><code>list_groups_properties</code></a></td></tr><tr><td><strong>Tags</strong></td><td><a href="/docs/management/configuration-api#create-tag" class="css-kbi7q3"><code>create_tag</code></a> <a href="/docs/management/configuration-api#delete-tag" class="css-kbi7q3"><code>delete_tag</code></a> <a href="/docs/management/configuration-api#list-tags" class="css-kbi7q3"><code>list_tags</code></a> <a href="/docs/management/configuration-api#update-tag" class="css-kbi7q3"><code>update_tag</code></a></td></tr><tr><td><strong>Webhooks</strong></td><td><a href="/docs/management/configuration-api#register-webhook" class="css-kbi7q3"><code>register_webhook</code></a> <a href="/docs/management/configuration-api#list-webhooks" class="css-kbi7q3"><code>list_webhooks</code></a> <a href="/docs/management/configuration-api#unregister-webhook" class="css-kbi7q3"><code>unregister_webhook</code></a> <a href="/docs/management/configuration-api#list-webhook-names" class="css-kbi7q3"><code>list_webhook_names</code></a> <a href="/docs/management/configuration-api#enable-license-webhooks" class="css-kbi7q3"><code>enable_license_webhook</code></a> <a href="/docs/management/configuration-api#disable-license-webhooks" class="css-kbi7q3"><code>disable_license_webhook</code></a> <a href="/docs/management/configuration-api#get-license-webhooks-state" class="css-kbi7q3"><code>get_license_webhooks_state</code></a></td></tr><tr><td><strong>Other</strong></td><td><a href="/docs/management/configuration-api#list-channels" class="css-kbi7q3"><code>list_channels</code></a> <a href="/docs/management/configuration-api#check-product-limits-for-plan" class="css-kbi7q3"><code>check_product_limits_for_plan</code></a></td></tr></tbody></table></div></section><h3 class="heading"><a id="batch-requests" href="#batch-requests" class="reference css-180507a"><a href="/docs/management/configuration-api#batch-requests"><span class="icon icon-link"></span></a>Batch requests</a></h3><p>Batch requests make it possible to execute one method multiple times with different payloads, all in a single request.</p><p>Each request in a batch is executed concurrently – there's no guarantee regarding the execution order. The response for each method is returned in an array in the same order as in the batch request. It's not possibile to mix different methods in a single batch request, for example Create Agent and Update Agent. Batch requests require the same scopes as their non-batch equivalents.</p><h4 class="heading"><a id="request" href="#request" class="reference css-180507a"><a href="/docs/management/configuration-api#request"><span class="icon icon-link"></span></a>Request</a></h4><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>requests</code></td><td>yes</td><td><code>array</code></td><td>Array of request objects of the corresponding non-batch method</td></tr></tbody></table></div><style data-emotion-css="17buymi">.css-17buymi{width:100%;}@media (min-width:768px){.css-17buymi{padding:25px 25px 30px 0px;}}</style><div class="css-17buymi"><style data-emotion-css="1vuwrgc">.css-1vuwrgc{border:1px solid #e8e8e8;border-radius:6px;background-color:#f1f6f8;min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-flex-direction:column;-ms-flex-direction:column;flex-direction:column;margin:0 0 20px;max-width:100%;}.css-1vuwrgc .remark-highlight{min-height:0;}.css-1vuwrgc pre{min-height:0;}</style><div class="css-1vuwrgc"><style data-emotion-css="iwgofq">.css-iwgofq{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;height:42px;background-color:#dee5e8;border-radius:5px 5px 0 0;font-size:13px;text-transform:uppercase;-webkit-letter-spacing:0.04em;-moz-letter-spacing:0.04em;-ms-letter-spacing:0.04em;letter-spacing:0.04em;}</style><div class="css-iwgofq"><style data-emotion-css="w6gvpm">.css-w6gvpm{-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;}</style><span class="css-w6gvpm">Format of request payload</span> <style data-emotion-css="1wp1vo7">.css-1wp1vo7{position:relative;-webkit-box-flex:1;-webkit-flex-grow:1;-ms-flex-positive:1;flex-grow:1;width:45px;}</style><div class="css-1wp1vo7"><style data-emotion-css="xnt8k0">.css-xnt8k0{position:relative;min-height:18px;}</style><div class="css-xnt8k0"><style data-emotion-css="6oazep">.css-6oazep{position:absolute;top:0;left:0;right:0;text-align:right;text-transform:capitalize;line-height:20px;font-size:13px;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;opacity:0;-webkit-transition-delay:0.25s;transition-delay:0.25s;-webkit-transition:none;transition:none;}</style><div class="css-6oazep"><style data-emotion-css="11ycufd">.css-11ycufd{-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;max-width:100%;overflow-x:auto;}</style><div class="css-11ycufd">Copied!</div></div><style data-emotion-css="139ndot">.css-139ndot{position:absolute;top:0;right:0;text-align:right;max-width:24px;opacity:1;-webkit-transition-delay:0.25;transition-delay:0.25;-webkit-transition:opacity 0.25s ease-in-out;transition:opacity 0.25s ease-in-out;}.css-139ndot:hover{cursor:pointer;}</style><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><style data-emotion-css="ju12u0">.css-ju12u0{min-height:0;display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;max-width:100%;overflow:scroll;}.css-ju12u0 code{display:inline-block;}</style><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"requests"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span><request object><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><another request object><span class="token punctuation">}</span><span class="token punctuation">,</span> ... <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div><h4 class="heading"><a id="response" href="#response" class="reference css-180507a"><a href="/docs/management/configuration-api#response"><span class="icon icon-link"></span></a>Response</a></h4><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Notes</th></tr></thead><tbody><tr><td><code>responses</code></td><td>Array of response objects or <a href="/docs/management/configuration-api#errors">errors</a> of the corresponding non-batch method. The order is the same as in the request.</td></tr></tbody></table></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Format of response payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"responses"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span><response object or error><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><another response object or error><span class="token punctuation">}</span><span class="token punctuation">,</span> ... <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div><style data-emotion-css="16prjg8">.css-16prjg8{border:1px solid #e8e8e8;border-radius:6px;background-color:#505671;color:white;margin:0 0 20px;max-width:100%;--code-color:#f5fbff;--code-background:#505671;--code-string-color:#56d4bc;}</style><div class="css-16prjg8"><style data-emotion-css="13hnul0">.css-13hnul0{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:justify;-webkit-justify-content:space-between;-ms-flex-pack:justify;justify-content:space-between;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;padding:5px 15px;background-color:#383f54;border-radius:8px 8px 0 0;color:#dee5e8;}.css-13hnul0 code{font-size:12px;max-width:100%;-webkit-box-flex:2;-webkit-flex-grow:2;-ms-flex-positive:2;flex-grow:2;word-break:break-all;}.css-13hnul0 .code-sample-header{border:none;background-color:#383f54;color:#dee5e8;padding:0.2em 0;}</style><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><style data-emotion-css="1sg2lsz">.css-1sg2lsz{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-align-items:center;-webkit-box-align:center;-ms-flex-align:center;align-items:center;}</style><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/batch_delete_agents <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "requests": [ { "id": "smith@example.com" }, { "id": "brown@example.com" }, {} ] }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"responses"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span><span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token punctuation">{</span> <span class="token property">"error"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"validation"</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"`id` is required"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div><h4 class="heading"><a id="methods-with-batch-support" href="#methods-with-batch-support" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-with-batch-support"><span class="icon icon-link"></span></a>Methods with batch support</a></h4><h5 class="heading"><a id="batch-support-for-agents" href="#batch-support-for-agents" class="reference css-180507a"><a href="/docs/management/configuration-api#batch-support-for-agents"><span class="icon icon-link"></span></a>Batch support for Agents</a></h5><div class="css-q76ucn"><table><thead><tr><th>Method</th><th>Batch method URL</th></tr></thead><tbody><tr><td><a href="/docs/management/configuration-api#create-agent">Create Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_create_agents</code></td></tr><tr><td><a href="/docs/management/configuration-api#update-agent">Update Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_update_agents</code></td></tr><tr><td><a href="/docs/management/configuration-api#delete-agent">Delete Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_delete_agents</code></td></tr><tr><td><a href="/docs/management/configuration-api#suspend-agent">Suspend Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_suspend_agents</code></td></tr><tr><td><a href="/docs/management/configuration-api#unsuspend-agent">Unsuspend Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_unsuspend_agents</code></td></tr><tr><td><a href="/docs/management/configuration-api#approve-agent">Approve Agent</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_approve_agents</code></td></tr></tbody></table></div><h5 class="heading"><a id="batch-support-for-bots" href="#batch-support-for-bots" class="reference css-180507a"><a href="/docs/management/configuration-api#batch-support-for-bots"><span class="icon icon-link"></span></a>Batch support for Bots</a></h5><div class="css-q76ucn"><table><thead><tr><th>Method</th><th>Batch method URL</th></tr></thead><tbody><tr><td><a href="/docs/management/configuration-api#create-bot">Create Bot</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_create_bots</code></td></tr><tr><td><a href="/docs/management/configuration-api#update-bot">Update Bot</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_update_bots</code></td></tr><tr><td><a href="/docs/management/configuration-api#delete-bot">Delete Bot</a></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/batch_delete_bots</code></td></tr></tbody></table></div><h2 class="heading css-1679d3t"><a id="agents" href="#agents" class="reference css-180507a"><a href="/docs/management/configuration-api#agents"><span class="icon icon-link"></span></a>Agents</a></h2><p>An agent is a type of user who communicates with customers. You can look up the sample agent data structure in the <a href="/docs/management/configuration-api#get-agent">response of Get Agent</a>.</p><h3 class="heading"><a id="methods-1" href="#methods-1" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-1"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Agents API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th>Value</th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td><code>application/json</code></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="create-agent" href="#create-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#create-agent"><span class="icon icon-link"></span></a>Create Agent</a></h4><p>Creates a new agent with specified parameters within a license.</p><h5 class="heading"><a id="specifics" href="#specifics" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/create_agent</code></td></tr><tr><td>Required scopes</td><td><code>accounts--all:rc</code> <code>accounts--all:rw</code><sup><strong>1</strong></sup> <code>subscription.lc:rw</code><sup><strong>1</strong></sup> <sup><strong>2</strong></sup> <code>accounts.roles.lc--all:rw</code><sup><strong>3</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> To create agents who don't have to wait for approval after creation<br/> <strong>2)</strong> <code>subscription.lc:rw</code> is a private scope; it's not possible to configure it in Developer Console.<br/> <strong>3)</strong> To create an agent with role higher than <code>normal</code> (<code>administrator</code>, <code>viceowner</code> or <code>owner</code>)</p><h5 class="heading"><a id="request-1" href="#request-1" class="reference css-180507a"><a href="/docs/management/configuration-api#request-1"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>string</code></td><td>Yes</td><td>Agent ID</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>Yes</td><td>Agent name</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td>No</td><td>Agent role, should be one of the following: <code>viceowner</code>, <code>administrator</code>, <code>normal</code> (default).</td></tr><tr><td><code>avatar</code></td><td><code>string</code></td><td>No</td><td>Avatar URL</td></tr><tr><td><code>login_status</code></td><td><code>string</code></td><td>No</td><td>Agent's default status right after the login, should be one of the following: <code>accepting chats</code>, <code>not accepting chats</code> (default).</td></tr><tr><td><code>job_title</code></td><td><code>string</code></td><td>No</td><td>Agent's job title</td></tr><tr><td><code>mobile</code></td><td><code>string</code></td><td>No</td><td>Agent's mobile number</td></tr><tr><td><code>max_chats_count</code></td><td><code>int</code></td><td>No</td><td>Agent's maximum number of concurrent chats; default: 6. Limited to 100.</td></tr><tr><td><code>awaiting_approval</code></td><td><code>bool</code></td><td>No</td><td>Determines if the Agent will be awaiting approval after creation. Only a requester with the <code>subscription.lc:rw</code> scope can set this value to <code>false</code>.</td></tr><tr><td><code>groups</code></td><td><code>object[]</code></td><td>No</td><td>Groups an Agent belongs to.</td></tr><tr><td><code>groups[].id</code></td><td><code>uint</code></td><td>Yes</td><td>Group ID; required only when <code>group</code> is included.</td></tr><tr><td><code>groups[].priority</code><sup><strong>4</strong></sup></td><td><code>string</code></td><td>Yes</td><td>Agent's priority in a group; required only when <code>group</code> is included.</td></tr><tr><td><code>notifications</code><sup><strong>5</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Represents which Agent notifications are turned on.</td></tr><tr><td><code>email_subscriptions</code><sup><strong>6</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Represents which subscriptions will be send to the Agent via email.</td></tr><tr><td><code>work_scheduler</code></td><td><code>object</code></td><td>No</td><td>Work scheduler options to set for the new Agent</td></tr><tr><td><code>work_scheduler.timezone</code></td><td><code>string</code></td><td>Yes</td><td>Timezone for the work scheduler. Required only when <code>schedule</code> is not empty. Falls back to the agent's timezone if empty.</td></tr><tr><td><code>work_scheduler.schedule</code></td><td><code>object[]</code></td><td>Yes</td><td>List of agent's working hours.</td></tr><tr><td><code>work_scheduler.schedule[].day</code></td><td><code>string</code></td><td>Yes</td><td>The day for which the working hours are set. Possible values: sunday, monday, tuesday, wednesday, thursday, friday, and saturday.</td></tr><tr><td><code>work_scheduler.schedule[].enabled</code></td><td><code>bool</code></td><td>Yes</td><td>Whether the given set of working hours is enabled.</td></tr><tr><td><code>work_scheduler.schedule[].start</code></td><td><code>string</code></td><td>Yes</td><td>When working hours start.</td></tr><tr><td><code>work_scheduler.schedule[].end</code></td><td><code>string</code></td><td>Yes</td><td>When working hours end.</td></tr></tbody></table></div><p><strong>4)</strong> Possible values for the <code>groups[].priority</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Agents with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Agents with the <code>normal</code> priority get chats before those with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Agents with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Agents with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><p><strong>5)</strong> Possible values for the <code>notifications</code> array:</p><ul><li><code>new_visitor</code></li><li><code>incoming_chat</code></li><li><code>returning_visitor</code></li><li><code>queued_visitor</code></li><li><code>visitor_is_typing</code></li><li><code>new_goal</code></li><li><code>unassigned_chats</code></li><li><code>unassigned_chat_messages</code></li><li><code>ticket</code></li><li><code>inactive_notifications</code></li><li><code>mute_all_sounds</code></li><li><code>repeat_sound_notifications</code></li><li><code>ticket_notifications</code></li><li><code>incoming_message_for_focused_chat</code></li></ul><p><strong>6)</strong> Possible values for the <code>email_subscriptions</code> array:</p><ul><li><code>daily_summary</code></li><li><code>weekly_summary</code></li></ul></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/create_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com", "name": "Agent Smith", "role": "viceowner", "groups": [ { "id": 5, "priority": "first" }, { "id": 2, "priority": "last" }, { "id": 1, "priority": "normal" } ], "work_scheduler": { "schedule": [ { "day": "monday", "start": "08:00", "end": "12:30", "enabled": true }, { "day": "monday", "start": "13:30", "end": "16:00", "enabled": true }, { "day": "friday", "start": "08:00", "end": "16:00", "enabled": true } ], "timezone": "Europe/Warsaw" }, "notifications": [ "new_visitor", "new_goal", "visitor_is_typing" ], "email_subscriptions": [ "weekly_summary" ] }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "smith@example.com" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="get-agent" href="#get-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#get-agent"><span class="icon icon-link"></span></a>Get Agent</a></h4><p>It returns the info about an Agent specified by <code>id</code>.</p><h5 class="heading"><a id="specifics-1" href="#specifics-1" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-1"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/get_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--my:ro</code> <code>agents--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-2" href="#request-2" class="reference css-180507a"><a href="/docs/management/configuration-api#request-2"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>string</code></td><td>Yes</td><td>Agent ID</td></tr><tr><td><code>fields</code><sup><strong>1</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Additional fields to include.</td></tr></tbody></table></div><p><strong>1)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>work_scheduler</code></td><td>Work scheduler object for an Agent. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>groups</code></td><td>Groups an Agent belongs to</td></tr><tr><td><code>email_subscriptions</code></td><td>A list of an Agent's active subscriptions</td></tr><tr><td><code>notifications</code></td><td>A list of an Agent's enabled notifications</td></tr><tr><td><code>job_title</code></td><td>Agent's job title</td></tr><tr><td><code>mobile</code></td><td>Agent's mobile number</td></tr><tr><td><code>max_chats_count</code></td><td>Agent's maximum number of concurrent chats</td></tr><tr><td><code>suspended</code></td><td>Boolean value indicating if an Agent is suspended</td></tr><tr><td><code>awaiting_approval</code></td><td>Boolean value indicating if an Agent is awaiting approval</td></tr><tr><td><code>last_logout</code></td><td>RFC 3339 date-time of the last logout of an Agent (omitted when no logout occurred)</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/get_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "smith@example.com", "account_id": "d24fa41e-bc16-41b8-a15b-9ca45ff7e0cf", "name": "Agent Smith", "avatar": "https://domain.com/avatar.image.jpg", "role": "administrator", "login_status": "accepting chats" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-agents" href="#list-agents" class="reference css-180507a"><a href="/docs/management/configuration-api#list-agents"><span class="icon icon-link"></span></a>List Agents</a></h4><p>Returns all Agents within a license.</p><h5 class="heading"><a id="specifics-2" href="#specifics-2" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-2"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_agents</code></td></tr><tr><td>Required scopes</td><td><code>agents--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-3" href="#request-3" class="reference css-180507a"><a href="/docs/management/configuration-api#request-3"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>filters</code></td><td>No</td><td><code>object</code></td><td>Possible request filters</td></tr><tr><td><code>filters.group_ids</code></td><td>No</td><td><code>int[]</code></td><td>IDs of the groups from which you want to list Agents. You'll only get the Agents from the specified group(s).</td></tr><tr><td><code>filters.suspended</code></td><td>No</td><td><code>bool</code></td><td>If provided, returns only those Agents who have the same <code>suspended</code> field value.</td></tr><tr><td><code>fields</code><sup><strong>1</strong></sup></td><td>No</td><td><code>string[]</code></td><td>Additional Agent fields to include.</td></tr></tbody></table></div><p><strong>1)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>groups</code></td><td>Groups an Agent belongs to</td></tr><tr><td><code>work_scheduler</code></td><td>Work scheduler object for an Agent. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>email_subscriptions</code></td><td>A list of the Agent's active email subscriptions</td></tr><tr><td><code>notifications</code></td><td>A list of the Agent's enabled notifications</td></tr><tr><td><code>job_title</code></td><td>Agent's job title</td></tr><tr><td><code>mobile</code></td><td>Agent's mobile number</td></tr><tr><td><code>max_chats_count</code></td><td>Agent's maximum number of concurrent chats</td></tr><tr><td><code>suspended</code></td><td>Boolean value indicating if an Agent is suspended</td></tr><tr><td><code>awaiting_approval</code></td><td>Boolean value indicating if an Agent is awaiting approval</td></tr><tr><td><code>last_logout</code></td><td>RFC 3339 date-time of the last logout of an Agent (omitted when no logout occurred)</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_agents <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "fields": [ "email_subscriptions", "max_chats_count", "job_title", "last_logout" ], "filters": { "group_ids": [ 0, 1 ] } }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "avatar_path": "cdn.livechatinc.com/avatars/1.png", "id": "smith@example.com", "account_id": "d24fa41e-bc16-41b8-a15b-9ca45ff7e0cf", "job_title": "Support Hero", "login_status": "not accepting chats", "name": "Smith", "role": "owner", "max_chats_count": 5, "summaries": [ "daily_summary", "weekly_summary" ] }, { "avatar_path": "cdn.livechatinc.com/avatars/2.png", "id": "jones@example.com", "account_id": "2fca3315-f6b2-422f-8550-c84b649cef1a", "job_title": "Support Hero (Newbie)", "login_status": "accepting chats", "last_logout": "2022-08-23T14:31:21.000000Z", "name": "Jones", "role": "viceowner", "max_chats_count": 2, "summaries": [ "weekly_summary" ] } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-agent" href="#update-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#update-agent"><span class="icon icon-link"></span></a>Update Agent</a></h4><p>Updates the properties of an Agent specified by <code>id</code>.</p><h5 class="heading"><a id="specifics-3" href="#specifics-3" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-3"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--my:rw</code> <code>agents--all:rw</code><sup><strong>1</strong></sup> <code>accounts.roles.lc--all:rw</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> to update other agents within the same license<br/> <strong>2)</strong> to update the agent <code>role</code></p><h5 class="heading"><a id="request-4" href="#request-4" class="reference css-180507a"><a href="/docs/management/configuration-api#request-4"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>string</code></td><td>Yes</td><td>Agent ID</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>No</td><td>Agent name</td></tr><tr><td><code>role</code></td><td><code>string</code></td><td>No</td><td>Agent role, should be one of the following: <code>viceowner</code>, <code>administrator</code>, <code>normal</code></td></tr><tr><td><code>avatar</code></td><td><code>string</code></td><td>No</td><td>Avatar URL</td></tr><tr><td><code>login_status</code></td><td><code>string</code></td><td>No</td><td>Agent's default status right after the login, should be one of the following: <code>accepting chats</code>, <code>not accepting chats</code> (default).</td></tr><tr><td><code>job_title</code></td><td><code>string</code></td><td>No</td><td>Agent's job title</td></tr><tr><td><code>mobile</code></td><td><code>string</code></td><td>No</td><td>Agent's mobile number</td></tr><tr><td><code>max_chats_count</code></td><td><code>int</code></td><td>No</td><td>Agent's maximum number of concurrent. Limited to 20. chats</td></tr><tr><td><code>groups</code></td><td><code>object[]</code></td><td>No</td><td>Groups an Agent belongs to.</td></tr><tr><td><code>groups[].id</code></td><td><code>uint</code></td><td>Yes</td><td>Group ID; required only when <code>group</code>'s included.</td></tr><tr><td><code>groups[].priority</code> <sup><strong>3</strong></sup></td><td><code>string</code></td><td>Yes</td><td>Agent's priority in a group; required only when <code>group</code>'s included.</td></tr><tr><td><code>notifications</code><sup><strong>4</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Represents which Agent notifications are turned on.</td></tr><tr><td><code>email_subscriptions</code><sup><strong>5</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Represents which subscriptions will be send to an Agent via email.</td></tr><tr><td><code>work_scheduler</code></td><td><code>object</code></td><td>No</td><td>Work scheduler options to set for an Agent. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr></tbody></table></div><p><strong>3)</strong> Possible values for the <code>groups[].priority</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Agents with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Agents with the <code>normal</code> priority get chats before those with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Agents with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Agents with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><p><strong>4)</strong> Possible values for the <code>notifications</code> array:</p><ul><li><code>new_visitor</code></li><li><code>incoming_chat</code></li><li><code>returning_visitor</code></li><li><code>queued_visitor</code></li><li><code>visitor_is_typing</code></li><li><code>new_goal</code></li><li><code>unassigned_chats</code></li><li><code>unassigned_chat_messages</code></li><li><code>ticket</code></li><li><code>inactive_notifications</code></li><li><code>mute_all_sounds</code></li><li><code>repeat_sound_notifications</code></li><li><code>ticket_notifications</code></li><li><code>incoming_message_for_focused_chat</code></li></ul><p><strong>5)</strong> Possible values for the <code>email_subscriptions</code> array:</p><ul><li><code>daily_summary</code></li><li><code>weekly_summary</code></li></ul><h5 class="heading"><a id="response-1" href="#response-1" class="reference css-180507a"><a href="/docs/management/configuration-api#response-1"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com", "name": "Agent Smith", "role": "viceowner", "groups": [ { "id": 5, "priority": "first" }, { "id": 2, "priority": "last" }, { "id": 1, "priority": "normal" } ], "work_scheduler": { "monday": { "start": "08:30", "end": "12:30" }, "friday": { "start": "07:30", "end": "21:30" } }, "notifications": [ "new_visitor", "new_goal", "visitor_is_typing" ], "email_subscriptions": [ "weekly_summary" ] }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-agent" href="#delete-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-agent"><span class="icon icon-link"></span></a>Delete Agent</a></h4><p>Deletes an Agent specified by <code>id</code>.</p><h5 class="heading"><a id="specifics-4" href="#specifics-4" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-4"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--my:rw</code> <code>accounts--my:rw</code> <code>agents--all:rw</code> <sup><strong>1</strong></sup> <code>accounts--all:rw</code> <sup><strong>1</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> to delete other agents within the same license</p><h5 class="heading"><a id="request-5" href="#request-5" class="reference css-180507a"><a href="/docs/management/configuration-api#request-5"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Agent ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-2" href="#response-2" class="reference css-180507a"><a href="/docs/management/configuration-api#response-2"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="suspend-agent" href="#suspend-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#suspend-agent"><span class="icon icon-link"></span></a>Suspend Agent</a></h4><p>Suspends an Agent specified by <code>id</code>.</p><p>❗️ This method is not yet available for public use. For now, an agent can only be approved via the LiveChat Agent application UI. We would love to hear how you'd like to use this method -- please send us an email at <a href="mailto:developers@text.com">developers@text.com</a> describing your use case.</p><h5 class="heading"><a id="specifics-5" href="#specifics-5" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-5"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/suspend_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--all:rw</code> <code>sessions--all:rw</code><sup>1</sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> <code>sessions--all:rw</code> is a private scope; it's not possible to configure it in Developer Console.</p><h5 class="heading"><a id="request-6" href="#request-6" class="reference css-180507a"><a href="/docs/management/configuration-api#request-6"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Agent ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-3" href="#response-3" class="reference css-180507a"><a href="/docs/management/configuration-api#response-3"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/suspend_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="unsuspend-agent" href="#unsuspend-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#unsuspend-agent"><span class="icon icon-link"></span></a>Unsuspend Agent</a></h4><p>Unsuspends an Agent specified by <code>id</code>.</p><p>❗️ This method is not yet available for public use. For now, an agent can only be approved via the LiveChat Agent application UI. We would love to hear how you'd like to use this method -- please send us an email at <a href="mailto:developers@text.com">developers@text.com</a> describing your use case.</p><h5 class="heading"><a id="specifics-6" href="#specifics-6" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-6"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/unsuspend_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--all:rw</code> <code>accounts--all:rw</code> <code>subscription.lc:rw</code><sup>1</sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> <code>subscription.lc:rw</code> is a private scope; it's not possible to configure it in Developer Console.</p><h5 class="heading"><a id="request-7" href="#request-7" class="reference css-180507a"><a href="/docs/management/configuration-api#request-7"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Agent ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-4" href="#response-4" class="reference css-180507a"><a href="/docs/management/configuration-api#response-4"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/unsuspend_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="request-agent-unsuspension" href="#request-agent-unsuspension" class="reference css-180507a"><a href="/docs/management/configuration-api#request-agent-unsuspension"><span class="icon icon-link"></span></a>Request Agent Unsuspension</a></h4><p>A suspended Agent can send emails to license owners and vice owners with an unsuspension request.</p><h5 class="heading"><a id="specifics-7" href="#specifics-7" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-7"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/request_agent_unsuspension</code></td></tr><tr><td>Required scopes</td><td>-</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><h5 class="heading"><a id="request-8" href="#request-8" class="reference css-180507a"><a href="/docs/management/configuration-api#request-8"><span class="icon icon-link"></span></a>Request</a></h5><p>Empty request payload.</p><h5 class="heading"><a id="response-5" href="#response-5" class="reference css-180507a"><a href="/docs/management/configuration-api#response-5"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/request_agent_unsuspension <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="approve-agent" href="#approve-agent" class="reference css-180507a"><a href="/docs/management/configuration-api#approve-agent"><span class="icon icon-link"></span></a>Approve Agent</a></h4><p>Approves an Agent thus allowing the Agent to use the application.</p><p>❗️ This method is not yet available for public use. For now, an agent can only be approved via the LiveChat Agent application UI. We would love to hear how you'd like to use this method -- please send us an email at <a href="mailto:developers@text.com">developers@text.com</a> describing your use case.</p><h5 class="heading"><a id="specifics-8" href="#specifics-8" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-8"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/approve_agent</code></td></tr><tr><td>Required scopes</td><td><code>agents--all:rw</code> <code>accounts--all:rw</code> <code>subscription.lc:rw</code> <sup><strong>1</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><p><strong>1)</strong> <code>subscription.lc:rw</code> is a private scope; it's not possible to configure it in Developer Console.</p><h5 class="heading"><a id="request-9" href="#request-9" class="reference css-180507a"><a href="/docs/management/configuration-api#request-9"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Agent ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-6" href="#response-6" class="reference css-180507a"><a href="/docs/management/configuration-api#response-6"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/approve_agent <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "smith@example.com" }'</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="auto-access" href="#auto-access" class="reference css-180507a"><a href="/docs/management/configuration-api#auto-access"><span class="icon icon-link"></span></a>Auto access</a></h2><p><strong>Auto access</strong> allows you to assign groups to a thread that will be created when a customer starts a chat. Those groups are assigned based on the conditions defined to match the customer's geolocation and the page URL the customer is currently visiting. Every time a customer calls <a href="/docs/messaging/customer-chat-api/v3.5/rtm-reference#login"><strong>Login</strong></a> or <a href="/docs/messaging/customer-chat-api/v3.5/rtm-reference#update-customer-page"><strong>Update Customer Page</strong></a>, our backend checks if the page URL and geolocation match the pre-defined conditions. Given there's a match, the groups are assigned to a thread, but not until a chat starts and the thread is actually created.</p><p>If a customer starts a chat via <a href="/docs/messaging/customer-chat-api/v3.5/rtm-reference#start-chat"><strong>Start Chat</strong></a> or <a href="/docs/messaging/customer-chat-api/v3.5/rtm-reference#activate-chat"><strong>Activate Chat</strong></a> with the <code>chat.access</code> parameter, <code>chat.access</code> overrides the auto access assigned to the thread.</p><p>Auto access rules are ordered using a linked list. Each of them points to the next element by keeping its <code>id</code> in the <code>next_id</code> field. For the last element of the list, the <code>next_id</code> is empty.</p><h3 class="heading"><a id="methods-2" href="#methods-2" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-2"><span class="icon icon-link"></span></a>Methods</a></h3><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="add-auto-access" href="#add-auto-access" class="reference css-180507a"><a href="/docs/management/configuration-api#add-auto-access"><span class="icon icon-link"></span></a>Add Auto Access</a></h4><p>Creates an <code>auto access</code> data structure, which is a set of conditions for the tracking URL and geolocation of a customer.</p><h5 class="heading"><a id="specifics-9" href="#specifics-9" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-9"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/add_auto_access</code></td></tr><tr><td>Required scopes</td><td><code>access_rules:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>access</code></td><td>Yes</td><td><code>object</code></td><td>Destination access</td></tr><tr><td><code>access.groups</code></td><td>Yes</td><td><code>[]int</code></td><td>Destination groups</td></tr><tr><td><code>conditions</code><sup><strong>1</strong></sup></td><td>Yes</td><td><code>object</code></td><td>Conditions to check</td></tr><tr><td><code>conditions.url</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on <code>customer_page.url</code> from <strong>Login</strong> or <code>url</code> from <strong>Update Customer Page</strong></td></tr><tr><td><code>conditions.domain</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on the domain of the <code>customer_url</code></td></tr><tr><td><code>conditions.{url,domain}.values</code></td><td>No</td><td><code>[]match_object</code><sup><strong>2</strong></sup></td><td>Positive match, may not be used together with <code>exclude_values</code></td></tr><tr><td><code>conditions.{url,domain}.exclude_values</code></td><td>No</td><td><code>[]match_object</code></td><td>Negative match</td></tr><tr><td><code>conditions.geolocation</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on the customer's geolocation</td></tr><tr><td><code>conditions.geolocation.values</code></td><td>Yes</td><td><code>[]geolocation_object</code><sup><strong>3</strong></sup></td><td>An array of objects; matches when at least one subcondition matches.</td></tr><tr><td><code>description</code></td><td>No</td><td><code>string</code></td><td>Description of the auto access</td></tr><tr><td><code>next_id</code></td><td>No</td><td><code>string</code></td><td>ID of an existing auto access. Leave empty if the new auto access should be the last one on the list.</td></tr></tbody></table></div><p><strong>1)</strong> <code>conditions</code> must have at least one of <code>url</code>, <code>domain</code>, <code>geolocation</code> set.</p><p><strong>2)</strong> <code><match_object></code> structure:</p><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>value</code></td><td>Yes</td><td><code>string</code></td><td>A value to match</td></tr><tr><td><code>exact_match</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>false</code>, a <code>match_object.value</code> will be matched as a substring of the customer URL or domain.</td></tr></tbody></table></div><p><strong>3)</strong> the <code>geolocation_object</code> structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified.</p><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td><code>country</code></td><td>No</td><td><code>string</code></td><td>"United States"</td></tr><tr><td><code>country_code</code></td><td>No</td><td><code>string</code></td><td>"US"</td></tr><tr><td><code>region</code></td><td>No</td><td><code>string</code></td><td>"California"</td></tr><tr><td><code>city</code></td><td>No</td><td><code>string</code></td><td>"Mountain View"</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/add_auto_access <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "description": "Chats on livechat.com from United States", "access": { "groups": [ 1 ] }, "conditions": { "domain": { "values": [ { "value": "livechat.com", "exact_match": true } ] }, "geolocation": { "values": [ { "country": "United States", "country_code": "US" } ] } }, "next_id": "1faad6f5f1d6e8fdf27e8af9839783b7" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"pqi8oasdjahuakndw9nsad9na"</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-auto-accesses" href="#list-auto-accesses" class="reference css-180507a"><a href="/docs/management/configuration-api#list-auto-accesses"><span class="icon icon-link"></span></a>List Auto Accesses</a></h4><p>Returns all existing <code>auto access</code> data structures.</p><h5 class="heading"><a id="specifics-10" href="#specifics-10" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-10"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_auto_accesses</code></td></tr><tr><td>Required scopes</td><td><code>access_rules:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_auto_accesses <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"id"</span><span class="token operator">:</span> <span class="token string">"1faad6f5f1d6e8fdf27e8af9839783b7"</span><span class="token punctuation">,</span> <span class="token property">"description"</span><span class="token operator">:</span> <span class="token string">"Chats on livechat.com from United States"</span><span class="token punctuation">,</span> <span class="token property">"access"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"groups"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token number">0</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"conditions"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"geolocation"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"country"</span><span class="token operator">:</span> <span class="token string">"United States"</span><span class="token punctuation">,</span> <span class="token property">"country_code"</span><span class="token operator">:</span> <span class="token string">"US"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"domain"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"values"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token punctuation">{</span> <span class="token property">"value"</span><span class="token operator">:</span> <span class="token string">"livechat.com"</span><span class="token punctuation">,</span> <span class="token property">"exact_match"</span><span class="token operator">:</span> <span class="token boolean">true</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"next_id"</span><span class="token operator">:</span> <span class="token string">"pqi8oasdjahuakndw9nsad9na"</span> <span class="token punctuation">}</span> <span class="token punctuation">]</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-auto-access" href="#delete-auto-access" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-auto-access"><span class="icon icon-link"></span></a>Delete Auto Access</a></h4><p>Deletes an existing <code>auto access</code> data structure specified by its ID.</p><h5 class="heading"><a id="specifics-11" href="#specifics-11" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-11"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_auto_access</code></td></tr><tr><td>Required scopes</td><td><code>access_rules:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Auto access ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-7" href="#response-7" class="reference css-180507a"><a href="/docs/management/configuration-api#response-7"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_auto_access <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "pqi8oasdjahuakndw9nsad9na" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-auto-access" href="#update-auto-access" class="reference css-180507a"><a href="/docs/management/configuration-api#update-auto-access"><span class="icon icon-link"></span></a>Update Auto Access</a></h4><p>Updates an existing <code>auto access</code>. Only specified fields are updated (overwritten), leaving unspecified fields unchanged.</p><h5 class="heading"><a id="specifics-12" href="#specifics-12" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-12"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_auto_access</code></td></tr><tr><td>Required scopes</td><td><code>access_rules:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>ID of the auto access to modify</td></tr><tr><td><code>access</code></td><td>No</td><td><code>object</code></td><td>Destination access</td></tr><tr><td><code>access.groups</code></td><td>Yes</td><td><code>[]int</code></td><td>Destination groups</td></tr><tr><td><code>conditions</code><sup><strong>1</strong></sup></td><td>No</td><td><code>object</code></td><td>Conditions to check</td></tr><tr><td><code>conditions.url</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on <code>customer_page.url</code> from <strong>Login</strong> or <code>url</code> from <strong>Update Customer Page</strong></td></tr><tr><td><code>conditions.domain</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on the domain of the <code>customer_url</code></td></tr><tr><td><code>conditions.{url,domain}.values</code></td><td>No</td><td><code>[]match_object</code><sup><strong>2</strong></sup></td><td>Positive match, may not be used together with <code>exclude_values</code></td></tr><tr><td><code>conditions.{url,domain}.exclude_values</code></td><td>No</td><td><code>[]match_object</code></td><td>Negative match</td></tr><tr><td><code>conditions.geolocation</code></td><td>No</td><td><code>object</code></td><td>The condition that matches on the customer's geolocation</td></tr><tr><td><code>conditions.geolocation.values</code></td><td>Yes</td><td><code>[]geolocation_object</code><sup><strong>3</strong></sup></td><td>An array of objects; matches when at least one subcondition matches.</td></tr><tr><td><code>description</code></td><td>No</td><td><code>string</code></td><td>Description of the auto access</td></tr><tr><td><code>next_id</code><sup><strong>4</strong></sup></td><td>No</td><td><code>string</code></td><td>ID of an existing auto access. If <code>next_id</code> is an empty string, auto_access moves to the end of the list.</td></tr></tbody></table></div><p><strong>1)</strong> <code>conditions</code> must have at least one of <code>url</code>, <code>domain</code>, <code>geolocation</code> set.</p><p><strong>2)</strong> <code><match_object></code> structure:</p><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>value</code></td><td>Yes</td><td><code>string</code></td><td>A value to match</td></tr><tr><td><code>exact_match</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>false</code>, a <code>match_object.value</code> will be matched as a substring of the customer URL or domain; default: false.</td></tr></tbody></table></div><p><strong>3)</strong> the <code>geolocation_object</code> structure. The condition is fulfilled only when all of the specified fields match. At least one field must be specified.</p><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Example</th></tr></thead><tbody><tr><td><code>country</code></td><td>No</td><td><code>string</code></td><td>"United States"</td></tr><tr><td><code>country_code</code></td><td>No</td><td><code>string</code></td><td>"US"</td></tr><tr><td><code>region</code></td><td>No</td><td><code>string</code></td><td>"California"</td></tr><tr><td><code>city</code></td><td>No</td><td><code>string</code></td><td>"Mountain View"</td></tr></tbody></table></div><p><strong>4)</strong> Modifying <code>next_id</code> moves the auto access specified by <code>id</code> before the auto access that is specified by <code>next_id</code>. If <code>next_id</code> is an empty string, then auto access will be placed at the end of the list. If you don't intend to reorder the rule at all, don't include <code>next_id</code> in the request. To better understand it, analyze the example below.</p><p>💡 <strong>Example:</strong></p><p>In the following list: <strong>A -> B -> C -> D -> null</strong>, letters represent the <code>auto_access</code> data structures while arrows indicate the <code>next_id</code> relation. Therefore, A has <code>next_id</code> set to B, B has <code>next_id</code> set to C, and so on.</p><p>An <code>update_auto_access</code> call with the <code>{"id": "C", "next_id": "B"}</code> payload would result in reordering the sequence, which after the successful request, would look like this: <strong>A -> C -> B -> D -> null</strong>. Consistency is maintained by keeping the <code>next_id</code> references properly assigned in each of the elements after a single request.</p><h5 class="heading"><a id="response-8" href="#response-8" class="reference css-180507a"><a href="/docs/management/configuration-api#response-8"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_auto_access <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "pqi8oasdjahuakndw9nsad9na", "access": { "groups": [0, 42] }, "next_id": "1faad6f5f1d6e8fdf27e8af9839783b7" }'</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="bots" href="#bots" class="reference css-180507a"><a href="/docs/management/configuration-api#bots"><span class="icon icon-link"></span></a>Bots</a></h2><p>Bots enable writing integrations using the <a href="/docs/messaging/agent-chat-api"><strong>Agent Chat API</strong></a> to communicate in chats similarly to regular agents. Unlike agents, bots don't have passwords or emails - you cannot log in as a bot. Each bot is a resource owned by an application (<code>client_id</code>) in Developer Console.</p><p>There are two authorization mechanisms for bots:</p><ul><li>old (v3.5 and lower): a bot shares the access token with the agent who created it. To make calls as a bot, you need to provide the <a href="/docs/authorization/agent-authorization">agent token</a> and the <code>X-Author-Id</code> header.</li><li>new (v3.5 and higher): bots use their own authorization tokens generated with the <a href="/docs/management/configuration-api#issue-bot-token">Issue Bot Token</a> method.</li></ul><h3 class="heading"><a id="methods-3" href="#methods-3" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-3"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Bots API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th align="center">Value</th><th align="right"></th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td align="center"><code>application/json</code></td><td align="right"></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="create-bot-template" href="#create-bot-template" class="reference css-180507a"><a href="/docs/management/configuration-api#create-bot-template"><span class="icon icon-link"></span></a>Create Bot Template</a></h4><p>Creates a new bot template for the Client ID (application) provided in the request. One Client ID can register up to five bot templates.</p><p>A bot based on a template will be automatically created on the license when the application is installed. Such a bot will have the same ID as the bot template. If the application is already installed on the license, the bot will be created only if <code>affect_existing_installations</code> is set to <code>true</code>.</p><p>Bots based on templates will work in the same way as those created by the <a href="/docs/management/configuration-api#create-bot">Create Bot</a> method.</p><h5 class="heading"><a id="specifics-13" href="#specifics-13" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-13"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/create_bot_template</code></td></tr><tr><td>Required scopes</td><td><code>bots.templates:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-10" href="#request-10" class="reference css-180507a"><a href="/docs/management/configuration-api#request-10"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>Yes</td><td><code>string</code></td><td>Display name</td></tr><tr><td><code>avatar</code></td><td>No</td><td><code>string</code></td><td>Avatar URL</td></tr><tr><td><code>max_chats_count</code></td><td>No</td><td><code>int</code></td><td>Max. number of incoming chats that can be routed to the bot; default: 6. Limited to 500.</td></tr><tr><td><code>default_group_priority</code><sup><strong>1</strong></sup></td><td>No</td><td><code>string</code></td><td>The default routing priority for a group without defined priority.</td></tr><tr><td><code>job_title</code></td><td>No</td><td><code>string</code></td><td>Bot's job title</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that will own the bot template; must be owned by your organization.</td></tr><tr><td><code>affect_existing_installations</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>true</code>, a bot based on this template will be created on all licenses that have given application installed. Otherwise only new installations will trigger bot creation.</td></tr></tbody></table></div><p><strong>1)</strong> Possible priority values:</p><div class="css-q76ucn"><table><thead><tr><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Bots with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Bots with the <code>normal</code> priority get chats before agents with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Bots with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Bots with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/create_bot_template <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "Bot Name" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "5c9871d5372c824cbf22d860a707a578", "secret": "641e2ae6d997d2009a3ac92a05f37fc3" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="create-bot" href="#create-bot" class="reference css-180507a"><a href="/docs/management/configuration-api#create-bot"><span class="icon icon-link"></span></a>Create Bot</a></h4><p>Creates a new bot. To make the bot available for receiving chats or webhooks, use the <a href="/docs/messaging/agent-chat-api/v3.5#set-routing-status">Set Routing Status</a> method.</p><h5 class="heading"><a id="specifics-14" href="#specifics-14" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-14"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/create_bot</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><h5 class="heading"><a id="request-11" href="#request-11" class="reference css-180507a"><a href="/docs/management/configuration-api#request-11"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>Yes</td><td><code>string</code></td><td>Display name</td></tr><tr><td><code>avatar</code></td><td>No</td><td><code>string</code></td><td>Avatar URL</td></tr><tr><td><code>max_chats_count</code></td><td>No</td><td><code>int</code></td><td>Max. number of incoming chats that can be routed to the Bot; default: 6. Limited to 500.</td></tr><tr><td><code>default_group_priority</code><sup><strong>1</strong></sup></td><td>No</td><td><code>string</code></td><td>The default routing priority for a group without defined priority.</td></tr><tr><td><code>job_title</code></td><td>No</td><td><code>string</code></td><td>Bot's job title</td></tr><tr><td><code>groups</code></td><td>No</td><td><code>object[]</code></td><td>Groups the Bot belongs to.</td></tr><tr><td><code>groups[].id</code></td><td>No</td><td><code>int</code></td><td>Group ID; required only when <code>group</code>'s included.</td></tr><tr><td><code>groups[].priority</code><sup><strong>1</strong></sup></td><td>Yes</td><td><code>string</code></td><td>Bot's priority in a group; required only when <code>group</code>'s included.</td></tr><tr><td><code>work_scheduler</code></td><td>No</td><td><code>object</code></td><td>Work scheduler options to set for the new Bot. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>work_scheduler.timezone</code></td><td>Yes</td><td><code>string</code></td><td>The time zone in which the Bot's work scheduler should operate.</td></tr><tr><td><code>owner_client_id</code><sup><strong>2</strong></sup></td><td>Yes</td><td><code>string</code></td><td>Required only when authorizing via <a href="/docs/authorization/agent-authorization#personal-access-tokens">PATs</a>. When you provide this param while authorizing with a Bearer Token, the <code>client_id</code> associated with the Bearer Token will be ignored, and provided <code>owner_client_id</code> will be used instead.</td></tr></tbody></table></div><p><strong>1)</strong> Possible priority values:</p><div class="css-q76ucn"><table><thead><tr><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Bots with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Bots with the <code>normal</code> priority get chats before agents with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Bots with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Bots with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><p><strong>2)</strong> The number of sent webhooks depends on the number of webhooks registered for an <code>owner_client_id</code>, not the number of bots belonging to that <code>owner_client_id</code>.</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/create_bot <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "Bot Name" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "5c9871d5372c824cbf22d860a707a578", "secret": "641e2ae6d997d2009a3ac92a05f37fc3" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-bot-template" href="#delete-bot-template" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-bot-template"><span class="icon icon-link"></span></a>Delete Bot Template</a></h4><p>Deletes a bot template specified by <code>id</code>. The bots associated with the template will be deleted only if <code>affect_existing_installations</code> is set to <code>true</code>.</p><h5 class="heading"><a id="specifics-15" href="#specifics-15" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-15"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_bot_template</code></td></tr><tr><td>Required scopes</td><td><code>bots.templates:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-12" href="#request-12" class="reference css-180507a"><a href="/docs/management/configuration-api#request-12"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot Template ID</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the bot template; must be owned by your organization.</td></tr><tr><td><code>affect_existing_installations</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>true</code>, a bot based on this template will be deleted from all licenses that have given application installed.</td></tr></tbody></table></div><h5 class="heading"><a id="response-9" href="#response-9" class="reference css-180507a"><a href="/docs/management/configuration-api#response-9"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_bot_template <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "505591fc9fc2d6e92798bed7d9d8f079" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-bot" href="#delete-bot" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-bot"><span class="icon icon-link"></span></a>Delete Bot</a></h4><p>Deletes a bot specified by <code>id</code>.</p><h5 class="heading"><a id="specifics-16" href="#specifics-16" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-16"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_bot</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:rw</code> <code>agents-bot--all:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><h5 class="heading"><a id="request-13" href="#request-13" class="reference css-180507a"><a href="/docs/management/configuration-api#request-13"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-10" href="#response-10" class="reference css-180507a"><a href="/docs/management/configuration-api#response-10"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_bot <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "505591fc9fc2d6e92798bed7d9d8f079" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-bot-template" href="#update-bot-template" class="reference css-180507a"><a href="/docs/management/configuration-api#update-bot-template"><span class="icon icon-link"></span></a>Update Bot Template</a></h4><p>Updates an existing bot template.</p><h5 class="heading"><a id="specifics-17" href="#specifics-17" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-17"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_bot_template</code></td></tr><tr><td>Required scopes</td><td><code>bots.templates:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-14" href="#request-14" class="reference css-180507a"><a href="/docs/management/configuration-api#request-14"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot Template ID</td></tr><tr><td><code>name</code></td><td>No</td><td><code>string</code></td><td>Display name</td></tr><tr><td><code>avatar</code></td><td>No</td><td><code>string</code></td><td>Avatar URL</td></tr><tr><td><code>max_chats_count</code></td><td>No</td><td><code>int</code></td><td>Maximum incoming chats that can be routed to the Bot. Limited to 500.</td></tr><tr><td><code>default_group_priority</code><sup><strong>1</strong></sup></td><td>No</td><td><code>string</code></td><td>The default routing priority for a group without defined priority.</td></tr><tr><td><code>job_title</code></td><td>No</td><td><code>string</code></td><td>Bot's job title</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the bot template; must be owned by your organization.</td></tr><tr><td><code>affect_existing_installations</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>true</code>, bots based on this template will be updated on all licenses that have given application installed.</td></tr></tbody></table></div><p><strong>1)</strong> Possible priority values:</p><div class="css-q76ucn"><table><thead><tr><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Bots with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Bots with the <code>normal</code> priority get chats before agents with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Bots with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Bots with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><h5 class="heading"><a id="response-11" href="#response-11" class="reference css-180507a"><a href="/docs/management/configuration-api#response-11"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_bot_template <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "ce54714e3d2b53adbfff09dbdbdd56e9", "name": "New Bot Name" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-bot" href="#update-bot" class="reference css-180507a"><a href="/docs/management/configuration-api#update-bot"><span class="icon icon-link"></span></a>Update Bot</a></h4><p>Updates an existing Bot.</p><h5 class="heading"><a id="specifics-18" href="#specifics-18" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-18"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_bot</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:rw</code> <code>agents-bot--all:rw</code> (to update other Bots within the same license)</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>Yes</td></tr></tbody></table></div><h5 class="heading"><a id="request-15" href="#request-15" class="reference css-180507a"><a href="/docs/management/configuration-api#request-15"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot ID</td></tr><tr><td><code>name</code></td><td>No</td><td><code>string</code></td><td>Display name</td></tr><tr><td><code>avatar</code></td><td>No</td><td><code>string</code></td><td>Avatar URL</td></tr><tr><td><code>max_chats_count</code></td><td>No</td><td><code>int</code></td><td>Maximum incoming chats that can be routed to the Bot. Limited to 500.</td></tr><tr><td><code>groups</code></td><td>No</td><td><code>object[]</code></td><td>Groups the Bot belongs to</td></tr><tr><td><code>groups[].id</code></td><td>Yes</td><td><code>uint</code></td><td>Group ID, required only when <code>groups</code>'s present.</td></tr><tr><td><code>groups[].priority</code><sup><strong>1</strong></sup></td><td>Yes</td><td><code>string</code></td><td>Bot's priority in the group; required only when <code>groups</code> is included.</td></tr><tr><td><code>default_group_priority</code><sup><strong>1</strong></sup></td><td>No</td><td><code>string</code></td><td>The default routing priority for a group without defined priority.</td></tr><tr><td><code>work_scheduler</code></td><td>No</td><td><code>object</code></td><td>Work scheduler options to set for the new Bot. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>work_scheduler.timezone</code></td><td>Yes</td><td><code>string</code></td><td>The time zone in which the Bot's work scheduler should operate.</td></tr></tbody></table></div><p><strong>1)</strong> Possible priority values:</p><div class="css-q76ucn"><table><thead><tr><th>Value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Bots with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents. Corresponds to the <strong>Bot</strong> priority option in the LiveChat App.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Bots with the <code>normal</code> priority get chats before agents with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group. Corresponds to the <strong>Primary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Bots with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group. Corresponds to the <strong>Secondary</strong> priority option in the LiveChat App.</td></tr><tr><td><code>supervisor</code></td><td>Bots with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><h5 class="heading"><a id="response-12" href="#response-12" class="reference css-180507a"><a href="/docs/management/configuration-api#response-12"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_bot <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "ce54714e3d2b53adbfff09dbdbdd56e9", "name": "New Bot Name" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-bot-templates" href="#list-bot-templates" class="reference css-180507a"><a href="/docs/management/configuration-api#list-bot-templates"><span class="icon icon-link"></span></a>List Bot Templates</a></h4><p>Returns the list of bot templates created for a Client ID (application).</p><h5 class="heading"><a id="specifics-19" href="#specifics-19" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-19"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_bot_templates</code></td></tr><tr><td>Required scopes</td><td><code>bots.templates:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-16" href="#request-16" class="reference css-180507a"><a href="/docs/management/configuration-api#request-16"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the bot templates to list; must be owned by your organization.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_bot_templates <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "id": "2c1b8da190222160e8f9e077af4c625b", "name": "Bot Name", "avatar": "example.com/avatar.jpg" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-bots" href="#list-bots" class="reference css-180507a"><a href="/docs/management/configuration-api#list-bots"><span class="icon icon-link"></span></a>List Bots</a></h4><p>Returns the list of Bots created within a license. The method behavior differs depending on who created the Bot and what authorization method is used for the call.</p><h5 class="heading"><a id="specifics-20" href="#specifics-20" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-20"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_bots</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:ro</code> <code>agents-bot--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-17" href="#request-17" class="reference css-180507a"><a href="/docs/management/configuration-api#request-17"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>all</code></td><td>No</td><td><code>bool</code></td><td><code>true</code> - gets all Bots within a license.  <code>false</code> (default)<sup><strong>1</strong></sup> - returns only the requester's Bots.</td></tr><tr><td><code>fields</code><sup><strong>2</strong></sup></td><td>No</td><td><code>string[]</code></td><td>Additional Bot fields to include</td></tr></tbody></table></div><p><strong>1)</strong> Calling List Bots with <code>all:false</code></p><ul><li>If a Bot was created via an app, all Agents who make the request via this app will get the Bot in the response.</li><li>If a Bot was created directly by an Agent (<a href="/docs/authorization/agent-authorization#personal-access-tokens">PAT authorization</a>), all Agents who authorize with PATs will get the Bot in the response.</li></ul><p><strong>2)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>groups</code></td><td>Groups a Bot belongs to</td></tr><tr><td><code>work_scheduler</code></td><td>Work scheduler object for a Bot. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>job_title</code></td><td>Bot's job title</td></tr><tr><td><code>max_chats_count</code></td><td>Bot's maximum number of concurrent chats</td></tr><tr><td><code>timezone</code></td><td>The time zone in which the Bot's work scheduler operates</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_bots <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "all": false }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "id": "2c1b8da190222160e8f9e077af4c625b", "name": "Bot Name", "avatar": "example.com/avatar.jpg" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="get-bot" href="#get-bot" class="reference css-180507a"><a href="/docs/management/configuration-api#get-bot"><span class="icon icon-link"></span></a>Get Bot</a></h4><p>It returns the info about a bot with a given <code>id</code>.</p><h5 class="heading"><a id="specifics-21" href="#specifics-21" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-21"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/get_bot</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:ro</code> <code>agents-bot--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-18" href="#request-18" class="reference css-180507a"><a href="/docs/management/configuration-api#request-18"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot ID</td></tr><tr><td><code>fields</code><sup><strong>1</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Additional fields to include.</td></tr></tbody></table></div><p><strong>1)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>work_scheduler</code></td><td>Work scheduler object for a Bot. See <a href="/docs/management/configuration-api#create-agent"><strong>Create Agent</strong></a> for details.</td></tr><tr><td><code>groups</code></td><td>Groups a Bot belongs to</td></tr><tr><td><code>job_title</code></td><td>Bot's job title</td></tr><tr><td><code>max_chats_count</code></td><td>Bot's maximum number of concurrent chats</td></tr><tr><td><code>timezone</code></td><td>The time zone in which the Bot's work scheduler operates</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/get_bot <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "5c9871d5372c824cbf22d860a707a578" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "5c9871d5372c824cbf22d860a707a578", "name": "John Doe", "avatar": "https://example.com/avatar.jpg", "default_group_priority": "first", "owner_client_id": "asXdesldiAJSq9padj", "max_chats_count": 6, "groups": [ { "id": 0, "priority": "normal" }, { "id": 1, "priority": "normal" }, { "id": 2, "priority": "first" } ] }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="issue-bot-token" href="#issue-bot-token" class="reference css-180507a"><a href="/docs/management/configuration-api#issue-bot-token"><span class="icon icon-link"></span></a>Issue Bot Token</a></h4><p>Issues a new token for the bot. The token is valid for 24 hours. The token cannot be revoked.</p><p>The token has the following scopes that allow chatting: <code>chats--access:rw</code>, <code>agents-bot--my:rw</code>, <code>customers:rw</code>.</p><p>The required <code>bot_secret</code> is returned in <a href="/docs/management/configuration-api#create-bot-template">Create Bot Template</a> and <a href="/docs/management/configuration-api#create-bot">Create Bot</a> methods. If you lost the secret, you can reset it using <a href="/docs/management/configuration-api#reset-bot-template-secret">Reset Bot Template Secret</a> or <a href="/docs/management/configuration-api#reset-bot-secret">Reset Bot Secret</a> methods.</p><h5 class="heading"><a id="specifics-22" href="#specifics-22" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-22"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/issue_bot_token</code></td></tr><tr><td>Required scopes</td><td>-</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-19" href="#request-19" class="reference css-180507a"><a href="/docs/management/configuration-api#request-19"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>bot_id</code></td><td>Yes</td><td><code>string</code></td><td>Bot ID</td></tr><tr><td><code>client_id</code></td><td>Yes</td><td><code>string</code></td><td>Client ID</td></tr><tr><td><code>bot_secret</code></td><td>Yes</td><td><code>string</code></td><td>Bot secret</td></tr><tr><td><code>organization_id</code></td><td>Yes</td><td><code>string</code></td><td>Organization ID</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/issue_bot_token <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "bot_id": "5c9871d5372c824cbf22d860a707a578", "client_id": "238ac5c3c3628210aca289c6d700d2c1", "bot_secret": "641e2ae6d997d2009a3ac92a05f37fc3", "organization_id": "1a8a9ec7-bd5d-4400-9204-3826740981e0" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "token": "<JWT Bot token>" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="reset-bot-template-secret" href="#reset-bot-template-secret" class="reference css-180507a"><a href="/docs/management/configuration-api#reset-bot-template-secret"><span class="icon icon-link"></span></a>Reset Bot Template Secret</a></h4><p>Resets secret for given bot template.</p><h5 class="heading"><a id="specifics-23" href="#specifics-23" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-23"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/reset_bot_template_secret</code></td></tr><tr><td>Required scopes</td><td><code>bots.templates:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-20" href="#request-20" class="reference css-180507a"><a href="/docs/management/configuration-api#request-20"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot template ID</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the bot template; must be owned by your organization.</td></tr><tr><td><code>affect_existing_installations</code></td><td>No</td><td><code>bool</code></td><td>If set to <code>true</code>, the new secret is set to for all existing bots based on this template.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/reset_bot_template_secret <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "5c9871d5372c824cbf22d860a707a578" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "secret": "641e2ae6d997d2009a3ac92a05f37fc3" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="reset-bot-secret" href="#reset-bot-secret" class="reference css-180507a"><a href="/docs/management/configuration-api#reset-bot-secret"><span class="icon icon-link"></span></a>Reset Bot Secret</a></h4><p>Resets secret for a given bot.</p><h5 class="heading"><a id="specifics-24" href="#specifics-24" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-24"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/reset_bot_secret</code></td></tr><tr><td>Required scopes</td><td><code>agents-bot--my:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-21" href="#request-21" class="reference css-180507a"><a href="/docs/management/configuration-api#request-21"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Bot ID</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td>Required only when authorizing via <a href="/docs/authorization/agent-authorization#personal-access-tokens">PATs</a>. When you provide this param while authorizing with a Bearer Token, the <code>client_id</code> associated with the Bearer Token will be ignored, and provided <code>owner_client_id</code> will be used instead.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/reset_bot_secret <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "5c9871d5372c824cbf22d860a707a578" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "secret": "641e2ae6d997d2009a3ac92a05f37fc3" }</code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="groups" href="#groups" class="reference css-180507a"><a href="/docs/management/configuration-api#groups"><span class="icon icon-link"></span></a>Groups</a></h2><p>Groups let you organize your work by creating teams with Agent and Bot members. You can use groups to do configuration based on shared settings (language, working hours, department) and to separate chat routing. It's worth mentioning that one Agent can belong to multiple groups at the same time. It's possible to configure routing priorities for Agents and Bots specifically per group.</p><h3 class="heading"><a id="methods-4" href="#methods-4" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-4"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Groups API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th>Value</th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td><code>application/json</code></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="create-group" href="#create-group" class="reference css-180507a"><a href="/docs/management/configuration-api#create-group"><span class="icon icon-link"></span></a>Create Group</a></h4><p>Creates a new group.</p><h5 class="heading"><a id="specifics-25" href="#specifics-25" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-25"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/create_group</code></td></tr><tr><td>Required scopes</td><td><code>groups--all:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-22" href="#request-22" class="reference css-180507a"><a href="/docs/management/configuration-api#request-22"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td><code>string</code></td><td>Yes</td><td>Group name (up to 180 chars)</td></tr><tr><td><code>language_code</code></td><td><code>string</code></td><td>No</td><td>The code of the group languange</td></tr><tr><td><code>agent_priorities</code><sup><strong>1</strong></sup></td><td><code>object</code></td><td>Yes</td><td>Agents' priorities in a group as a map in the <code>"<id>": "<priority>"</code> format. At least one Agent must have the <code>normal</code> priority.</td></tr></tbody></table></div><p><strong>1)</strong> The table below presents the possible values for the <code>agent_priorities</code> map:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Agents with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Agents with the <code>normal</code> priority get chats before those with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Agents with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group.</td></tr><tr><td><code>supervisor</code></td><td>Agents with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/create_group <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "Sports shoes", "agent_priorities": { "agent1@example.com": "normal", "agent2@example.com": "normal", "agent3@example.com": "last" } }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": 19 }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-group" href="#update-group" class="reference css-180507a"><a href="/docs/management/configuration-api#update-group"><span class="icon icon-link"></span></a>Update Group</a></h4><p>Updates an existing group.</p><h5 class="heading"><a id="specifics-26" href="#specifics-26" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-26"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_group</code></td></tr><tr><td>Required scopes</td><td><code>groups--my:rw</code> <code>groups--all:rw</code> (to update groups the requester is not a member of)</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-23" href="#request-23" class="reference css-180507a"><a href="/docs/management/configuration-api#request-23"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>int</code></td><td>Yes</td><td>Group ID</td></tr><tr><td><code>name</code></td><td><code>string</code></td><td>No</td><td>Group name (up to 180 chars)</td></tr><tr><td><code>language_code</code></td><td><code>string</code></td><td>No</td><td>The code of the group languange</td></tr><tr><td><code>agent_priorities</code><sup><strong>1</strong></sup></td><td><code>object</code></td><td>No</td><td>Agents' priorities in a group as a map in the <code>"<id>": "<priority>"</code> format.</td></tr></tbody></table></div><p><strong>1)</strong> The table below presents the possible values for the <code>agent_priorities</code> map:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>first</code></td><td>The highest chat routing priority. Agents with the <code>first</code> priority get chats before others from the same group, e.g. Bots can get chats before regular Agents.</td></tr><tr><td><code>normal</code></td><td>The medium chat routing priority. Agents with the <code>normal</code> priority get chats before those with the <code>last</code> priority, when there are no Agents with the <code>first</code> priority available with free slots in the group.</td></tr><tr><td><code>last</code></td><td>The lowest chat routing priority. Agents with the <code>last</code> priority get chats when there are no Agents with the <code>first</code> or <code>normal</code> priority available with free slots in the group.</td></tr><tr><td><code>supervisor</code></td><td>Agents with the <code>supervisor</code> priority will not get any chats assigned automatically.</td></tr></tbody></table></div><h5 class="heading"><a id="response-13" href="#response-13" class="reference css-180507a"><a href="/docs/management/configuration-api#response-13"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_group <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": 19, "name": "Sport shoes", "agent_priorities": { "agent1@example.com": "normal", "agent2@example.com": "normal", "agent3@example.com": "last" } }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-group" href="#delete-group" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-group"><span class="icon icon-link"></span></a>Delete Group</a></h4><p>Deletes an existing group.</p><h5 class="heading"><a id="specifics-27" href="#specifics-27" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-27"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_group</code></td></tr><tr><td>Required scopes</td><td><code>groups--my:rw</code> <code>groups--all:rw</code> (to delete groups the requester is not a member of)</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-24" href="#request-24" class="reference css-180507a"><a href="/docs/management/configuration-api#request-24"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>int</code></td><td>Yes</td><td>Group ID</td></tr></tbody></table></div><h5 class="heading"><a id="response-14" href="#response-14" class="reference css-180507a"><a href="/docs/management/configuration-api#response-14"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_group <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": 19 }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-groups" href="#list-groups" class="reference css-180507a"><a href="/docs/management/configuration-api#list-groups"><span class="icon icon-link"></span></a>List Groups</a></h4><p>Lists all the exisiting groups.</p><h5 class="heading"><a id="specifics-28" href="#specifics-28" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-28"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_groups</code></td></tr><tr><td>Required scopes</td><td><code>groups--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-25" href="#request-25" class="reference css-180507a"><a href="/docs/management/configuration-api#request-25"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>fields</code><sup><strong>1</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Additional fields to include.</td></tr></tbody></table></div><p><strong>1)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>agent_priorities</code></td><td>An object containing Agents belonging to a group, along with their priorities.</td></tr><tr><td><code>routing_status</code></td><td>The routing status of a group.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_groups <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "id": 0, "name": "General", "language_code": "en", "routing_status": "offline" }, { "id": 19, "name": "Sport shoes", "language_code": "en", "routing_status": "offline" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="get-group" href="#get-group" class="reference css-180507a"><a href="/docs/management/configuration-api#get-group"><span class="icon icon-link"></span></a>Get Group</a></h4><p>Returns details about a group specified by its <code>id</code>.</p><h5 class="heading"><a id="specifics-29" href="#specifics-29" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-29"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/get_group</code></td></tr><tr><td>Required scopes</td><td><code>groups--my:ro</code> <code>groups--all:ro</code> (to get groups the requester is not a member of)</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-26" href="#request-26" class="reference css-180507a"><a href="/docs/management/configuration-api#request-26"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Data type</th><th>Required</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td><code>int</code></td><td>Yes</td><td>Group ID</td></tr><tr><td><code>fields</code><sup><strong>1</strong></sup></td><td><code>string[]</code></td><td>No</td><td>Additional fields to include.</td></tr></tbody></table></div><p><strong>1)</strong> Possible values for the <code>fields[]</code> parameter:</p><div class="css-q76ucn"><table><thead><tr><th>Possible value</th><th>Notes</th></tr></thead><tbody><tr><td><code>agent_priorities</code></td><td>An object containing Agents belonging to a group, along with their priorities.</td></tr><tr><td><code>routing_status</code></td><td>The routing status of a group.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/get_group <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": 19, "fields": ["agent_priorities", "routing_status"] }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": 19, "name": "Sports shoes", "language_code": "en", "agent_priorities": { "agent1@example.com": "normal", "agent2@example.com": "normal", "agent3@example.com": "last" }, "routing_status": "offline" }</code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="properties" href="#properties" class="reference css-180507a"><a href="/docs/management/configuration-api#properties"><span class="icon icon-link"></span></a>Properties</a></h2><section class="css-v24v0q"><div class="css-11ycufd"><p>Properties are key-value storages. Property configuration is owned by a <strong>Client Id</strong> (integration). In this document, we call a Client Id that owns a property the <strong>owner Client Id</strong>.</p><p>Properties can be private or public.</p><ul><li><strong>Private</strong> properties can be accessed only by their <strong>owner Client Id</strong>. <a href="/docs/management/configuration-api#private-properties">Read more...</a></li><li><strong>Public</strong> properties can be accessed by <strong>any Client Id</strong>. <a href="/docs/management/configuration-api#public-properties">Read more...</a></li></ul><p>Properties are grouped in <em>namespaces</em>, which helps to distinguish which property belongs to a given Client Id. The property <em>namespace</em> is named after the <strong>Client Id</strong> a property belongs to.</p><p>You can configure the property <a href="/docs/management/configuration-api#property-types">type</a>, <a href="/docs/management/configuration-api#property-locations">location access</a>, and <a href="/docs/management/configuration-api#property-domain">domain</a>.</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">The general properties format</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-js"><code class="language-js"><span class="token punctuation">{</span> <span class="token string-property property">"properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"<namespace>"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token string-property property">"<property_name>"</span><span class="token operator">:</span> <span class="token string">"<property_value>"</span><span class="token punctuation">,</span> <span class="token string-property property">"<property_name>"</span><span class="token operator">:</span> <span class="token string">"<property_value>"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><h3 class="heading"><a id="property-types" href="#property-types" class="reference css-180507a"><a href="/docs/management/configuration-api#property-types"><span class="icon icon-link"></span></a>Property types</a></h3><p>There are four property types:</p><ul><li><code>int</code> (int32)</li><li><code>bool</code></li><li><code>string</code></li><li><code>tokenized_string</code></li></ul><p>The <code>tokenized_string</code> type is a string split to tokens before indexing in our search engine. It can be useful for longer strings, such as messages. It should not be used for keywords.</p><h3 class="heading"><a id="property-locations" href="#property-locations" class="reference css-180507a"><a href="/docs/management/configuration-api#property-locations"><span class="icon icon-link"></span></a>Property locations</a></h3><p>Properties can be set within the following locations:</p><ul><li>event</li><li>thread</li><li>chat</li><li>group</li><li>license</li></ul><p>You can configure access to properties within those locations. For example, you could create a property visible only to agents in a chat and thread, but not in an event.</p><h3 class="heading"><a id="property-domain" href="#property-domain" class="reference css-180507a"><a href="/docs/management/configuration-api#property-domain"><span class="icon icon-link"></span></a>Property domain</a></h3><p>The <strong>property domain</strong> is a set of values that a property can be assigned to.</p><p>Property domain can be configured in two ways:</p><ul><li>by defining a set of values explicitly allowed in this property (for example <code>[1, 2, 3]</code>).</li><li>by defining a range. All values within the range are allowed in this property. It works only for numeric types (for example a range from <code>1</code> to <code>3</code>).</li></ul><h3 class="heading"><a id="property-default-value" href="#property-default-value" class="reference css-180507a"><a href="/docs/management/configuration-api#property-default-value"><span class="icon icon-link"></span></a>Property default value</a></h3><p>If a property value hasn't been explicitly set, then the <strong>default value</strong> will be returned, if any. The <strong>default value</strong> of a property can be set during <a href="/docs/management/configuration-api#register-property">property registration</a> as the <code>default_value</code> parameter.</p><h3 class="heading"><a id="private-properties" href="#private-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#private-properties"><span class="icon icon-link"></span></a>Private properties</a></h3><p>You can register, unregister, and configure a property for a <strong>Client Id</strong> owned by your organization. Unpublished (private) properties can be access only with a token belonging to the <strong>owner Client Id</strong>. If you want other integrations to be able to access your private property, you need to publish it.</p><h3 class="heading"><a id="public-properties" href="#public-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#public-properties"><span class="icon icon-link"></span></a>Public properties</a></h3><p>Once you publish a private property, it becomes accessible to other integrations. The public access to your property can be <code>read</code> and/or <code>write</code>. Consider an example:</p><p>You register a private chat property with the <code>read</code> and <code>write</code> access.</p><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"name"</span><span class="token operator">:</span> <span class="token string">"string_property"</span><span class="token punctuation">,</span> <span class="token property">"owner_client_id"</span><span class="token operator">:</span> <span class="token string">"0805e283233042b37f460ed8fbf22160"</span><span class="token punctuation">,</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"string"</span><span class="token punctuation">,</span> <span class="token property">"access"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"chat"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"agent"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"read"</span><span class="token punctuation">]</span><span class="token punctuation">,</span> <span class="token property">"customer"</span><span class="token operator">:</span> <span class="token punctuation">[</span><span class="token string">"read"</span><span class="token punctuation">,</span> <span class="token string">"write"</span><span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div><p>While publishing the property, you can narrow down its public access to <code>read</code>.</p><div class="remark-highlight"><pre class="language-bash"><code class="language-bash"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/publish_property <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "string_property", "owner_client_id": "0805e283233042b37f460ed8fbf22160", "access_type": ["read"] }'</span> </code></pre></div><p>In this case, tokens belonging to the owner Client Id will be able to <strong>read</strong> and <strong>write</strong> to that property. Any other token will only be able to <strong>read</strong> it.</p><p>💡 Published properties cannot be unregistered.</p><h4 class="heading"><a id="test-properties" href="#test-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#test-properties"><span class="icon icon-link"></span></a>Test properties</a></h4><p>Each license has some test properties that you can use to play with properties.</p><div class="css-q76ucn"><table><thead><tr><th>Namespace</th><th>Property</th><th>Type</th><th>Access</th></tr></thead><tbody><tr><td><code>test</code></td><td><code>bool_property</code></td><td><code>bool</code></td><td>rw for everyone everywhere</td></tr><tr><td><code>test</code></td><td><code>int_property</code></td><td><code>int</code></td><td>rw for everyone everywhere</td></tr><tr><td><code>test</code></td><td><code>string_property</code></td><td><code>string</code></td><td>rw for everyone everywhere</td></tr><tr><td><code>test</code></td><td><code>tokenized_string_property</code></td><td><code>tokenized_string</code></td><td>rw for everyone everywhere</td></tr></tbody></table></div><p>The <code>tokenized_string</code> property is similar to the <code>string</code> type. The values of a <code>tokenized_string</code> are split in tokens to enable searching for each word separately.</p><h4 class="heading"><a id="predefined-properties" href="#predefined-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#predefined-properties"><span class="icon icon-link"></span></a>Predefined properties</a></h4><p>There are also <a href="/docs/messaging/references/default-properties#reference">predefined public properties</a> used mainly by the LiveChat backend integration.</p><h3 class="heading"><a id="methods-5" href="#methods-5" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-5"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Properties API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th align="center">Value</th><th align="right"></th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td align="center"><code>application/json</code></td><td align="right"></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="register-property" href="#register-property" class="reference css-180507a"><a href="/docs/management/configuration-api#register-property"><span class="icon icon-link"></span></a>Register Property</a></h4><p>Registers a new private property for a given <strong>Client Id</strong>.</p><h5 class="heading"><a id="specifics-30" href="#specifics-30" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-30"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/register_property</code></td></tr><tr><td>Required scopes</td><td><code>properties.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-27" href="#request-27" class="reference css-180507a"><a href="/docs/management/configuration-api#request-27"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>Yes</td><td><code>string</code></td><td>Property name</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that will own the property; must be owned by your organization.</td></tr><tr><td><code>type</code></td><td>Yes</td><td><code>string</code></td><td>Possible values: <code>int</code>, <code>string</code>, <code>bool</code>, and <code>tokenized_string</code></td></tr><tr><td><code>access</code></td><td>Yes</td><td><code>object</code></td><td></td></tr><tr><td><code>access.<location></code></td><td>min. one <code>location</code></td><td><code>object</code></td><td>Possible values: <code>chat</code>, <code>thread</code>, <code>event</code>, <code>license</code>, <code>group</code></td></tr><tr><td><code>access.<location>.<user></code></td><td>min. one <code>user</code></td><td><code>[string]</code></td><td>Possible <code><user></code> values: <code>agent</code>, <code>customer</code>; possible values: <code>read</code>, <code>write</code></td></tr><tr><td><code>description</code></td><td>No</td><td><code>string</code></td><td>Property description</td></tr><tr><td><code>domain</code> <sup><strong>1</strong></sup></td><td>No</td><td><code>[<type>]</code></td><td>Array of values that properties can be set to</td></tr><tr><td><code>range</code> <sup><strong>1</strong></sup></td><td>No</td><td><code>object</code></td><td>Range of values that properties can be set to</td></tr><tr><td><code>range.from</code></td><td>No</td><td><code>int</code></td><td>Only values <strong>equal</strong> or <strong>greater</strong> than this parameter can be set to this property</td></tr><tr><td><code>range.to</code></td><td>No</td><td><code>int</code></td><td>Only values <strong>equal</strong> or <strong>lower</strong> than this parameter can be set to this property</td></tr><tr><td><code>default_value</code> <sup><strong>2</strong></sup></td><td>No</td><td><code>type</code></td><td>Default value of property; validated by <strong>domain</strong> or <strong>range</strong>, if one exists</td></tr></tbody></table></div><p><strong>1)</strong> Only one <code>domain</code> and one <code>range</code> can be set for a single property.<br/> <strong>2)</strong> Registering a property with <code>default_value</code> is possible only if <code>access.<location></code> is set to <code>license</code> or to <code>group</code>.</p><h5 class="heading"><a id="response-15" href="#response-15" class="reference css-180507a"><a href="/docs/management/configuration-api#response-15"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/register_property <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "string_property", "owner_client_id": "0805e283233042b37f460ed8fbf22160", "type": "string", "default_value": "string_default_value", "access": { "chat": { "agent": ["read"], "customer": ["read", "write"] } // "thread": {}, // "event": {}, // "license": {}, // "group": {} } }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="unregister-property" href="#unregister-property" class="reference css-180507a"><a href="/docs/management/configuration-api#unregister-property"><span class="icon icon-link"></span></a>Unregister Property</a></h4><p>Unregisters a private property.</p><h5 class="heading"><a id="specifics-31" href="#specifics-31" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-31"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/unregister_property</code></td></tr><tr><td>Required scopes</td><td><code>properties.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-28" href="#request-28" class="reference css-180507a"><a href="/docs/management/configuration-api#request-28"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>Yes</td><td><code>string</code></td><td>Property name</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the property; must be owned by your organization</td></tr></tbody></table></div><h5 class="heading"><a id="response-16" href="#response-16" class="reference css-180507a"><a href="/docs/management/configuration-api#response-16"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/unregister_property <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "string_property", "owner_client_id": "0805e283233042b37f460ed8fbf22160" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="publish-property" href="#publish-property" class="reference css-180507a"><a href="/docs/management/configuration-api#publish-property"><span class="icon icon-link"></span></a>Publish Property</a></h4><p>Publishes a private property. A published property cannot be unpublished or unregistered. Published properties can be accessed by tokens belonging to any <strong>Client Id</strong>.</p><h5 class="heading"><a id="specifics-32" href="#specifics-32" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-32"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/publish_property</code></td></tr><tr><td>Required scopes</td><td><code>properties.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-29" href="#request-29" class="reference css-180507a"><a href="/docs/management/configuration-api#request-29"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>Yes</td><td><code>string</code></td><td>Property name</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the property; must be owned by your organization.</td></tr><tr><td><code>access_type</code></td><td>Yes</td><td><code>[string]</code></td><td>Possible values: <code>read</code>, <code>write</code>. It determines the access level for the <strong>Client Ids</strong> different than <code>owner_client_id</code>.</td></tr></tbody></table></div><h5 class="heading"><a id="response-17" href="#response-17" class="reference css-180507a"><a href="/docs/management/configuration-api#response-17"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/publish_property <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "string_property", "owner_client_id": "0805e283233042b37f460ed8fbf22160", "access_type": ["read"] }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-properties" href="#list-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#list-properties"><span class="icon icon-link"></span></a>List Properties</a></h4><p>Lists private and public properties owned by a given <strong>Client Id</strong>.</p><h5 class="heading"><a id="specifics-33" href="#specifics-33" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-33"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-30" href="#request-30" class="reference css-180507a"><a href="/docs/management/configuration-api#request-30"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td><strong>Client Id</strong> that owns the properties; must be owned by your organization.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "owner_client_id": "0805e283233042b37f460ed8fbf22160" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "string_property": { "type": "string", "description": "", "access": { "thread": { "agent": [ "read", "write" ], "customer": [ "read" ] }, "chat": { "agent": [ "write" ], "customer": [ "read", "write" ] } }, "public_access": [ "read" ] } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-license-properties" href="#update-license-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#update-license-properties"><span class="icon icon-link"></span></a>Update License Properties</a></h4><p>Updates a property value within a license. This operation <strong>doesn't</strong> overwrite the existing values.</p><h5 class="heading"><a id="specifics-34" href="#specifics-34" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-34"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_license_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.license.value--my:rw</code><sup><strong>1</strong></sup>, <code>properties.license.value--all:rw</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> If the requester's Client ID matches the namespace, setting license properties requires <code>properties.license.value--my:rw</code>.</p><p><strong>2)</strong> If the requester's Client ID doesn't match the namespace, setting license properties requires <code>properties.license.value--all:rw</code>. The scope allows to set all properties from your namespace and <a href="/docs/management/configuration-api#public-properties">public properties</a> from <code>core</code> and other namespaces.</p><h5 class="heading"><a id="request-31" href="#request-31" class="reference css-180507a"><a href="/docs/management/configuration-api#request-31"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>Yes</td><td><a href="/docs/management/configuration-api#properties" class="css-kbi7q3"><code>object</code></a></td><td>An object with <em>namespaces</em> as keys and <em>properties</em> (grouped in objects) as values.</td></tr></tbody></table></div><h5 class="heading"><a id="response-18" href="#response-18" class="reference css-180507a"><a href="/docs/management/configuration-api#response-18"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_license_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "properties": { "0805e283233042b37f460ed8fbf22160": { "string_property": "string value" } } }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span><span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-license-properties" href="#list-license-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#list-license-properties"><span class="icon icon-link"></span></a>List License Properties</a></h4><p>Returns the properties set within a license. For properties without an explicit value assignment, the method will return the default values (if they exist).</p><h5 class="heading"><a id="specifics-35" href="#specifics-35" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-35"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_license_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.license.value--my:ro</code><sup><strong>1</strong></sup>, <code>properties.license.value--all:ro</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> The <code>properties.license.value--my:ro</code> scope allows you to access all properties from your namespace only.</p><p><strong>2)</strong> The <code>properties.license.value--all:ro</code> scope allows you to access all properties from your namespace and <a href="/docs/management/configuration-api#public-properties">public properties</a> from <code>core</code> and other namespaces.</p><h5 class="heading"><a id="request-32" href="#request-32" class="reference css-180507a"><a href="/docs/management/configuration-api#request-32"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>namespace</code></td><td>No</td><td><code>string</code></td><td>Properties namespace</td></tr><tr><td><code>name_prefix</code></td><td>No</td><td><code>string</code></td><td>Properties name prefix</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_license_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "namespace": "0805e283233042b37f460ed8fbf22160", "name_prefix": "string" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "0805e283233042b37f460ed8fbf22160": { "string_property": "string value" } }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-license-properties" href="#delete-license-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-license-properties"><span class="icon icon-link"></span></a>Delete License Properties</a></h4><p>Deletes the properties set within a license.</p><h5 class="heading"><a id="specifics-36" href="#specifics-36" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-36"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_license_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.license.value--my:rw</code><sup><strong>1</strong></sup>, <code>properties.license.value--all:rw</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> If the requester's Client ID matches the namespace, deleting license properties requires <code>properties.license.value--my:rw</code>.</p><p><strong>2)</strong> If the requester's Client ID doesn't match the namespace, deleting license properties requires <code>properties.license.value--all:rw</code>. The scope allows to delete all properties from your namespace and <a href="/docs/management/configuration-api#public-properties">public properties</a> from <code>core</code> and other namespaces.</p><h5 class="heading"><a id="request-33" href="#request-33" class="reference css-180507a"><a href="/docs/management/configuration-api#request-33"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>properties</code></td><td>Yes</td><td><a href="/docs/management/configuration-api#properties" class="css-kbi7q3"><code>object</code></a></td><td>An object with <em>namespaces</em> as keys and <em>property_names</em> (in an array) as values.</td></tr></tbody></table></div><h5 class="heading"><a id="response-19" href="#response-19" class="reference css-180507a"><a href="/docs/management/configuration-api#response-19"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_license_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "properties": { "0805e283233042b37f460ed8fbf22160": ["string_property"] } }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-group-properties" href="#update-group-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#update-group-properties"><span class="icon icon-link"></span></a>Update Group Properties</a></h4><p>Updates a property value within a group as the <a href="/docs/management/configuration-api#property-locations">property location</a>. This operation <strong>doesn't</strong> overwrite the existing values.</p><h5 class="heading"><a id="specifics-37" href="#specifics-37" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-37"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_group_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.group.value--my:rw</code><sup><strong>1</strong></sup>, <code>properties.group.value--all:rw</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> If the requester's Client ID matches the namespace, setting group properties requires <code>properties.group.value--my:rw</code>.</p><p><strong>2)</strong> If the requester's Client ID doesn't match the namespace, setting group properties requires <code>properties.group.value--all:rw</code>. The scope allows to set all properties from your namespace and <a href="/docs/management/configuration-api#public-properties">public properties</a> from other namespaces.</p><h5 class="heading"><a id="request-34" href="#request-34" class="reference css-180507a"><a href="/docs/management/configuration-api#request-34"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>group_id</code></td><td>Yes</td><td><code>number</code></td><td>ID of the group you set the properties for.</td></tr><tr><td><code>properties</code></td><td>Yes</td><td><a href="/docs/management/configuration-api#properties" class="css-kbi7q3"><code>object</code></a></td><td>An object with <em>namespaces</em> as keys and <em>properties</em> (grouped in objects) as values.</td></tr></tbody></table></div><h5 class="heading"><a id="response-20" href="#response-20" class="reference css-180507a"><a href="/docs/management/configuration-api#response-20"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_group_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "group_id": 1, "properties": { "0805e283233042b37f460ed8fbf22160": { "string_property": "group property value" } } }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span><span class="token punctuation">}</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-groups-properties" href="#list-groups-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#list-groups-properties"><span class="icon icon-link"></span></a>List Groups Properties</a></h4><p>Returns the properties set within specified groups.</p><h5 class="heading"><a id="specifics-38" href="#specifics-38" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-38"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_groups_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.group.value--all:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-35" href="#request-35" class="reference css-180507a"><a href="/docs/management/configuration-api#request-35"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>group_ids</code></td><td>Yes</td><td><code>[]int</code></td><td>IDs of the groups you retrieve properties from. Properties from all groups will be returned if an empty array is provided.</td></tr><tr><td><code>namespace</code></td><td>No</td><td><code>string</code></td><td>Properties namespace</td></tr><tr><td><code>name_prefix</code></td><td>No</td><td><code>string</code></td><td>Properties name prefix</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_groups_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "group_ids": [0, 1], "namespace": "a", "name_prefix": "b" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "id": 0, "properties": { "0805e283233042b37f460ed8fbf22160": { "string_property": "group property value for group 0" } } }, { "id": 1, "properties": { "0805e283233042b37f460ed8fbf22160": { "string_property": "group property value for group 1" } } } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-group-properties" href="#delete-group-properties" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-group-properties"><span class="icon icon-link"></span></a>Delete Group Properties</a></h4><p>Deletes the properties set within a group.</p><h5 class="heading"><a id="specifics-39" href="#specifics-39" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-39"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_group_properties</code></td></tr><tr><td>Required scopes</td><td><code>properties.group.value--my:rw</code><sup><strong>1</strong></sup>, <code>properties.group.value--all:rw</code><sup><strong>2</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> If the requester's Client ID matches the namespace, deleting group properties requires <code>properties.group.value--my:rw</code>.</p><p><strong>2)</strong> If the requester's Client ID doesn't match the namespace, deleting group properties requires <code>properties.group.value--all:rw</code>. The scope allows to delete all properties from your namespace and <a href="/docs/management/configuration-api#public-properties">public properties</a> from other namespaces.</p><h5 class="heading"><a id="request-36" href="#request-36" class="reference css-180507a"><a href="/docs/management/configuration-api#request-36"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>number</code></td><td>ID of the group you delete properties from.</td></tr><tr><td><code>properties</code></td><td>Yes</td><td><a href="/docs/management/configuration-api#properties" class="css-kbi7q3"><code>object</code></a></td><td>An object with <em>namespaces</em> as keys and <em>property_names</em> (in an array) as values.</td></tr></tbody></table></div><h5 class="heading"><a id="response-21" href="#response-21" class="reference css-180507a"><a href="/docs/management/configuration-api#response-21"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_group_properties <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": 1, "properties": { "0805e283233042b37f460ed8fbf22160": ["string_property"] } }'</span> </code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="tags" href="#tags" class="reference css-180507a"><a href="/docs/management/configuration-api#tags"><span class="icon icon-link"></span></a>Tags</a></h2><section class="css-v24v0q"><div class="css-11ycufd"><p>Tags are simple text labels that can be used by agents to assign chats to pre-defined, custom categories. Tags are useful for filtering out chats in archives and reports.</p><p>To create a new tag, call the <a href="/docs/management/configuration-api/v3.5#create-tag"><strong>Create Tag</strong></a> method with a <code>name</code>. Letter case is ignored when checking if a tag already exists. When creating a tag, you can also provide <code>group_ids</code> to assign the tag to some groups right away. It's also possible to create a tag with empty <code>group_ids</code> and update the group assignment later with <a href="/docs/management/configuration-api/v3.5#update-tag"><strong>Update Tag</strong></a>.</p><p> To remove a tag, call <a href="/docs/management/configuration-api/v3.5#delete-tag"><strong>Delete Tag</strong></a>. Both <strong>Update Tag</strong> and <strong>Delete Tag</strong> methods respect the letter case when matching the tag. You can list all tags existing on your account with the <a href="/docs/management/configuration-api/v3.5#list-tags"><strong>List Tags</strong></a> method.</p><p>Users with the <code>tags--all:rw</code> scope can create/delete/update tags in all license's groups. Users with the <code>tags--groups:rw</code> scope are restricted to groups they are assigned to. Similarly <code>tags--all:ro</code> and <code>tags--groups:ro</code> scopes affect listing tags.</p><p>Tag can be used to mark a chat's thread only if the thread and the tag are assigned to at least one common group.</p></div></section><h3 class="heading"><a id="methods-6" href="#methods-6" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-6"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Tags API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th align="center">Value</th><th align="right"></th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td align="center"><code>application/json</code></td><td align="right"></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="create-tag" href="#create-tag" class="reference css-180507a"><a href="/docs/management/configuration-api#create-tag"><span class="icon icon-link"></span></a>Create Tag</a></h4><p>Creates a new tag.</p><h5 class="heading"><a id="specifics-40" href="#specifics-40" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-40"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/create_tag</code></td></tr><tr><td>Required scopes</td><td><code>tags--all:rw</code> <code>tags--groups:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-37" href="#request-37" class="reference css-180507a"><a href="/docs/management/configuration-api#request-37"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>yes</td><td><code>string</code></td><td>Matching the name of an existing tag is case insensitive.</td></tr><tr><td><code>group_ids</code></td><td>no</td><td><code>[]int</code></td><td>Can be empty.</td></tr></tbody></table></div><h5 class="heading"><a id="response-22" href="#response-22" class="reference css-180507a"><a href="/docs/management/configuration-api#response-22"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/create_tag <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "docs_feedback", "group_ids": [ 0, 42 ] }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="delete-tag" href="#delete-tag" class="reference css-180507a"><a href="/docs/management/configuration-api#delete-tag"><span class="icon icon-link"></span></a>Delete Tag</a></h4><p>Deletes an existing tag.</p><h5 class="heading"><a id="specifics-41" href="#specifics-41" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-41"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/delete_tag</code></td></tr><tr><td>Required scopes</td><td><code>tags--all:rw</code> <code>tags--groups:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-38" href="#request-38" class="reference css-180507a"><a href="/docs/management/configuration-api#request-38"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>yes</td><td><code>string</code></td><td>Matching the name of an existing tag is case sensitive.</td></tr></tbody></table></div><h5 class="heading"><a id="response-23" href="#response-23" class="reference css-180507a"><a href="/docs/management/configuration-api#response-23"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/delete_tag <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "docs_feedback" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-tags" href="#list-tags" class="reference css-180507a"><a href="/docs/management/configuration-api#list-tags"><span class="icon icon-link"></span></a>List Tags</a></h4><p>Lists the exisiting tags.</p><h5 class="heading"><a id="specifics-42" href="#specifics-42" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-42"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_tags</code></td></tr><tr><td>Required scopes</td><td><code>tags--all:ro</code> <code>tags--groups:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-39" href="#request-39" class="reference css-180507a"><a href="/docs/management/configuration-api#request-39"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>filters</code></td><td>No</td><td><code>object</code></td><td>Possible request filters.</td></tr><tr><td><code>filters.group_ids</code></td><td>Yes</td><td><code>int[]</code></td><td>IDs of the groups from which you want to list tags.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_tags <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "filters": { "group_ids": [ 0, 42 ] } }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "name": "docs_feedback", "group_ids": [ 0, 42 ], "author_id": "smith@example.com", "created_at": "2019-12-09T12:01:18.909000Z" }, { "name": "positive feedback", "group_ids": [ 0 ], "author_id": "", "created_at": "2017-11-13T15:37:36.000000+01:00" }, { "name": "support", "group_ids": [ 0 ], "author_id": "", "created_at": "2017-11-13T15:37:36.000000+01:00" }, { "name": "complaint", "group_ids": [ 0 ], "author_id": "", "created_at": "2017-11-13T15:37:36.000000+01:00" }, { "name": "sales", "group_ids": [ 0 ], "author_id": "", "created_at": "2017-11-13T15:37:36.000000+01:00" }, { "name": "spam", "group_ids": [ 0 ], "author_id": "", "created_at": "2017-11-13T15:37:36.000000+01:00" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="update-tag" href="#update-tag" class="reference css-180507a"><a href="/docs/management/configuration-api#update-tag"><span class="icon icon-link"></span></a>Update Tag</a></h4><p>Updates an existing tag.</p><h5 class="heading"><a id="specifics-43" href="#specifics-43" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-43"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/update_tag</code></td></tr><tr><td>Required scopes</td><td><code>tags--all:rw</code> <code>tags--groups:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-40" href="#request-40" class="reference css-180507a"><a href="/docs/management/configuration-api#request-40"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>name</code></td><td>yes</td><td><code>string</code></td><td>Matching the name of an existing tag is case sensitive.</td></tr><tr><td><code>group_ids</code></td><td>no</td><td><code>[]int</code></td><td>Can be empty.</td></tr></tbody></table></div><h5 class="heading"><a id="response-24" href="#response-24" class="reference css-180507a"><a href="/docs/management/configuration-api#response-24"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/update_tag <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "name": "docs_feedback", "group_ids": [ 0, 42 ] }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h3 class="heading"><a id="sample-app" href="#sample-app" class="reference css-180507a"><a href="/docs/management/configuration-api#sample-app"><span class="icon icon-link"></span></a>Sample app</a></h3><p>Tag Master allows you to create, view, and delete tags and canned responses in an easy and predictable way. It uses <a target="_blank" href="https://platform.text.com/docs/authorization/sign-in-with-livechat/#accounts-sdk">Accounts SDK</a> and its <a target="_blank" href="https://platform.text.com/docs/authorization/sign-in-with-livechat#redirect-1">Redirect</a> method for authorization and <strong>Configuration API v3.5</strong> endpoints:</p><ul><li><a href="/docs/management/configuration-api/v3.5#create-tag"><strong>Create Tag</strong></a></li><li><a href="/docs/management/configuration-api/v3.5#list-tags"><strong>List Tags</strong></a></li><li><a href="/docs/management/configuration-api/v3.5#delete-tag"><strong>Delete Tag</strong></a></li></ul><p>To read more and experiment with the Tag Master app, go on our <a target="_blank" href="https://github.com/livechat/tag-master">GitHub</a>. You can also check out our different sample apps <a target="_blank" href="https://developers.livechat.com/updates/livechat-sample-apps">here</a>.</p><h2 class="heading css-1679d3t"><a id="webhooks" href="#webhooks" class="reference css-180507a"><a href="/docs/management/configuration-api#webhooks"><span class="icon icon-link"></span></a>Webhooks</a></h2><p>Here's what you need to know about <strong>webhooks</strong>:</p><ul><li>Webhooks notify you when specific events are triggered.</li><li>They can be generated by both Web and RTM API actions.</li><li>Webhooks and pushes have similar payloads.</li><li>You <strong>register</strong> webhook definitions per Client ID (application).</li><li>Webhooks are always automatically enabled for the licences that install your application.</li><li>There's a limit of three weebhoks for every action a Client ID can register.</li></ul><p>💡 <a target="_blank" href="https://developers.livechat.com/updates/setting-up-webhooks-with-livechat-api">Tutorial: How to set up LiveChat webhooks.</a></p></div><div class="css-17buymi"><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">general webhook format</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"webhook_id"</span><span class="token operator">:</span> <span class="token string">"<webhook_id>"</span><span class="token punctuation">,</span> <span class="token property">"secret_key"</span><span class="token operator">:</span> <span class="token string">"<secret_key>"</span><span class="token punctuation">,</span> <span class="token property">"action"</span><span class="token operator">:</span> <span class="token string">"<action>"</span><span class="token punctuation">,</span> <span class="token property">"organization_id"</span><span class="token operator">:</span> <span class="token string">"<organization_id>"</span><span class="token punctuation">,</span> <span class="token property">"payload"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"additional_data"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"chat_properties"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">//optional</span> <span class="token comment">// chat properties</span> <span class="token punctuation">}</span><span class="token punctuation">,</span> <span class="token property">"chat_presence_user_ids"</span><span class="token operator">:</span> <span class="token punctuation">[</span> <span class="token comment">//optional</span> <span class="token comment">// User IDs</span> <span class="token punctuation">]</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div></div></section><h3 class="heading"><a id="methods-7" href="#methods-7" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-7"><span class="icon icon-link"></span></a>Methods</a></h3><div class="css-q76ucn"><table><thead><tr><th>HTTP method</th><th>The Webhooks API endpoint</th></tr></thead><tbody><tr><td><code>POST</code></td><td><code>https://api.livechatinc.com/v3.5/configuration/action/<action></code></td></tr></tbody></table></div><div class="css-q76ucn"><table><thead><tr><th>Required header</th><th align="center">Value</th><th align="right"></th></tr></thead><tbody><tr><td><code>Content-Type</code></td><td align="center"><code>application/json</code></td><td align="right"></td></tr></tbody></table></div><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="register-webhook" href="#register-webhook" class="reference css-180507a"><a href="/docs/management/configuration-api#register-webhook"><span class="icon icon-link"></span></a>Register Webhook</a></h4><p>Registers a webhook for the Client ID (application) provided in the request. One Client ID can register up to three webhooks for every <code>action</code>. The <code>license</code> webhooks'll be enabled automatically when the application is installed on the license.</p><p>As an alternative to calling Register Webhook, you can register webhooks via Developer Console by configuring the Chat Webhooks building block. <a href="/docs/getting-started/app-guides/chat-webhooks">Learn more...</a></p><p>For <code>bot</code> webhooks, you need to <a href="/docs/management/configuration-api#create-bot">create a bot</a>, <a href="/docs/management/configuration-api#register-webhook">register webhooks</a>, and then, call <a href="/docs/messaging/agent-chat-api/v3.5#set-routing-status">Set Routing Status</a>.</p><h5 class="heading"><a id="specifics-44" href="#specifics-44" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-44"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/register_webhook</code></td></tr><tr><td>Required token scopes <sup><strong>1</strong></sup></td><td><code>webhooks.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> Token scopes are assigned to an access token, not to an application (Client ID). For this method, we recommend authorizing with a <a href="/docs/authorization/agent-authorization#personal-access-tokens">Personal Access Token (PAT)</a>. Make sure your PAT has the <code>webhooks.configuration:rw</code> scope.</p><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>action</code><sup><strong>2</strong></sup></td><td>yes</td><td><code>string</code></td><td>The <a href="/docs/management/configuration-api#triggering-actions">action</a> that triggers sending a webhook.</td></tr><tr><td><code>secret_key</code></td><td>yes</td><td><code>string</code></td><td>The secret key sent in webhooks to verify the source of a webhook.</td></tr><tr><td><code>url</code></td><td>yes</td><td><code>string</code></td><td>Destination URL for the webhook</td></tr><tr><td><code>additional_data</code></td><td>no</td><td><code>[]string</code></td><td>Additional data arriving with the webhook. Value: <code>chat_properties</code>, <code>chat_presence_user_ids</code> (all actions except for <code>agent_status_changed</code>, <code>agent_deleted</code>, <code>incoming_customer</code>)</td></tr><tr><td><code>description</code></td><td>no</td><td><code>string</code></td><td>Webhook description</td></tr><tr><td><code>filters</code></td><td>no</td><td><code>object</code></td><td>Filters to check if a webhook should be triggered.</td></tr><tr><td><code>filters.author_type</code></td><td>no</td><td><code>string</code></td><td>Possible values: <code>customer</code>, <code>agent</code>; allowed only for the <code>incoming_event</code> and <code>event_updated</code> actions.</td></tr><tr><td><code>filters.only_my_chats</code></td><td>no</td><td><code>bool</code></td><td><code>true</code> or <code>false</code>; triggers webhooks only for chats with the property <code>source.client_id</code> set to my <code>client_id</code>.</td></tr><tr><td><code>filters.chat_presence</code></td><td>no</td><td><code>object</code></td><td>Filters to check if a webhook should be triggered based on user's presence in the chat.</td></tr><tr><td><code>filters.chat_presence.user_ids</code></td><td>no</td><td><code>object</code></td><td>Only one filter (<code>values</code> or <code>exclude_values</code>) is allowed. Supports every user type (Agent, Customer, Bot).</td></tr><tr><td><code>filters.chat_presence.user_ids.values</code></td><td>no</td><td><code>[]string</code></td><td>Array of Users' ids; if any specified User is in the chat, the webhook will be triggered.</td></tr><tr><td><code>filters.chat_presence.user_ids.exclude_values</code></td><td>no</td><td><code>[]string</code></td><td>Array of Users' ids; if any specified Users is in the chat, the webhook will not be triggered.</td></tr><tr><td><code>filters.chat_presence.my_bots</code></td><td>no</td><td><code>bool</code></td><td>If any bot owned by <code>owner_client_id</code> is in the chat, the webhook will be triggered.</td></tr><tr><td><code>filters.source_type</code></td><td>no</td><td><code>[]string</code></td><td>Array of source types. Possible values: <code>my_client</code> (client ID of your app), <code>other_clients</code> (client IDs other than your app's), <code>system</code> (no client ID); if the source which triggered the webhook matches the filter, the webhook will be sent.</td></tr><tr><td><code>owner_client_id</code></td><td>yes</td><td><code>string</code></td><td><strong>Client Id</strong> that will own the webhook; must be owned by your organization.</td></tr><tr><td><code>type</code></td><td>yes</td><td><code>string</code></td><td><code>bot</code> or <code>license</code></td></tr></tbody></table></div><h5 class="heading"><a id="triggering-actions" href="#triggering-actions" class="reference css-180507a"><a href="/docs/management/configuration-api#triggering-actions"><span class="icon icon-link"></span></a>Triggering actions</a></h5><p><strong>2)</strong> The table below presents the possible values for the <code>action</code> parameter.</p><div class="css-q76ucn"><table><thead><tr><th>Possible action</th><th align="right">Available filters</th></tr></thead><tbody><tr><td><a href="/docs/management/webhooks#incoming_chat" class="css-kbi7q3"><code>incoming_chat</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#chat_deactivated" class="css-kbi7q3"><code>chat_deactivated</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#chat_access_updated" class="css-kbi7q3"><code>chat_access_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#chat_transferred" class="css-kbi7q3"><code>chat_transferred</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#user_added_to_chat" class="css-kbi7q3"><code>user_added_to_chat</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#user_removed_from_chat" class="css-kbi7q3"><code>user_removed_from_chat</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#incoming_event" class="css-kbi7q3"><code>incoming_event</code></a></td><td align="right"><code>chat_presence</code>, <code>author_type</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#event_updated" class="css-kbi7q3"><code>event_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>author_type</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#incoming_rich_message_postback" class="css-kbi7q3"><code>incoming_rich_message_postback</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#chat_properties_updated" class="css-kbi7q3"><code>chat_properties_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#chat_properties_deleted" class="css-kbi7q3"><code>chat_properties_deleted</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#thread_properties_updated" class="css-kbi7q3"><code>thread_properties_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#thread_properties_deleted" class="css-kbi7q3"><code>thread_properties_deleted</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#event_properties_updated" class="css-kbi7q3"><code>event_properties_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#event_properties_deleted" class="css-kbi7q3"><code>event_properties_deleted</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#thread_tagged" class="css-kbi7q3"><code>thread_tagged</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#thread_untagged" class="css-kbi7q3"><code>thread_untagged</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#routing_status_set" class="css-kbi7q3"><code>routing_status_set</code></a></td><td align="right"><code>agent_ids</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#incoming_customer" class="css-kbi7q3"><code>incoming_customer</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#customer_session_fields_updated" class="css-kbi7q3"><code>customer_session_fields_updated</code></a></td><td align="right"><code>chat_presence</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#events_marked_as_seen" class="css-kbi7q3"><code>events_marked_as_seen</code></a></td><td align="right"><code>chat_presence</code>, <code>only_my_chats</code>, <code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#group_created" class="css-kbi7q3"><code>group_created</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#group_updated" class="css-kbi7q3"><code>group_updated</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#group_deleted" class="css-kbi7q3"><code>group_deleted</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_created" class="css-kbi7q3"><code>agent_created</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_updated" class="css-kbi7q3"><code>agent_updated</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_deleted" class="css-kbi7q3"><code>agent_deleted</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_suspended" class="css-kbi7q3"><code>agent_suspended</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_unsuspended" class="css-kbi7q3"><code>agent_unsuspended</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#agent_approved" class="css-kbi7q3"><code>agent_approved</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#bot_created" class="css-kbi7q3"><code>bot_created</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#bot_updated" class="css-kbi7q3"><code>bot_updated</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#bot_deleted" class="css-kbi7q3"><code>bot_deleted</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#auto_accesses_updated" class="css-kbi7q3"><code>auto_accesses_updated</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#tag_created" class="css-kbi7q3"><code>tag_created</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#tag_deleted" class="css-kbi7q3"><code>tag_deleted</code></a></td><td align="right"><code>source_type</code></td></tr><tr><td><a href="/docs/management/webhooks#tag_updated" class="css-kbi7q3"><code>tag_updated</code></a></td><td align="right"><code>source_type</code></td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/register_webhook <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Basic <your_username>:<your_PAT>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "url": "http://myservice.com/webhooks", "description": "Test webhook", "action": "chat_deactivated", "secret_key": "laudla991lamda0pnoaa0", "owner_client_id": "asXdesldiAJSq9padj", "type": "license" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "id": "pqi8oasdjahuakndw9nsad9na" }</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-webhooks" href="#list-webhooks" class="reference css-180507a"><a href="/docs/management/configuration-api#list-webhooks"><span class="icon icon-link"></span></a>List Webhooks</a></h4><p>Lists all webhooks registered for the given Client ID.</p><h5 class="heading"><a id="specifics-45" href="#specifics-45" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-45"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_webhooks</code></td></tr><tr><td>Required scopes</td><td><code>webhooks.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-41" href="#request-41" class="reference css-180507a"><a href="/docs/management/configuration-api#request-41"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>yes</td><td><code>string</code></td><td>The webhook owner (the Client ID for which the webhook is registered).</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_webhooks <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "owner_client_id": "0805e283233042b37f460ed8fbf22160" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "id": "pqi8oasdjahuakndw9nsad9na", "url": "http://myservice.com/webhooks", "description": "Test webhook", "action": "chat_deactivated", "filters": { "chat_presence": { "user_ids": { "values": [ "johndoe@mail.com" ] }, "my_bots": true } }, "owner_client_id": "asXdesldiAJSq9padj", "type": "license" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="unregister-webhook" href="#unregister-webhook" class="reference css-180507a"><a href="/docs/management/configuration-api#unregister-webhook"><span class="icon icon-link"></span></a>Unregister Webhook</a></h4><p>Unregisters a webhook previously <a href="/docs/management/configuration-api#register-webhook">registered</a> for a Client ID (application).</p><h5 class="heading"><a id="specifics-46" href="#specifics-46" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-46"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/unregister_webhook</code></td></tr><tr><td>Required scopes</td><td><code>webhooks.configuration:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-42" href="#request-42" class="reference css-180507a"><a href="/docs/management/configuration-api#request-42"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>id</code></td><td>Yes</td><td><code>string</code></td><td>Webhook ID</td></tr><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td>The webhook owner (the Client ID for which the webhook is registered).</td></tr></tbody></table></div><h5 class="heading"><a id="response-25" href="#response-25" class="reference css-180507a"><a href="/docs/management/configuration-api#response-25"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/unregister_webhook <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "id": "pqi8oasdjahuakndw9nsad9na", "owner_client_id": "0805e283233042b37f460ed8fbf22160" }'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-webhook-names" href="#list-webhook-names" class="reference css-180507a"><a href="/docs/management/configuration-api#list-webhook-names"><span class="icon icon-link"></span></a>List Webhook Names</a></h4><p>Lists all webhooks that are supported in a given API version. This method requires no authorization.</p><h5 class="heading"><a id="specifics-47" href="#specifics-47" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-47"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_webhook_names</code></td></tr><tr><td>Required scopes</td><td>-</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-43" href="#request-43" class="reference css-180507a"><a href="/docs/management/configuration-api#request-43"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>version</code></td><td>No</td><td><code>string</code></td><td>Defaults to the current stable API version</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_webhook_names <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "version": "3.5" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "action": "agent_deleted", "filters": [ "agent_ids" ] }, { "action": "chat_access_updated", "filters": [ "chat_presence", "only_my_chats" ], "additional_data": [ "chat_properties", "chat_presence_user_ids" ] }, { "action": "incoming_customer" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="enable-license-webhooks" href="#enable-license-webhooks" class="reference css-180507a"><a href="/docs/management/configuration-api#enable-license-webhooks"><span class="icon icon-link"></span></a>Enable License Webhooks</a></h4><p>Enables the <a href="/docs/management/configuration-api#disable-license-webhooks">disabled</a> webhooks on the license.</p><p>Use this method only if you disabled the webhooks on the license via <a href="/docs/management/configuration-api#disable-license-webhooks">Disable License Webhooks</a>. Otherwise, the webhooks will be automatically enabled when the associated application is installed on the license.</p><h5 class="heading"><a id="specifics-48" href="#specifics-48" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-48"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/enable_license_webhooks</code></td></tr><tr><td>Required scopes</td><td><code>webhooks.state:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-44" href="#request-44" class="reference css-180507a"><a href="/docs/management/configuration-api#request-44"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td>Required only when authorizing via <a href="/docs/authorization/agent-authorization#personal-access-tokens">PATs</a>. When you provide this param while authorizing with a Bearer Token, the <code>client_id</code> associated with the Bearer Token will be ignored, and provided <code>owner_client_id</code> will be used instead.</td></tr></tbody></table></div><h5 class="heading"><a id="response-26" href="#response-26" class="reference css-180507a"><a href="/docs/management/configuration-api#response-26"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/enable_license_webhooks <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="disable-license-webhooks" href="#disable-license-webhooks" class="reference css-180507a"><a href="/docs/management/configuration-api#disable-license-webhooks"><span class="icon icon-link"></span></a>Disable License Webhooks</a></h4><p>Disables the webhooks on the license. The webhooks will stay disabled even after the associated application is reinstalled. To enable the webhooks again (and to rely on automatic webhooks enablement), use <a href="/docs/management/configuration-api#enable-license-webhooks">Enable License Webhooks</a>.</p><h5 class="heading"><a id="specifics-49" href="#specifics-49" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-49"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/disable_license_webhooks</code></td></tr><tr><td>Required scopes</td><td><code>webhooks.state:rw</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-45" href="#request-45" class="reference css-180507a"><a href="/docs/management/configuration-api#request-45"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td>Required only when authorizing via <a href="/docs/authorization/agent-authorization#personal-access-tokens">PATs</a>. When you provide this param while authorizing with a Bearer Token, the <code>client_id</code> associated with the Bearer Token will be ignored, and provided <code>owner_client_id</code> will be used instead.</td></tr></tbody></table></div><h5 class="heading"><a id="response-27" href="#response-27" class="reference css-180507a"><a href="/docs/management/configuration-api#response-27"><span class="icon icon-link"></span></a>Response</a></h5><p>No response payload (<code>200 OK</code>).</p></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/disable_license_webhooks <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="get-license-webhooks-state" href="#get-license-webhooks-state" class="reference css-180507a"><a href="/docs/management/configuration-api#get-license-webhooks-state"><span class="icon icon-link"></span></a>Get License Webhooks State</a></h4><p>Gets the state of the webhooks registered for a given <strong>Client Id</strong> (application) on the license associated with the access token used in the request.</p><h5 class="heading"><a id="specifics-50" href="#specifics-50" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-50"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/get_license_webhooks_state</code></td></tr><tr><td>Required scopes</td><td><code>webhooks.state:ro</code></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-46" href="#request-46" class="reference css-180507a"><a href="/docs/management/configuration-api#request-46"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>owner_client_id</code></td><td>Yes</td><td><code>string</code></td><td>Required only when authorizing via <a href="/docs/authorization/agent-authorization#personal-access-tokens">PATs</a>. When you provide this param while authorizing with a Bearer Token, the <code>client_id</code> associated with the Bearer Token will be ignored, and provided <code>owner_client_id</code> will be used instead.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/get_license_webhooks_state <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "license_webhooks_enabled": true }</code></pre></div></div></div></div></section><h3 class="heading"><a id="available-webhooks" href="#available-webhooks" class="reference css-180507a"><a href="/docs/management/configuration-api#available-webhooks"><span class="icon icon-link"></span></a>Available webhooks</a></h3><p>To see the list of available webhooks v3.5, <a href="/docs/management/webhooks/v3.5">visit the Webhooks</a> document.</p><h2 class="heading css-1679d3t"><a id="other" href="#other" class="reference css-180507a"><a href="/docs/management/configuration-api#other"><span class="icon icon-link"></span></a>Other</a></h2><h3 class="heading"><a id="methods-8" href="#methods-8" class="reference css-180507a"><a href="/docs/management/configuration-api#methods-8"><span class="icon icon-link"></span></a>Methods</a></h3><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="list-channels" href="#list-channels" class="reference css-180507a"><a href="/docs/management/configuration-api#list-channels"><span class="icon icon-link"></span></a>List Channels</a></h4><p>Returns the summary of communication channels for your LiveChat product.</p><h5 class="heading"><a id="specifics-51" href="#specifics-51" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-51"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/list_channels</code></td></tr><tr><td>Required scopes</td><td>-</td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><h5 class="heading"><a id="request-47" href="#request-47" class="reference css-180507a"><a href="/docs/management/configuration-api#request-47"><span class="icon icon-link"></span></a>Request</a></h5><p>Empty request payload.</p><h5 class="heading"><a id="response-28" href="#response-28" class="reference css-180507a"><a href="/docs/management/configuration-api#response-28"><span class="icon icon-link"></span></a>Response</a></h5><p>The response is an array of the channel objects:</p><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>channel_type</code></td><td><code>string</code></td><td>Possible values: <code>code</code>, <code>direct_link</code> or <code>integration</code></td></tr><tr><td><code>channel_subtype</code></td><td><code>string</code></td><td>Possible values: An empty string for <code>code</code> and <code>direct_link</code>; Client ID for <code>integration</code></td></tr><tr><td><code>first_activity_timestamp</code></td><td><code>string</code></td><td>RFC 3339 date-time format</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/list_channels <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "channel_type": "code", "channel_subtype": "", "first_activity_timestamp": "2017-10-12T13:56:16Z" }, { "channel_type": "direct_link", "channel_subtype": "", "first_activity_timestamp": "2017-10-12T15:20:00Z" }, { "channel_type": "integration", "channel_subtype": "c6e4f62e2a2dab12531235b12c5a2a6b", "first_activity_timestamp": "2019-08-16T16:55:51Z" } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="check-product-limits-for-plan" href="#check-product-limits-for-plan" class="reference css-180507a"><a href="/docs/management/configuration-api#check-product-limits-for-plan"><span class="icon icon-link"></span></a>Check Product Limits for Plan</a></h4><p>Resource limits in the LiveChat product are different for each plan. This method compares your organization's current resources with a given plan and returns those which exceeded the called plan's limits. Useful when considering downgrading the plan.</p><h5 class="heading"><a id="specifics-52" href="#specifics-52" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-52"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/check_product_limits_for_plan</code></td></tr><tr><td>Required scopes</td><td><code>subscription.lc:rw</code><sup><strong>1</strong></sup></td></tr><tr><td><a href="/docs/management/configuration-api#batch-requests">Batch support</a></td><td>No</td></tr></tbody></table></div><p><strong>1)</strong> <code>subscription.lc:rw</code> is a private scope; it's not possible to configure it in Developer Console.</p><h5 class="heading"><a id="request-48" href="#request-48" class="reference css-180507a"><a href="/docs/management/configuration-api#request-48"><span class="icon icon-link"></span></a>Request</a></h5><div class="css-q76ucn"><table><thead><tr><th>Parameter</th><th>Required</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>plan</code></td><td>yes</td><td><code>string</code></td><td>Possible values: <code>starter</code>, <code>team</code>, <code>enterprise</code>, <code>enterpriseplus</code></td></tr></tbody></table></div><h5 class="heading"><a id="response-29" href="#response-29" class="reference css-180507a"><a href="/docs/management/configuration-api#response-29"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Resource Name</th><th>Notes</th></tr></thead><tbody><tr><td><code>agents</code></td><td>The number of active agents, including bots, that exceeded the limit.</td></tr><tr><td><code>groups</code></td><td>The number of groups that exceeded the limit.</td></tr><tr><td><code>banned</code></td><td>The number of banned visitors that exceeded the limit.</td></tr><tr><td><code>queue</code></td><td>The number of chats waiting in the queue (with <a href="/docs/messaging#messaging-mode">Messaging Mode</a> disabled) that exceeded the limit.</td></tr><tr><td><code>queue_continuous</code></td><td>The number of chats waiting in the queue (with <a href="/docs/messaging#messaging-mode">Messaging Mode</a> enabled) that exceeded the limit.</td></tr><tr><td><code>groups_per_agent</code></td><td>The number of groups an agent can be assigned to that exceeded the limit.</td></tr><tr><td><code>access_rules</code></td><td>The number of <a href="/docs/management/configuration-api#auto-access">Access Rules</a> that exceeded the limit.</td></tr><tr><td><code>group_chooser_groups</code></td><td>The number of groups available in the <a href="https://www.livechat.com/help/dividing-live-chat-by-group/#target-field">pre-chat survey</a> that exceeded the limit.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/check_product_limits_for_plan <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{ "plan": "starter" }'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">[ { "resource": "groups", "limit_balance": 1 }, { "resource": "groups_per_agent", "limit_balance": 2, "id": "user@example.com" }, { "resource": "group_chooser_groups", "limit_balance": 3, "id": "0" }, { "resource": "queue", "limit_balance": 4 }, { "resource": "queue", "limit_balance": 4, "id": "0" }, { "resource": "queue_continuous", "limit_balance": 1 }, { "resource": "queue_continuous", "limit_balance": 1, "id": "0" }, { "resource": "access_rules", "limit_balance": 1 } ]</code></pre></div></div></div></div></section><section class="css-v24v0q"><div class="css-11ycufd"><h4 class="heading"><a id="get-product-source" href="#get-product-source" class="reference css-180507a"><a href="/docs/management/configuration-api#get-product-source"><span class="icon icon-link"></span></a>Get Product Source</a></h4><p>This method retrieves the <code>source</code> parameters that were passed when activating the LiveChat product.</p><h5 class="heading"><a id="specifics-53" href="#specifics-53" class="reference css-180507a"><a href="/docs/management/configuration-api#specifics-53"><span class="icon icon-link"></span></a>Specifics</a></h5><div class="css-q76ucn"><table><thead><tr><th></th><th></th></tr></thead><tbody><tr><td>Method URL</td><td><code>https://api.livechatinc.com/v3.5/configuration/action/get_product_source</code></td></tr><tr><td>Required scopes</td><td>-</td></tr></tbody></table></div><h5 class="heading"><a id="request-49" href="#request-49" class="reference css-180507a"><a href="/docs/management/configuration-api#request-49"><span class="icon icon-link"></span></a>Request</a></h5><p>Empty request payload.</p><h5 class="heading"><a id="response-30" href="#response-30" class="reference css-180507a"><a href="/docs/management/configuration-api#response-30"><span class="icon icon-link"></span></a>Response</a></h5><div class="css-q76ucn"><table><thead><tr><th>Field</th><th>Data type</th><th>Notes</th></tr></thead><tbody><tr><td><code>source_id</code></td><td><code>string</code></td><td>The source ID parameter passed when activating the LiveChat product.</td></tr><tr><td><code>source_type</code></td><td><code>string</code></td><td>The source type parameter passed when activating the LiveChat product.</td></tr><tr><td><code>source_url</code></td><td><code>string</code></td><td>The source URL parameter passed when activating the LiveChat product.</td></tr></tbody></table></div></div><div class="css-17buymi"><div class="css-16prjg8"><div class="css-13hnul0"><code class="code-sample-header">REQUEST</code><div class="css-1sg2lsz"><div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-shell"><code class="language-shell"><span class="token function">curl</span> -X POST <span class="token punctuation">\</span> https://api.livechatinc.com/v3.5/configuration/action/get_product_source <span class="token punctuation">\</span> -H <span class="token string">'Authorization: Bearer <your_access_token>'</span> <span class="token punctuation">\</span> -H <span class="token string">'Content-Type: application/json'</span> <span class="token punctuation">\</span> -d <span class="token string">'{}'</span> </code></pre></div></div></div><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Response</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight" data-language="json"><pre class="language-json"><code class="language-json">{ "source_id": "create_account_link", "source_type": "accounts", "source_url": "https://accounts.livechat.com" }</code></pre></div></div></div></div></section><h2 class="heading css-1679d3t"><a id="errors" href="#errors" class="reference css-180507a"><a href="/docs/management/configuration-api#errors"><span class="icon icon-link"></span></a>Errors</a></h2><div class="css-1vuwrgc"><div class="css-iwgofq"><span class="css-w6gvpm">Format of error payload</span> <div class="css-1wp1vo7"><div class="css-xnt8k0"><div class="css-6oazep"><div class="css-11ycufd">Copied!</div></div><div class="css-139ndot"><svg xmlns="http://www.w3.org/2000/svg" height="18px" viewBox="0 0 24 24" width="18px"><path d="M0 0h24v24H0V0z" fill="none"></path><path d="M16 1H4c-1.1 0-2 .9-2 2v14h2V3h12V1zm-1 4H8c-1.1 0-1.99.9-1.99 2L6 21c0 1.1.89 2 1.99 2H19c1.1 0 2-.9 2-2V11l-6-6zM8 21V7h6v5h5v9H8z" fill="currentColor"></path></svg></div></div></div></div><div class="css-ju12u0"><div class="remark-highlight"><pre class="language-json"><code class="language-json"><span class="token punctuation">{</span> <span class="token property">"error"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token property">"type"</span><span class="token operator">:</span> <span class="token string">"misdirected_request"</span><span class="token punctuation">,</span> <span class="token property">"message"</span><span class="token operator">:</span> <span class="token string">"Wrong region"</span><span class="token punctuation">,</span> <span class="token property">"data"</span><span class="token operator">:</span> <span class="token punctuation">{</span> <span class="token comment">// optional</span> <span class="token property">"region"</span><span class="token operator">:</span> <span class="token string">"dal"</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> </code></pre></div></div></div><h3 class="heading"><a id="possible-errors" href="#possible-errors" class="reference css-180507a"><a href="/docs/management/configuration-api#possible-errors"><span class="icon icon-link"></span></a>Possible errors</a></h3><div class="css-q76ucn"><table><thead><tr><th>Error type</th><th>Default message</th><th>Description</th></tr></thead><tbody><tr><td><code class="language-text">authentication</code></td><td>Authentication error</td><td>An invalid or expired access token.</td></tr><tr><td><code class="language-text">authorization</code></td><td>Authorization error</td><td>User is not allowed to perform the action.</td></tr><tr><td><code class="language-text">already_exists</code></td><td>Already exists</td><td>It's impossible to create the resource as it already exists.</td></tr><tr><td><code class="language-text">group_not_found</code></td><td>Group not found</td><td></td></tr><tr><td><code class="language-text">internal</code></td><td>Internal server error</td><td></td></tr><tr><td><code class="language-text">license_expired</code></td><td>License expired</td><td>The end of license trial or subcription.</td></tr><tr><td><code class="language-text">limit_reached</code></td><td>Limit reached</td><td>Resource cannot be created/modified because the change would exceed the limit</td></tr><tr><td><code class="language-text">misdirected_request</code></td><td>Wrong region</td><td>Client's request should be performed to another region. The correct region is returned in the optional data object – this is where the client should be connected.</td></tr><tr><td><code class="language-text">not_found</code></td><td>Not found</td><td>The requested resource wasn't found.</td></tr><tr><td><code class="language-text">too_many_requests</code></td><td>Too many requests</td><td>The request's rate limit was exceeded. It'll be unblocked automatically after some time.</td></tr><tr><td><code class="language-text">ownership_transfer</code></td><td>Invalid transfer ownership request</td><td>Ownership cannot be transfered to this account (bot, suspended agent).</td></tr><tr><td><code class="language-text">unsupported_version</code></td><td>Cannot call unsupported API versions.</td><td>Unsupported protocol version.</td></tr><tr><td><code class="language-text">validation</code></td><td>Wrong format of request</td><td></td></tr></tbody></table></div><h2 class="heading css-1679d3t"><a id="contact-us" href="#contact-us" class="reference css-180507a"><a href="/docs/management/configuration-api#contact-us"><span class="icon icon-link"></span></a>Contact us</a></h2><p>If you found a bug or a typo, you can let us know directly on GitHub. In case of any questions or feedback, don't hesitate to contact us at <a href="mailto:developers@text.com"><a href="mailto:developers@text.com">developers@text.com</a></a>. We'll be happy to hear from you!</p><style data-emotion-css="1fsewzh">.css-1fsewzh{margin-top:50px;}.css-1fsewzh > label{margin:0 0 5px 0;}.css-1fsewzh label + div{-webkit-box-pack:center;-webkit-justify-content:center;-ms-flex-pack:center;justify-content:center;}</style></article></div><p>...</p></div><style data-emotion-css="1mpu5jj">.css-1mpu5jj{display:-webkit-box;display:-webkit-flex;display:-ms-flexbox;display:flex;-webkit-box-pack:space-evenly;-webkit-justify-content:space-evenly;-ms-flex-pack:space-evenly;justify-content:space-evenly;-webkit-align-items:start;-webkit-box-align:start;-ms-flex-align:start;align-items:start;-webkit-flex-wrap:wrap;-ms-flex-wrap:wrap;flex-wrap:wrap;background-color:#f6f6f7;color:#424d57;min-height:248px;margin-bottom:45px;}@media (min-width:768px){.css-1mpu5jj{margin-bottom:0px;}}</style><div class="css-1mpu5jj"><style data-emotion-css="dtzkur">.css-dtzkur{width:100%;padding:20px;}@media (min-width:768px){.css-dtzkur{margin-top:75px;padding:0;width:160px;}}</style><div class="css-dtzkur"><style data-emotion-css="r8rj3w">.css-r8rj3w{font-weight:600;font-size:16px;line-height:24px;color:#424d57;}</style><div class="css-r8rj3w">Join the community</div><style data-emotion-css="1ws0nkq">.css-1ws0nkq{font-weight:400;font-size:12px;line-height:20px;color:#424d57;}</style><div class="css-1ws0nkq">Get in direct contact with us through Discord.</div><style data-emotion-css="652pjx">.css-652pjx:hover{-webkit-text-decoration:none;text-decoration:none;}</style><a href="https://discord.gg/MGFyhbdFxt" target="_blank" rel="noopener noreferrer" class="css-652pjx"><style data-emotion-css="y77wuh">.css-y77wuh{margin-top:5px;}</style><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="20" height="16" viewBox="0 0 20 16" fill="none" xmlns="http://www.w3.org/2000/svg"><g clip-path="url(#clip0_613_10386)"><path d="M16.9308 1.63294C15.6561 1.04804 14.2892 0.617109 12.8599 0.370298C12.8339 0.365535 12.8079 0.377439 12.7945 0.401247C12.6187 0.713926 12.4239 1.12184 12.2876 1.44246C10.7503 1.21232 9.22099 1.21232 7.71527 1.44246C7.57887 1.11471 7.37707 0.713926 7.20048 0.401247C7.18707 0.378233 7.16107 0.366329 7.13504 0.370298C5.70659 0.616321 4.33963 1.04725 3.06411 1.63294C3.05307 1.6377 3.04361 1.64564 3.03732 1.65595C0.444493 5.52959 -0.265792 9.30801 0.0826501 13.0396C0.0842267 13.0578 0.0944749 13.0753 0.108665 13.0864C1.81934 14.3427 3.47642 15.1054 5.10273 15.6109C5.12876 15.6188 5.15634 15.6093 5.1729 15.5879C5.55761 15.0625 5.90054 14.5086 6.19456 13.926C6.21192 13.8919 6.19535 13.8514 6.15989 13.838C5.61594 13.6316 5.098 13.38 4.59977 13.0943C4.56037 13.0713 4.55721 13.015 4.59347 12.988C4.69831 12.9094 4.80318 12.8277 4.9033 12.7451C4.92141 12.7301 4.94665 12.7269 4.96794 12.7364C8.24107 14.2308 11.7846 14.2308 15.0191 12.7364C15.0404 12.7261 15.0657 12.7293 15.0846 12.7443C15.1847 12.8269 15.2895 12.9094 15.3952 12.988C15.4314 13.015 15.4291 13.0713 15.3897 13.0943C14.8914 13.3856 14.3735 13.6316 13.8288 13.8372C13.7933 13.8507 13.7775 13.8919 13.7949 13.926C14.0952 14.5078 14.4381 15.0617 14.8157 15.5871C14.8315 15.6093 14.8599 15.6188 14.8859 15.6109C16.5201 15.1054 18.1772 14.3427 19.8879 13.0864C19.9028 13.0753 19.9123 13.0586 19.9139 13.0404C20.3309 8.72626 19.2154 4.97883 16.9568 1.65674C16.9513 1.64564 16.9419 1.6377 16.9308 1.63294ZM6.68335 10.7674C5.69792 10.7674 4.88594 9.86274 4.88594 8.75167C4.88594 7.6406 5.68217 6.7359 6.68335 6.7359C7.69239 6.7359 8.49651 7.64855 8.48073 8.75167C8.48073 9.86274 7.68451 10.7674 6.68335 10.7674ZM13.329 10.7674C12.3435 10.7674 11.5316 9.86274 11.5316 8.75167C11.5316 7.6406 12.3278 6.7359 13.329 6.7359C14.338 6.7359 15.1421 7.64855 15.1264 8.75167C15.1264 9.86274 14.338 10.7674 13.329 10.7674Z" fill="#424D57"></path></g><defs><clipPath id="clip0_613_10386"><rect width="20" height="15.493" fill="white" transform="translate(0 0.25354)"></rect></clipPath></defs></svg></i><div>Discord</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Follow us</div><div class="css-1ws0nkq">Follow our insightful tweets and interact with our content.</div><a href="https://twitter.com/TextPlatform" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-twitter undefined" viewBox="0 0 24 24"><path d="M22.46 6c-.77.35-1.6.58-2.46.69.88-.53 1.56-1.37 1.88-2.38-.83.5-1.75.85-2.72 1.05C18.37 4.5 17.26 4 16 4c-2.35 0-4.27 1.92-4.27 4.29 0 .34.04.67.11.98C8.28 9.09 5.11 7.38 3 4.79c-.37.63-.58 1.37-.58 2.15 0 1.49.75 2.81 1.91 3.56-.71 0-1.37-.2-1.95-.5v.03c0 2.08 1.48 3.82 3.44 4.21a4.22 4.22 0 0 1-1.93.07 4.28 4.28 0 0 0 4 2.98 8.521 8.521 0 0 1-5.33 1.84c-.34 0-.68-.02-1.02-.06C3.44 20.29 5.7 21 8.12 21 16 21 20.33 14.46 20.33 8.79c0-.19 0-.37-.01-.56.84-.6 1.56-1.36 2.14-2.23z"></path></svg></i><div>Twitter</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contribute</div><div class="css-1ws0nkq">See something that's wrong or unclear? Submit a pull request.</div><a href="https://github.com/livechat/livechat-public-docs" target="_blank" rel="noopener noreferrer" class="css-652pjx"><button class="lc-btn lc-btn--secondary lc-btn--compact css-y77wuh" type="button"><i class="lc-btn__icon lc-btn__icon-left"><svg width="24" height="24" class="rmi rmi-github undefined" viewBox="0 0 24 24"><path d="M12 2A10 10 0 0 0 2 12c0 4.42 2.87 8.17 6.84 9.5.5.08.66-.23.66-.5v-1.69c-2.77.6-3.36-1.34-3.36-1.34-.46-1.16-1.11-1.47-1.11-1.47-.91-.62.07-.6.07-.6 1 .07 1.53 1.03 1.53 1.03.87 1.52 2.34 1.07 2.91.83.09-.65.35-1.09.63-1.34-2.22-.25-4.55-1.11-4.55-4.92 0-1.11.38-2 1.03-2.71-.1-.25-.45-1.29.1-2.64 0 0 .84-.27 2.75 1.02.79-.22 1.65-.33 2.5-.33.85 0 1.71.11 2.5.33 1.91-1.29 2.75-1.02 2.75-1.02.55 1.35.2 2.39.1 2.64.65.71 1.03 1.6 1.03 2.71 0 3.82-2.34 4.66-4.57 4.91.36.31.69.92.69 1.85V21c0 .27.16.59.67.5C19.14 20.16 22 16.42 22 12A10 10 0 0 0 12 2z"></path></svg></i><div>GitHub</div></button></a></div><div class="css-dtzkur"><div class="css-r8rj3w">Contact us</div><div class="css-1ws0nkq">Want to share feedback? Reach us at: <a href="mailto:developers@text.com">developers@text.com</a></div></div></div></div><script id="__NEXT_DATA__" type="application/json">{"props":{"pageProps":{}},"page":"/management/configuration-api","query":{},"buildId":"mT926s0W5VyhfFaApGsyO","assetPrefix":"/docs","runtimeConfig":{},"nextExport":true,"autoExport":true,"isFallback":false}</script><script nomodule="" src="/docs/_next/static/chunks/polyfills-c2dc1d9251306528e50c.js"></script><script src="/docs/_next/static/chunks/webpack-af19fbe32e13fc779465.js" async=""></script><script src="/docs/_next/static/chunks/framework.57a22ac5870571c2eff5.js" async=""></script><script src="/docs/_next/static/chunks/commons.0889bf71124535c6c4cd.js" async=""></script><script src="/docs/_next/static/chunks/main-7bb61c4f8d40f1e634e9.js" async=""></script><script src="/docs/_next/static/chunks/pages/_app-cdbe91fdfdbd305577ef.js" async=""></script><script src="/docs/_next/static/chunks/f66b9295.f9eceaafe4216b86326e.js" async=""></script><script src="/docs/_next/static/chunks/b31dc3a52fd33fe1943f491eae223576a0413e10.ac30430b2138b8fefed8.js" async=""></script><script src="/docs/_next/static/chunks/067aff065064306958fa97cea949633bebf95d70.dede6f8249fbb82aff52.js" async=""></script><script src="/docs/_next/static/chunks/pages/management/configuration-api-1723fba76e329d55e33f.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_buildManifest.js" async=""></script><script src="/docs/_next/static/mT926s0W5VyhfFaApGsyO/_ssgManifest.js" async=""></script></body></html>