CINXE.COM
Sprinklr - Certificate Based Token Generation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en"> <head> <meta http-equiv="content-type" content="text/html; charset=utf-8" /> <link rel="P3Pv1" href="/w3c/p3p.xml" /> <link rel="stylesheet" href='https://cdn.jsdelivr.net/npm/@boomi/exosphere@3.0.0/dist/styles.css' /> <script type="text/javascript" > var csp = ''; var nonce = '700a17f54cc40cfe5021'; //<![CDATA[ var mashery_info = { }; // iframe'd detection, to pop out if in an iframe if (window.location !== parent.window.location && !(/(page|docs|blog)\/preview/.test(window.location.pathname))) { parent.window.location = window.location; } //]]> </script> <title>Sprinklr - Certificate Based Token Generation</title> <link rel="alternate" type="application/rss+xml" href="https://developer.sprinklr.com/docs/feed-comments/authorize/JWT_Token_Generation" /> <link rel="stylesheet" type="text/css" media="screen" href="/files/sprinklr-skin.css" /> <style type="text/css" media="screen"> <!-- #main-wrapper .btn-copy:not(.btn-link){white-space:nowrap;margin-top:5px;padding:.5em .8em;font-size:14px} .hero-text-wrapper{padding-top:7%} .get-support{background:rgba(255,255,255,.5)} #nav-docs h2{display:none;visibility:hidden} #nav-docs ul li{list-style:none} #nav-docs ul>li:first-child{display:none} #nav-docs ul li ul>li:first-child{display:block} #nav-docs ul li a{text-decoration:none;font-weight:500;display:inline-block;margin-bottom:4px} #nav-docs ul li ul li a{font-weight:400} #nav-docs a{color:#000;text-decoration:none} #nav-docs .current-page>.link-block-styled,#nav-docs .current-page>a,#nav-docs>ul>li>a{color:#0069ff} #nav-docs ul li ul{margin-left:1em} #nav-docs li.postman_collection_for_sprinklr_apis{display:none;visibility:hidden} .badge-post{background-color:#2ea2fb} .badge-get{background-color:#3c9} .badge-put{background-color:#ecad00} .badge-delete{background-color:#d149a6} .badge{color:#fff;display:inline-block;padding:.25em .4em;font-size:75%;font-weight:700;line-height:1;text-align:center;white-space:nowrap;vertical-align:baseline;border-radius:.25rem;margin-right:.5em} .endpoint-url{background-color:#f7f7f7;border:1px solid #e5e5e5;margin-bottom:1.5625em;padding:.9375em;color:#6594ac;font-size:20px;border-radius:.5em} td,th{border:1px solid #d7d7e0;padding:15px 20px;letter-spacing:.17px} a.btn.btn-info{margin-top:.25rem;margin-bottom:.25rem;color:#fff;background-color:#8c43ff;border-color:#8c43ff;font-weight:400;text-align:center;vertical-align:middle;-webkit-user-select:none;-moz-user-select:none;-ms-user-select:none;user-select:none;border:1px solid transparent;padding:.375rem .75rem;font-size:1rem;line-height:1.5;border-radius:.25rem;transition:color .15s ease-in-out,background-color .15s ease-in-out,border-color .15s ease-in-out,box-shadow .15s ease-in-out;float:right} a.btn.btn-info:focus,a.btn.btn-info:hover{color:#fff!important;background-color:#8c43ff;border-color:#8c43ff} input.MyButton{position:relative;padding:20px;cursor:pointer;font-weight:700;font-size:150%;background:#5bc0de;color:#fff;border:1px solid #8c43ff;border-radius:10px} .sample-request-header,.sample-response-header{display:-ms-flexbox;display:flex;-ms-flex-align:start;align-items:flex-start;-ms-flex-pack:justify;justify-content:space-between;-ms-flex-align:center;align-items:center;padding:0 1.5rem;border-bottom:1px solid rgba(255,255,255,.2);border-top-left-radius:.3rem;border-top-right-radius:.3rem;background-color:rgba(255,255,255,.2)} .sample-request-title,.sample-response-title{color:#fff;font-size:1rem;font-weight:400;text-transform:capitalize} .sample-request,.sample-response{position:relative;display:-ms-flexbox;display:flex;-ms-flex-direction:column;flex-direction:column;max-width:100%;pointer-events:auto;background-color:#030706;color:#fff;background-clip:padding-box;border:1px solid #e6e9f9;outline:0;margin-bottom:2rem;border-radius:15px;overflow:hidden} .language-json,.sample-request-body,.sample-response-body{position:relative;-ms-flex:1 1 auto;flex:1 1 auto;max-height:500px;overflow-y:auto;background-color:#030706;color:#fff;border-radius:15px} .sample-request-body pre,.sample-response-body pre{color:#fff;background-color:transparent;padding:0 1.5rem} .bd-callout{background:#f2f2f4;border-radius:15px;padding:1.5rem 1.4rem;margin-top:1.25rem;margin-bottom:1.25rem} .bd-callout strong{display:block;font-size:38px;line-height:48px;font-weight:500;margin-bottom:20px} .bd-callout code{background-color:transparent} .bd-callout p{margin:0} .token.punctuation{display:inline} .token.property{display:inline} .token.operator{display:inline} .token.string{display:inline} .token.number{display:inline} .token.boolean,.token.constant,.token.deleted,.token.number,.token.property,.token.symbol,.token.tag{display:inline} .token.attr-name,.token.builtin,.token.char,.token.inserted,.token.selector,.token.string{display:inline} .api-card{background:#fff;border-radius:9px;box-shadow:0 2px 10px 0 rgba(0,0,0,.2);padding:40px 35px 10px;height:100%} .api-card em,.api-card svg{font-size:1.5em;display:block;margin-bottom:.36em;height:1em;width:1.4em;line-height:1} .api-cards-list{display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-pack:center;justify-content:center;margin-right:-12.5px;margin-left:-12.5px} .api-cards-list>li{-ms-flex:0 0 33.333333%;flex:0 0 33.333333%;max-width:33.333333%;padding:12.5px;margin:0} .form-wrapper{background-image:url(/files/contact-blue.png);background-position:center;background-size:cover;border-radius:15px;padding:30px 30px 15px;position:relative} .form-wrapper .form-info{width:100%;padding-right:15px;padding-left:15px} .form-wrapper .form-container{width:100%;float:right;padding-right:15px;padding-left:15px} .after-form-submit{position:absolute;left:0;top:0;right:0;bottom:0;display:-ms-flexbox;display:flex;-ms-flex-wrap:wrap;flex-wrap:wrap;-ms-flex-pack:center;justify-content:center;-ms-flex-align:center;align-items:center;display:none} .after-form-submit .close{position:absolute;cursor:pointer;top:15px;right:25px;font-size:1.5em} .after-form-submit h3{line-height:41px;font-size:36px;margin-bottom:26px} @media (min-width:768px){ .form-wrapper{padding:60px 60px 40px;border-radius:30px} .api-card em{font-size:2em} } @media (min-width:1024px){ .form-wrapper .form-container{max-width:430px;width:40%} .form-wrapper .form-info{max-width:620px;width:60%} .form-wrapper{padding:5%} } .form-wrapper h2{color:#fff;padding-top:0;margin-top:0} .form-wrapper a{color:#fff} .form-wrapper p{font-size:1.1em} .form-group{margin-bottom:20px} .form-control{border:1px solid #6d7278;border-radius:8px;background-color:#fff;font-size:16px;font-weight:400;padding:8px 24px;line-height:2;margin-bottom:0} .custom-checkbox::after{content:"";display:block;clear:both} .custom-checkbox label{font-weight:400;max-width:calc(100% - 1.75em);margin-right:0;float:left} .custom-checkbox input[type=checkbox]{float:left;height:1em;width:1em;margin-right:.75em;margin-top:.3em} .button{outline:0;border-radius:8px;font-size:.75em;text-transform:uppercase;border-style:solid;border-width:1px;padding:.6em 1.5em;line-height:2em;display:block;width:100%} .button-blue{background-color:#1c6cfd;border-color:#1c6cfd;color:#fff} .copyright-section{padding:37px 15px 25px;background-color:#3c4543} .social-links{font-size:2em} .social-links a{position:relative} .social-links a::before{content:"";position:absolute;left:50%;top:50%;transform:translate(-50%,-50%);height:1.75em;width:1.75em;border-radius:50%;transition:all .3s ease;background-color:transparent} .social-links a:hover::before{background-color:rgb(255 255 255 / .15)} #mashery-made{display:none} .loading [type=submit]{position:relative;pointer-events:none} .loading [type=submit]::before{content:"";position:absolute;left:0;top:0;bottom:0;right:0;background-color:rgb(0 0 0 / .4)} .loading [type=submit]::after{content:"";position:absolute;left:50%;top:50%;transform:translate(-50%,-50%);height:1.6em;width:1.6em;border:3px solid #fff;border-radius:50%;border-top-color:transparent;animation-name:btnSpin;animation-duration:1s;animation-iteration-count:infinite;animation-timing-function:linear} @keyframes btnSpin{ 0%{transform:translate(-50%,-50%) rotate(0)} 60%{transform:translate(-50%,-50%) rotate(270deg)} 100%{transform:translate(-50%,-50%) rotate(360deg)} } .rating{display:inline-flex;flex-direction:row-reverse;list-style-type:none;margin:0;padding:0} .rating li{position:relative;cursor:pointer} .rating li.active::after,.rating li.active~li::after,.rating li:hover::after,.rating li:hover~li::after{content:"\2605";position:absolute;left:0;top:0} .rating li.active::before{content:"\2606";position:absolute;animation-name:growStar;animation-duration:.5s} @keyframes growStar{ 0%{opacity:1;transform:scale(1)} 100%{opacity:0;transform:scale(2.5)} } .notifications{position:fixed;top:0;right:0;bottom:0;max-width:300px;pointer-events:none;padding-top:25px} .notification{pointer-events:all;background-color:#1c6cfd;color:#fff;overflow:hidden;border-radius:4px;margin-right:2px;transition:all .3s ease;margin-bottom:15px} .notification-head{padding:6px 15px;background-color:rgb(0 0 0 / .2);line-height:1.15} .notification-body{padding:10px 15px;font-size:16px} .notification.success{background-color:#2fb78a} .notification.danger{background-color:#d1497b} @media (max-width:991px){ .api-cards-list>li{-ms-flex:0 0 50%;flex:0 0 50%;max-width:50%} } @media (max-width:575px){ .api-cards-list>li{-ms-flex:0 0 100%;flex:0 0 100%;max-width:100%} } .descr { font-size: 0.8125em; font-weight: normal; } --> </style> <script src="/public/Mashery/scripts/themes/blackbeard/placeholders.js" type="text/javascript"></script> <script src="/public/Mashery/scripts/Mashery/source/ForumPreview.js" type="text/javascript"></script> <script src="https://kit.fontawesome.com/39e025f811.js" type="text/javascript"></script> <script type="text/javascript"> //<![CDATA[ //]]> </script> <script async src="https://www.googletagmanager.com/gtag/js?id=UA-146355792-1"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'UA-146355792-1'); //]]> </script> <!-- add syntax highlighter --> <script type="text/javascript" > if(window.SyntaxHighlighter != undefined) { // check for syntax highlighter load before using SyntaxHighlighter.all(); } </script> <!-- end syntax highlighter --> <!--[if lt IE 7.]> <link href="/public/Mashery/styles/IE6.css" type="text/css" media="screen" rel="stylesheet" /> <![endif]--> <!--[if IE 7]> <link href="/public/Mashery/styles/IE7.css" type="text/css" media="screen" rel="stylesheet" /> <![endif]--> <!--[if gte IE 8]> <link href="/public/Mashery/styles/IE8.css" type="text/css" media="screen" rel="stylesheet" /> <![endif]--> </head> <body id="page-docs" class="page-docs read en_US"> <!-- PAGE --> <div id="page" class="page read"> <!-- HEADER --> <div id="header" class="header"> <div id="branding" class="branding"> <div id="branding-logo" class="branding-logo"> Sprinklr </div><!-- /branding-logo --> <div id="branding-tagline"> </div><!-- /branding-tagline --> <!--div id="branding-mashery"></div --><!-- /branding-mashery --> </div><!-- /branding --> <div id="search" class="search"> <form id="search-input" class="search-input" method="get" action="/search"> <div> <input id="search-box" class="search-box" type="text" value="" name="q" /> <input id="search-button" class="search-button" type="submit" value="Search" /> </div> </form> </div> </div> <!-- /HEADER --> <div id="user" class="user"> <div id="user-auth" class="user-auth"> </div><!-- /user-auth --> <div id="user-main" class="user-main"> </div><!-- /user-main --> <div id="user-nav" class="user-nav"> <ul> <script > window. addEventListener('load', (event) => { var lastSignOut = document.getElementById("lastSignOut"); if(lastSignOut) { lastSignOut.addEventListener("click", function () { document.getElementById('mashery-logout-form').submit(); }); } }); </script> <li class="first sign-in"> <a href="https://developer.sprinklr.com/login/login?r=https%3A%2F%2Fdeveloper.sprinklr.com%2Fdocs%2Fread%2Fauthorize%2FJWT_Token_Generation&h=41dddcad330b7fef73248030e53ff422">Sign In</a> </li> <li class="register"> <a href="https://developer.sprinklr.com/member/register">Register</a> </li> </ul> </div><!-- /user-nav --> <div id="user-menu"> </div> </div><!-- /user --> <div id="info" class="info" style="display: none;"> </div><!-- /info --> <!-- CONTENT --> <div id="content" class="content"> <div id="main" class="main"> <ul class="pun-nav last"><li class="previous"><span class="label">Previous:</span> <a href="https://developer.sprinklr.com/docs/read/authorize/Enable_Client_Credentials_Grant_Type">Enable Client Credentials Grant Type</a></li><li class="up"><span class="label">Up:</span> <a href="https://developer.sprinklr.com/docs/read/Authorize">Authorize</a></li><li class="next"><span class="label">Next:</span> <a href="https://developer.sprinklr.com/docs/read/authorize/Configure_Access_Token_Using_Postman">OAuth 2.0 for Customers Using Postman</a></li></ul> <h1 class="first">Certificate Based Token Generation</h1> <div class="section"> <div class="section-body"> <p>This documentation walks you through the process of generating an access token using a digital certificate and a private key. It is a certificate-based token generation approach that eliminates the need to store/cache tokens while ensuring secure authentication and information exchange.</p> <h2>Six Steps to Generate Certificate Based Token</h2> Here are the detailed steps that need to be followed for generating the certificate based access token: <h3>1. Generate Key</h3> Generate an environment specific key. Refer to the <a href="https://developer.sprinklr.com/docs/read/api_overview/Getting_Started">Getting Started</a> guide for the detailed steps. <div class="bd-callout bd-callout-info"> <p><strong>Steps to Extract Environment from the UI: </strong></p><ul><li>Login to the Sprinklr's UI platform</li><li>Right click anywhere on the homepage</li><li>Select <code>"View Page Source"</code> from the drop-down menu</li><li>Ctrl+F or Cmd+F <code>"sentry-environment"</code> to find where your Sprinklr's instance is hosted.</li><br> <img src="https://developer.sprinklr.com/files/find_sprinklr_environment.png"></ul></div> <h3>2. Generate Authentication Token</h3> Once you have the key, the next step involves generating an authentication token. Refer to <a href="https://developer.sprinklr.com/docs/read/authorize/OAuth_for_Customers">OAuth 2.0 for Customers</a> guide for the detailed steps. <h3>3. Generate X509 Certificate</h3> This step involves generating X509 Certificate, which will provide: <ul><li>A <code>server.key</code> file to authorize your organization with the auth:jwt:grant command.</li> <li>A <code>server.crt</code> file to create the connected app required by the JWT bearer flow.</li></ul> <h4>How to Generate X509 Certificate?</h4> 1. Generate a private key, and store it in a file called server.key. You can delete the server.pass.key file because you no longer need it.<br> <em>openssl genrsa -des3 -passout pass:SomePassword -out server.pass.key 2048 openssl rsa -passin pass:SomePassword -in server.pass.key -out server.key</em> 2. Generate a certificate signing request using the server.key file. Store the certificate signing request in a file called server.csr. Enter information about your company when prompted.<br> <em>openssl req -new -key server.key -out server.csr</em> 3. Generate a self-signed digital certificate from the server.key and server.csr files. Store the certificate in a file called server.crt.<br> <em>openssl x509 -req -sha256 -days 365 -in server.csr -signkey server.key -out server.crt</em> 4. Generate the key in .der format from .key(.der key will be used in step 4 Java Code)<br> <em>openssl pkcs8 -topk8 -inform PEM -outform DER -in server.key -out server.der -nocrypt</em> <h3>4. Generate JWT Token</h3> This step involves generating a JWT Token that needs to be used as the refresh token in the authentication process. <div class="bd-callout bd-callout-info"> <p><strong>Dev Notes: </strong>The generated JWT Token should not be cached/stored by the user in any way. The user should generate this new JWT Token each time to get a new access token.</p></div> <img src="https://developer.sprinklr.com/files/JWT.png"> <div class="bd-callout bd-callout-info"> <p><strong>Dev Notes: </strong>Must Know Conventions:</p><ul><li>{iss} : <code>issuer</code> - App ID (generated using step 5)</li><li>{sub}: <code>subject</code> - Sprinklr’s instance login username</li><li>{aud}: <code>audience</code> - https://www.sprinklr.com/</li></ul></div> <h3>5. App Registration</h3> <p>This step involves executing an API call for app registration. The API details are mentioned as follows:</p> <h2>Method Type</h2> <div class="endpoint-url"> <b><code>POST</code></b></div> <h2>API Endpoint</h2> <div class="endpoint-url"> https://api2.sprinklr.com<code>/{{env}}/</code>api/app/register </div> <h3>Headers</h3> <p>API headers include the mandatory information you send along with the request URL and body. This information helps provide insights into request context and authorization credentials that, in turn, allows access to protected resources.</p> <table> <thead> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>Authorization</td> <td><code>Bearer {{token}}</code></td> <td>Credential used by the API to authenticate a user with the server<br><br>For generating authorization token, refer to <a href="https://developer.sprinklr.com/docs/read/Authorize">Authorize</a> section on the developer portal</td> </tr> <tr> <td>X-API-KEY</td> <td><code>api-key</code></td> <td>API key helps authenticate the application with the server<br><br>For generating API key, refer to <a href="https://developer.sprinklr.com/docs/read/api_overview/Getting_Started">Getting Started</a> guide</td> </tr> <tr> <td>Content-Type</td> <td><code>application/json</code></td> <td>Content-Type is a representation header that determines the type of data (media/resource) present in the request body</td> </tr> </tbody> </table> <h3>Request Parameters</h3> <table> <thead> <tr> <th>Parameter</th> <th>Required/Optional</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>X509 certificate(server.crt)</td> <td>Required</td> <td>This is the digital certification. You upload this file when you create the connected app required by the JWT bearer flow.<br><br>The JWT token uses a public/private key pair in the form of a X.509 certificate for signing</td> <td>String</td> </tr> </tbody> </table> <h2>Example - Request</h2> <div class="sample-request"> <div class="sample-request-header"> <h4 class="sample-request-title">Request</h4> <button class="btn-copy">Copy</button> </div> <div class="sample-request-body"> <pre><code class="lang-php">curl -X POST \ https://api2.sprinklr.com/{{env}}/api/app/register \ -H 'Authorization: Bearer {{Enter your Access Token}}' \ -H 'Key: {{Enter your API KEY}}' \ -H 'Content-Type: application/json' \ -d ' -----BEGIN CERTIFICATE----- MIIDeDCCAmACCQDSxQ6ZAucMNDANBgkqhkiG9w0BAQsFADB+MQswCQYDVQQGEwJV UzELMAkGA1UECAwCQ0ExFjAUBgNVBAcMDU1vdW50YWluIFZpZXcxDzANBgNVBAoM Bkdvb2dsZTERMA8GA1UECwwIM1AgVHJ1c3QxJjAkBgkqhkiG9w0BCQEWFzNwLXRy dXN0LWVuZ0Bnb29nbGUuY29tMB4XDTIyMDcxMjE5MDMzNVoXDTIzMDcxMjE5MDMz NVowfjELMAkGA1UEBhMCVVMxCzAJBgNVBAgMAkNBMRYwFAYDVQQHDA1Nb3VudGFp biBWaWV3MQ8wDQYDVQQKDAZHb29nbGUxETAPBgNVBAsMCDNQIFRydXN0MSYwJAYJ KoZIhvcNAQkBFhczcC10cnVzdC1lbmdAZ29vZ2xlLmNvbTCCASIwDQYJKoZIhvcN AQEBBQADggEPADCCAQoCggEBAMV3AkcrG2t8WO6gU6hokvIv4wjOhF+Gk/s5MaqK qMW+JTltwH2HtO2u8Yl9+iYpzx8GnT2EVUPqwe8bO0knW8w1X1zcv7wTrPmheEc2 Zeog00+c9qUBZ/C01Qn5e9gkiwI31/iOBQx8YNyfAynizoO0MxQRyIe2AEnYufn3 NhURzRxTiz8m+fliJa+wEllZErs0eCr6UpspBLdcwN5d+YL9tLOM6pgL0HAaerMI 3c5WrapyORCsdAczhqC+OBqEj+uMZxRFlil9BXxV41jRCAuw9Tj1elhuiFYOZ2aA t4ZZs/qAKB3JpdyihHN14sLD/GByKysTjE/20spZaexvj3ECAwEAATANBgkqhkiG 9w0BAQsFAAOCAQEAVCWib5EMECvNeqExsqsoAPZ82fJV5k71bHRSBoj+0q9m3NK8 1vfKwLo571gPQKR1sgpRMeCkTMM6ZLw2Yms4Le3thw1CJVLuryBQ6CVYqWATGnQy 9C45iemb8VTqcs3Qq4y13wgJyFvp0vKZLG3dgW4/ZAPJ3HvTABEfNqf8+J7a3TeT luRI8zNMAM2PU16Bkz9LLJgZktQzAe5qa80lJKIK2GaBjm5HdwkPEhxYtqQS7mfY y9Hjpky4ne+AReLY73XZ9DqQvzJykDqVTd0C5r/1VkgDMhrcmcgYjT8zZZbWgxcA QCbOK7Zao8r0l8aJ94V+uyTMX1c9HlzTYRjzGw== -----END CERTIFICATE-----' </code> </pre> </div> </div> <h2>Example - Response</h2> <div class="sample-response"> <div class="sample-response-header"> <h4 class="sample-response-title">Response</h4> </div> <div class="sample-response-body"> <pre><code class="lang-json"> { "data":"eyJwSWQiOjgwMDAwLCAidElkIjoxNjU4MTI4NTUyMTA2fQ\u003d\u003d", "Errors": [] } </code> </pre> </div> </div> <h3>ResponseParameters</h3> <table> <thead> <tr> <th>Parameter</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>App Id</td> <td>Id associated with the registered app.<br><br>Used for creating the JWT powered access token and can also be used to update the certificate if required.</td> <td>String</td> </tr> </tbody> </table> <div class="bd-callout bd-callout-info"> <p><strong>Dev Notes: </strong>App Id is static and thus can be reused when regenerating the access token.</p></div> <h3>6. Generating Certificate-Based Access Token</h3> <p>This step involves executing an API call for certificate-based token generation. The API details are mentioned as follows:</p> <h2>Method Type</h2> <div class="endpoint-url"> <b><code>POST</code></b></div> <h2>API Endpoint</h2> <div class="endpoint-url"> https://api2.sprinklr.com/<code>{{env}}</code>/oauth/apptoken/{appid}</div> <div class="bd-callout bd-callout-info"> <p><strong>Dev Notes: </strong>Replace the refresh token with the JWT token in the above API endpoint.</p></div> <h3>Headers</h3> <p>API headers include the mandatory information you send along with the request URL and body. This information helps provide insights into request context and authorization credentials that, in turn, allows access to protected resources.</p> <table> <thead> <tr> <th>Key</th> <th>Value</th> <th>Description</th> </tr> </thead> <tbody> <tr> <td>key</td> <td><code>api-key</code></td> <td>API key helps authenticate the application with the server<br><br>For generating API key, refer to <a href="https://developer.sprinklr.com/docs/read/api_overview/Getting_Started">Getting Started</a> guide</td> </tr> <tr> <td>Content-Type</td> <td><code>application/x-www-form-urlencoded</code></td> <td>Content-Type is a representation header that determines the type of data (media/resource) present in the request body</td> </tr> </tbody> </table> <h3>Path Parameters</h3> <table> <thead> <tr> <th>Parameter</th> <th>Required/Optional</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>appId</td> <td>The appid you received in the response of the API call made in step 6</td> <td>String</td> </tr> </tbody> </table> <h3>Query Parameters</h3> <table> <thead> <tr> <th>Parameter</th> <th>Required/Optional</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td>client_id</td> <td>Required</td> <td>The API key you generated using Getting Started guide</td> <td>String</td> </tr> <tr> <td>client_secret</td> <td>Required</td> <td>The secret you received upon application registration. This can be found in the Sprinklr Development Portal under My Account.</td> <td>String</td> </tr> <tr> <td>redirect_uri</td> <td>Required</td> <td>The exact Register Callback URL you listed upon creation of your application.<br><br><b>Example</b>: https://www.google.com/</td> <td>Url</td> </tr> <tr> <td>grant_type</td> <td>Required</td> <td>Set the grant type to:<br><br><code>authorization_code</code></td> <td>String</td> </tr> <tr> <td>refresh_token</td> <td>Required</td> <td>Use the JWT token generated at your end<br><br>JSON web tokens consist of three parts — header, payload and signature.<br><br>The JWT token is separated by dots (.). The syntax looks something like this: xxx.yyyy.zzzzz</td> <td>String</td> </tr> </tbody> </table> <h2>Example - Request</h2> <div class="sample-request"> <div class="sample-request-header"> <h4 class="sample-request-title">Request</h4> <button class="btn-copy">Copy</button> </div> <div class="sample-request-body"> <pre><code class="lang-php">curl -X POST \ 'https://api2.sprinklr.com/{{env}}/oauth/apptoken/{appid}?client_id={{apikey}}&client_secret={{secret}}&redirect_uri={{redirect_uri}}&grant_type=authorization_code&refresh_token={{JWT_token}}' \ -H 'Content-Type: application/json' \ -H 'key: {{apikey}}' </code></pre> </div> </div> <h2>Example - Response</h2> <div class="sample-response"> <div class="sample-response-header"> <h4 class="sample-response-title">Response</h4> </div> <div class="sample-response-body"> <pre><code class="lang-json"> { "access_token":"{{Certificate Based Authentication Token}}", "token_type":"Bearer", "Expires_in":{{expiry time in seconds}} } </code> </pre> </div> </div> <h3>Response Parameters</h3> <table> <thead> <tr> <th>Parameter</th> <th>Description</th> <th>Type</th> </tr> </thead> <tbody> <tr> <td><code>{{access_token}}<code></code></code></td> <td>The JWT powered access token</td> <td>String</td> </tr> <tr> <td><code>{{token_type}}</code></td> <td><code>Bearer</code></td> <td>String</td> </tr> <tr> <td><code>{{expires_in}}</code></td> <td>Token expiry duration in seconds</td> <td>Epoch</td> </tr> </tbody> </table> <div class="bd-callout bd-callout-info"> <p><strong>Dev Notes: </strong>Once the certificate token is generated using the last step, the token generated using OAuth 2.0 for Customers, will no longer be active/valid.</p></div> <hr> <div style="border: 2px solid; padding: 20px; margin: 20px; height: 100px; background-color: #F2F3F4 ;"> <p style="text-align: center; font-size: 20px;"><b>Need assistance? Fill out our <a href="https://forms.office.com/r/5wTBFPQ7DC">feedback form</a> and we’ll get back to you. </b></p> </div> </div> <div class="section-meta"> <p> <span class="revision">version 43</span> <span class="timestamp">as of <abbr title="8/16/24 2:19 am">7 months ago</abbr></span> <span class="moniker">by <span class="user-reference">Neha.TechWriter</span></span></p> </div> <ul class="pun-nav last"><li class="previous"><span class="label">Previous:</span> <a href="https://developer.sprinklr.com/docs/read/authorize/Enable_Client_Credentials_Grant_Type">Enable Client Credentials Grant Type</a></li><li class="up"><span class="label">Up:</span> <a href="https://developer.sprinklr.com/docs/read/Authorize">Authorize</a></li><li class="next"><span class="label">Next:</span> <a href="https://developer.sprinklr.com/docs/read/authorize/Configure_Access_Token_Using_Postman">OAuth 2.0 for Customers Using Postman</a></li></ul> </div> </div><!-- /main --> <!-- SUB --> <div id="sub" class="sub"> <h2>Docs Navigation</h2> <ul> <li class="active"><a href="https://developer.sprinklr.com/docs/read/Home">Getting Started</a></li> <li><a href="https://developer.sprinklr.com/docs/read/API_Overview">API Overview</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_overview/Getting_Started">Getting Started</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_overview/Register_on_Developer_Portal">Developer Portal Registration</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_overview/How_to_Generate_API_Key">How to Generate API Key and Secret</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_overview/Postman_Collection">Postman Collection</a></li> </ul> </li> <li class="active"><a href="https://developer.sprinklr.com/docs/read/Authorize">Authorize</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/authorize/OAuth_for_Customers">OAuth 2.0 for Customers</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/OAuth_20_SSO_for_Partners">OAuth 2.0 - SSO for Partners</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/OAuth_Quick_Start_Guide">OAuth 2.0 Quick Start Guide</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/Enable_Client_Credentials_Grant_Type">Enable Client Credentials Grant Type</a></li> <li class="active"><a href="https://developer.sprinklr.com/docs/read/authorize/JWT_Token_Generation" class="active">Certificate Based Token Generation</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/Configure_Access_Token_Using_Postman">OAuth 2.0 for Customers Using Postman</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/Refreshing_Access_Token">Refreshing Access Token</a></li> <li><a href="https://developer.sprinklr.com/docs/read/authorize/Authorization__Troubleshooting_Guide">Authorization - Troubleshooting Guide</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_error_codes">REST API Error and Status Codes</a></li> <li><a href="https://developer.sprinklr.com/docs/read/Sprinklr_v1_v2_Mapping_Guide">API v1 to v2 Mapping</a></li> <li><a href="https://developer.sprinklr.com/docs/read/API_Tutorials">Integration Blueprints</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Reporting_Blueprint">Reporting - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Case_Lifecycle__CRM_Integration_Blueprint">Case Lifecycle - CRM Integration Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Omnichannel_Handover_Protocol__Blueprint">Omnichannel Handover Protocol - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Source_Agnostic_Blueprint">Source Agnostic - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/User_Provisioning__Blueprint">User Provisioning - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/IVR_Deflection__Blueprint">IVR Deflection - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Engagement_Dashboards__Blueprint">Engagement Dashboards - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Digital_Asset_Management__Blueprint">Digital Asset Management - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Custom_Entity__Blueprint">Custom Entity - Blueprint</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_tutorials/Publishing__Blueprint">Publishing - Blueprint</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/Webhooks">Sprinklr Webhooks</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Webhook_Types">Webhook Types</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Create_Subscription">Create Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Verify_Subscription">Verify Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Activate_Subscription">Activate Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Read_Subscription">Read Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Update_Subscription">Update Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Deactivate_Subscription">Deactivate Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Delete_Subscription">Delete Subscription</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Callback_Url_Verification">Callback Url Verification Check</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Webhook_Retries_Logic">Webhook Retries Logic</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/Webhook_Response_Payload">Webhook Response Payloads</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Case_Webhooks">Case Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Message_Webhooks">Message Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/SAM_Webhooks">SAM Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Profile_Webhooks">Profile Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Workflow_Updated">Workflow Updated Webhook</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Comment_Webhooks">Comment Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Campaign_Webhooks">Campaign Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Asset_Webhooks">Asset Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Thread_Control_Webhook">Thread Control Webhook</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Task_Webhooks">Task Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Recommendation_Webhook">Recommendation Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Draft_Webhooks">Draft Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Account_Webhooks">Account Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Source_Agnostic_Message_Webhooks">Source Agnostic Message Webhook</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Voice_Call_Event_Updates_Webhook">Voice Call Event Updates Webhook</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/User_Current_State_Webhook">User Current State Webhook</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Template_Asset_Webhooks">Template Asset Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/User_Webhooks">User Webhooks</a></li> <li><a href="https://developer.sprinklr.com/docs/read/webhooks/webhook_response_payload/Work_Queue_Webhooks">Work Queue Webhooks</a></li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/API_20">API 2.0</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Account_API">Account</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Fetch_Account">Read Account</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Fetch_Account_by_Channel_Id">Read Account by Channel Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Update_Custom_Properties">Update Custom Properties</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Update_Custom_Properties__Partial">Update Custom Properties - Partial</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Update_Account_Visiblity">Update Account Visibility</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/account_api/Deactivate_Account">Deactivate Account</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api">Advocacy Community</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api/Fetch_Project_Id">Fetch Project Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api/Fetch_Screener_Questions">Fetch Screener Questions</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api/Fetch_Screener_Answers">Fetch Screener Answers</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api/Find_Users_Using_project_Id">Find Users Using Project Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/advocacy_community_api/Update_Community_User">Update Community User</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Asset_Group">Asset Group</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/asset_group/Create_Asset_Group">Create Asset Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/asset_group/Fetch_Asset_Group">Read Asset Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/asset_group/Update_Asset_Group">Update Asset Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/asset_group/Delete_Asset_Group">Delete Asset Group</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/audit_api">Audit</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/audit_api/Fetch_Audit_Details_by_Cursor">Fetch Audit Details by Cursor</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/audit_api/Audit_API">Audit API</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Bulk_Import">Bulk Import Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Campaign_API">Campaign</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/Create_Campaign">Create Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/Fetch_Campaign">Read Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/Update_Campaign">Update Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/Delete_Campaign">Delete Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/Fetch_All_Campaign">Fetch All Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/External_Update_Campaign">External Update Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/External_Fetch_Campaign">External Read Campaign</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_api/External_Delete_Campaign">External Delete Campaign </a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_briefs">Campaign Brief</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/campaign_briefs/Untitled">Create Campaign Brief</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Case_API">Case </a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Create_Case">Create Case</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Fetch_Case_by_Case_Number">Read Case by Case Number</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Fetch_Case_by_Channel_Case_Id">Read Case by Channel Case Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Fetch_Case_by_Channel_Case_Number">Read Case by Channel Case Number</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Case_Associated_Messages">Case Associated Messages </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Fetch_Case_by_Case_Id">Read Case by Case Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Case_Update_API">Case Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Delete_Case">Delete Case Using Case Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Delete_Case_Using_Case_Number">Delete Case Using Case Number</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Create_Case_Via_Profile">Create Case Via Profile</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Create_Case_Via_Profile__Bulk">Create Bulk Cases Via Profile</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Update_Channel_Case_Details">Update Channel Case Details</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/case_api/Merge_Cases">Merge Cases</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/client_api">Fetch Accessible Workspaces</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api">Comment (Note)</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api/Add_Comment">Add Comment</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api/Fetch_Comment">Read Comment</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api/Update_Comment">Update Comment</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api/Delete_Comment">Delete Comment</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/comment_api/Add_Multiple_Comments">Add Multiple Comment Attachments</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/CRM_USER_MAPPING">CRM User Mapping</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Fetch_CRM_User_Mapping">Fetch CRM User Mapping</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Fetch_and_Download_CRM_User_Mapping">Fetch and Download CRM User Mapping</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Fetch_CRM_User_Mapping_Using_CRM_User_Ids">Fetch CRM User Mapping Using CRM User Ids</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Fetch_CRM_User_Mapping_Using_SPR_User_Ids">Fetch CRM User Mapping Using SPR User Ids</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Add_CRM_User_Mapping">Add CRM User Mapping</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Create_Update_CRM_User_Mappings">Create/Update CRM User Mappings</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Create_Update_User_Mapping__Bulk">Create/Update User Mapping - Bulk</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Create_Update_User_Mapping__From_File">Create/Update User Mapping - From File</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/crm_user_mapping/Delete_CRM_User_Mapping">Delete CRM User Mapping</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Custom_Entity">Custom Entity</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Create_Entity_Definition">Create Entity Definition</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_Entity_Definition">Fetch Entity Definition</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_All_Entity_Definitions">Fetch All Entity Definitions</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Update_Entity_Definition">Update Entity Definition</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Create_Custom_Entity_Field">Create Entity Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_Entity_Fields">Fetch Entity Fields</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Update_Custom_Entity_Field">Update Custom Entity Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Delete_Custom_Entity_Field">Delete Custom Entity Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Create_Custom_Entity">Create Custom Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_Custom_Entity">Fetch Custom Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Search_Custom_Entity_Using_Filters">Search Custom Entity Using Filters</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Update_Custom_Field">Update Custom Entity (Partial)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Update_Custom_Entity">Update Custom Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Create_Update_Custom_Entity">Create/Update Custom Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Delete_Custom_Entity">Delete Custom Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Create_Custom_Entity_Trigger">Create Custom Entity Trigger</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_Custom_Entity_Trigger">Fetch Custom Entity Trigger</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Fetch_Custom_Entity_Triggers">Fetch All Custom Entity Triggers</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Update_Custom_Entity_Trigger">Update Custom Entity Trigger</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Enable_Disable_Custom_Entity_Trigger">Enable/Disable Custom Entity Trigger</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_entity/Delete_Custom_Entity_Trigger">Delete Custom Entity Trigger</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Custom_Fields_API">Custom Field</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_fields_api/Create_Custom_Field">Create Custom Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_fields_api/Fetch_Custom_Field_Using_Field_Name">Fetch Custom Field Using Field Name</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_fields_api/Update_Custom_Field">Update Custom Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/custom_fields_api/Update_Delete_Custom_Field_Values">Update Options with Label</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Template_API">Content Template</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/template_api/Get_Content_Template">Fetch User-Created Content Template Details </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/template_api/Fetch_Standard_Content_Template_Details">Fetch Standard Content Template Details</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/template_api/Fetch_Content_Template_Id_and_Name">Fetch Content Template Details Using Sorting and Filters</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/template_api/Fetch_Content_Template_Details_by_Channel_Type">Fetch Content Template Details by Channel Type</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Data_Ingestion_API">Data Ingestion</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/data_ingestion_api/Bulk_Profile">Bulk Profile</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/data_ingestion_api/Bulk_Messages">Bulk Messages</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/deflection_api">Deflection</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Email_API">Create Email </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Intuition_API">Intuition </a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Text_Predict"> Text Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Text_Batch_Predict"> Text Batch Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Product_Insights_Predict">Product Insights Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Product_Insights_Batch_Predict">Product Insights Batch Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Location_Insights_Predict">Location Insights Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Location_Insights_Batch_Predict">Location Insights Batch Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Intent_Predict">Intent Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Intent_Batch_Predict">Intent Batch Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Visual_Insight">Visual Insight Predict</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/intuition_api/Visual_Batch_Predict">Visual Insight Batch Predict</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Trigger_Customer_Journey">Journey Facilitator</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/trigger_customer_journey/Trigger_Customer_Journey__New_Profile">Trigger Customer Journey</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/trigger_customer_journey/Trigger_Customer_Journeys">Trigger Customer Journeys - Bulk</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/trigger_customer_journey/Search_Journeys">Search Customer Journeys</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api">Knowledge Base</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Create_Knowledge_Base_Article">Create Knowledge Base Article</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Update_Knowledge_Base_Article">Update Knowledge Base Article</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Delete_Knowledge_Base_Article">Delete Knowledge Base Article</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Read_Content_by_Content_Id">Read Content by Content Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Read_Content_By_Ids_Bulk">Read Content By Ids (Bulk)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Search_Knowledge_Base_Content">Search Knowledge Base Content</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Read_Folder_by_Folder_Id">Read Folder by Folder Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Search_Folder_Category">Search Folder (Category)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Get_Version_History_by_Id">Get Version History by Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Search_Version_History">Search Version History</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Get_Content_by_Migration_Details">Get Content by Migration Details</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Save_Knowledge_Base_Content">Save Knowledge Base Content</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/knowledgebase_api/Find_Linked_Assets">Find Linked Assets</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lead_api">Lead</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lead_api/Create_Update_Lead_Event">Create/Update Lead Event</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lead_api/Create_Update_Bulk_Lead_Event">Create/Update Bulk Lead Event</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lead_api/Create_Update_Lead">Create/Update Lead</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lead_api/Create_Update_Bulk_Leads">Create/Update Bulk Leads</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Live_Stream_Chat">Live Stream Chat</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/live_stream_chat/Create_Update_Live_Chat_Event">Create/Update Live Chat Event</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/live_stream_chat/Fetch_Live_Stream_Chat_Events">Fetch Live Stream Chat Events</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/live_stream_chat/fetch_Live_Stream_Chat_Event">Fetch Live Stream Chat Event</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/live_stream_chat/Start_Event_API">Start Live Stream Chat Event</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/live_stream_chat/End_Live_Stream_Chat_Event">End Live Stream Chat Event</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lookup_api_20">Lookup</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lookup_api_20/Generic_Lookup">Lookup By Dimension</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/lookup_api_20/Lookup_By_Id">Lookup By Id</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Listening_API">Listening</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/Topic">Topic</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic/Create_Topic">Create Topic</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic/Read_Topic">Read Topic</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic/Update_Topic">Update Topic</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic/Delete_Topic">Delete Topic</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/Topic_Group">Topic Group</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_group/Create_Topic_Group">Create Topic Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_group/Read_Topic_Group">Read Topic Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_group/Update_Topic_Group">Update Topic Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_group/Delete_Topic_Group">Delete Topic Group</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_group/Fetch_All_Topic_Group">Fetch All Topic Groups</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/Keyword_Group">Keyword List</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/keyword_group/Create_Keyword_List">Create Keyword List</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/keyword_group/Fetch_All_Keyword_Lists">Fetch All Keyword Lists</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/keyword_group/Read_Keyword_List">Read Keyword List</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/keyword_group/Update_Keyword_List">Update Keyword List</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/keyword_group/Delete_Keyword_List">Delete Keyword List</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/Theme">Theme</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/theme/Create_Theme">Create Theme</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/theme/Read_Theme">Read Theme</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/theme/Update_Theme">Update Theme</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/theme/Delete_Theme">Delete Theme</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/Topic_Backfill">Topic Backfill</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_backfill/Create_Backfill">Create Backfill</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_backfill/Read_Backfill">Read Backfill </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_backfill/Accept_Backfill">Accept Backfill</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/listening_api/topic_backfill/Cancel_Backfill">Cancel Backfill</a></li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/macro_api">Macro API</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/macro_api/Apply_Macro">Apply Macro</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Me_API_20">Me API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20">Message</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Fetch_Message_by_ID">Read Message by ID</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Read_Message_by_UMID">Read Message by UMID</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Message_Action">Message Action</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Message_Conversations">Message Conversations</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Read_Messages_Bulk">Read Messages (Bulk)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Message_Read_Validation">Mark Message as Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/messages_api_20/Update_Message_Properties">Update Message Properties</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Media_Upload_API">Media Upload</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis">Participant APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Create_Participant_API">Create Participant API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Update_Account_Participant">Update Account Participant</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Update_Primary_Participant">Update Primary Participant </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Fetch_All_Participants">Fetch All Participants</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Fetch_Participant_Using_Participant_Id">Fetch Participant Using Participant Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/participant_apis/Delete_Participant">Delete Participant</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Profile_API">Profile </a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Create_Update_Universal_Profile">Create/Update Universal Profile</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Fetch_Profile_by_sntype_and_snUserId">Fetch Profile by sntype and snUserId</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Fetch_Profile_by_Profile_Id">Fetch Profile by Profile Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Profile_Conversations">Fetch Profile Conversations</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Search_Profile_by_sntype_and_username">Fetch Profile by sntype and username</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/profile_api/Update_Profile_List">Update Profile List</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Publishing_API">Publishing</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Create_Draft">Create Draft</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Schedule_Draft">Schedule Draft</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Update_Draft">Update Draft</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Delete_Draft">Delete Draft</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Publishing_Message">Publishing Message</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Publishing_Post">Publishing Post</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Delete_Post">Delete Post</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Publishing_Reply">Publishing Reply</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Publishing_SMS">Publishing SMS</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Publishing_Email">Publishing Email</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Update_Outbound_Post_Custom_Properties">Update Outbound Post Custom Properties</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Read_Post_by_Post_Ids">Read Post by Post Ids</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_api/Read_Draft">Read Draft </a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Publishing_Dynamic_Templates">Publishing Template</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/Sprinklr_Live_Chat_Templates">Sprinklr Live Chat Templates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/WhatsApp_Dynamic_Templates">WhatsApp Dynamic Templates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/Instagram_Dynamic_Templates">Instagram Dynamic Templates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/Facebook_Dynamic_Templates">Facebook Dynamic Templates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/Twitter_Dynamic_Templates">Twitter Dynamic Templates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/publishing_dynamic_templates/Apple_Business_Chat">Apple Business Chat Templates</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Product_API">Product Catalog</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/product_api/Create_Product">Create Product</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/product_api/Read_Product">Read Product</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/product_api/Update_Product">Update Product</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/product_api/Delete_Product">Delete Product</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api">Reporting</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Custom_Query">Custom Query</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Custom_Query_Using_Widget_Id">Custom Query Using Widget Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Batch_Query">Batch Query</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Fetch_Reporting_Engines">Fetch Reporting Engines</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Fetch_Report_Name">Fetch Report Names</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Fetch_Custom_Metrics">Fetch Custom Metrics</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/reporting_api/Fetch_Metrics_and_Dimensions">Fetch Metrics and Dimensions</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/SAM_API">Sprinklr Asset Manager </a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Create_Social_Asset">Create Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Fetch_Social_Asset">Read Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Update_Social_Asset">Update Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Delete_Social_Asset">Delete Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Secure_Media_Download">Resolve Media API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Secure_Media_Download__Bulk">Secure Media Download - Bulk</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Asset_Import_via_Url">Asset Import via Url</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sam_api/Asset_Import_Async">Asset Import Async</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/SCIM">User APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Create_User">Create User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Create_Update_User">Create/Update User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Bulk_Create_Update_User">Bulk Create/Update User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Fetch_User">Read User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Fetch_User_by_Email_ID">Read User by Email ID</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/User_Update">User Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Delete_User">Delete User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Partial_User_Update">Partial User Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim/Update_Agent_Status">Update Agent Status</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/SCIM_20">SCIM (User) APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim_20/Create_User">Create User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim_20/Read_User">Read User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim_20/Update_User">Update User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim_20/Delete_User">Delete User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/scim_20/Search_User">Search Users</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Skills_API">Skill</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/skills_api/Fetch_Skills_and_Proficiency">Fetch Skills and Proficiency</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/skills_api/Update_Remove_Skills">Update Proficiency/Remove Skills</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Search_api">Search</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/search_api/Search_by_Entity"> Search by Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/search_api/Search_by_Cursor">Search by Cursor</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Source_Agnostic_API">Source Agnostic Message</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/source_agnostic_api/Source_Agnostic__Send_Message">Source Agnostic - Send Message</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/source_agnostic_api/Source_Agnostic__Close_Conversation">Source Agnostic - Close Conversation</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Standard_Entity">Standard Entity</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Definition">Fetch Standard Entity Definition</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Create_Standard_Entity_Field">Create Standard Entity Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Fields">Fetch Standard Entity Fields</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Field_Using_apiName">Fetch Standard Entity Field Using apiName</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Update_Standard_Entity_Field">Update Standard Entity Field</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Create_Standard_Entity">Create Standard Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Using_Entity_Id">Fetch Standard Entity Using Entity Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Using_Primary_Key_Prefix">Fetch Standard Entity Using Primary Key Prefix</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Fetch_Standard_Entity_Using_Primary_Key">Fetch Standard Entity Using Primary Key </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Update_Standard_Entity">Update Standard Entity Using Entity Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Update_Standard_Entity_Partial">Update Standard Entity (Partial)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Delete_Standard_Entity">Delete Standard Entity</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Create_Update_Standard_Entity">Create/Update Standard Entity Using Entity Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/standard_entity/Create_Update_Standard_Entity_Using_Primary_Key">Create/Update Standard Entity Using Primary Key</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Stream_API">Engagement Dashboard</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Fetch_Engagement_Dashboards">Fetch Engagement Dashboards</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Fetch_Engagement_Dashboard_by_Name">Fetch Engagement Dashboard by Name</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Outbound_Columns">Outbound Column Stream</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Inbound_Columns">Inbound Column Stream</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Stream_Cursor_API">Stream Cursor API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Case_Stream">Case Management Stream</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/stream_api/Fetch_UGC_Stream_Data">Fetch UGC Stream Data</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/support_ticket_api">Support Ticket</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/support_ticket_api/Create_Support_Ticket">Create Support Ticket</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/support_ticket_api/Fetch_Support_Case_Custom_Fields">Fetch Support Case Custom Fields</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Suppression_List">Supression List</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/suppression_list/Add_Contact_in_Supression_List">Add Contact in Suppression List</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/suppression_list/Bulk_Add_Contacts_in_Suppression_List">Bulk Add Contacts in Suppression List</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/suppression_list/Remove_Contact_from_Suppression_List">Remove Contact from Suppression List</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Thread_Control_API">Thread Control</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/thread_control_api/Pass_Control">Pass Control </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/thread_control_api/Release_Control">Release Control</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/thread_control_api/Acquire_Control">Acquire Control</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/thread_control_api/Check_Control">Check Control</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Task_API">Task</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/task_api/Create_Task">Create Task</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/task_api/Read_Task">Read Task</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/task_api/Update_Task">Update Task</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/task_api/Delete_Task">Delete Task</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice">Sprinklr Voice</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Fetch_All_Work_Queues">Fetch All Work Queues</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Fetch_Work_Queue_Stats">Fetch Work Queue Stats</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Fetch_Time_Slots">Fetch Time Slots</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Schedule_Callback">Schedule Callback</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Update_Callback_Details">Update Callback</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Cancel_Callback">Cancel Callback</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/sprinklr_voice/Fetch_Recording">Fetch Voice Recording </a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Conversational_AI">Sprinklr Bot</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/conversational_ai/Trigger_Bot_Application">Trigger Bot Application</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Shortener_API">URL Shortener</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/shortener_api/Read_URL_Shorteners">Read URL Shorteners</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/shortener_api/Shorten_Link">Create URL Shortener</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/Webhook_Replay"> Webhook Replay and Retrieve</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_20/webhook_replay/Webhook_Replay">Webhook Replay</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_20/webhook_replay/Retrieve_Failed_Webhooks">Retrieve Failed Webhook Events</a></li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10">API 1.0</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Audit_Fetch_API">Audit</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/audit_fetch_api/Audit_API">Audit API</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/bootstrap_resources">Bootstrap Resources</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/bootstrap_resources/Bootstrap_Resources">Bootstrap Resources</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/bootstrap_resources/Accounts">Accounts</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/bootstrap_resources/Channels">Channels</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/bootstrap_resources/Queues">Queues</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/campaigns">Campaign</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/campaigns/Create_Campaign">Create Campaign</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases">Case</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Create">Case Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Read">Case Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Search">Case Search</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Update">Case Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Delete">Case Delete</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/cases/Case_Create_Via_Profile">Case Create Via Profile</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/comments">Comment (Note)</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/comments/Comment_Search">Comment Search</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/create_short_url">URL Shortener</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/create_short_url/Create_Short_URL">Create Short URL</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields">Custom Field</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields/Custom_Field_Create">Custom Field Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields/Custom_Field_Read">Custom Field Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields/Custom_Field_Search">Custom Field Search</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields/Custom_Field_Update">Custom Field Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/custom_fields/Custom_Field_Update_Options">Custom Field Update Options</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Content_Brief">Content Brief</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/content_brief/Create_Content_Brief">Create Content Brief</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/content_brief/Content_Brief_Read">Read Content Brief </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/content_brief/Update_Content_Brief">Update Content Brief</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/content_brief/Delete_Content_Brief">Delete Content Brief</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Dashboard_API">Dashboard</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/dashboard_api/Read_Dashboard_List">Read Dashboard List</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/engagement_dashboard">Engagement Dashboard</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/engagement_dashboard/Fetch_Engagement_Dashboards">Fetch All Engagement Dashboards</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/engagement_dashboard/Dashboard_Read">Fetch Engagement Dashboard </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/engagement_dashboard/Dashboard_Stream_Read">Dashboard Stream Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/engagement_dashboard/Case_Management_Stream">Case Management Stream</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/UGC_API">UGC API</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/ugc_api/Fetch_UGC_Stream_Data">Fetch UGC Stream Data</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/extensions">Extension</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/extensions/Extension_Create">Extension Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/extensions/Extension_Read">Extension Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/extensions/Extension_Update">Extension Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/extensions/Extension_Disable">Extension Disable</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening">Listening</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening/Listening_Streams">Listening Streams</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening/Listening_Topics">Listening Topics</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets">Listening Widget</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Distribution_Widget">Distribution Widget</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Grouped_Distribution_Widget">Grouped Distribution Widget</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Grouped_Trend_Widget">Grouped Trend Widget</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Trend_Widget">Trend Widget</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Users_Widget">Users Widget</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/listening_widgets/Topic_Cluster_Widget">Topic Cluster Widget</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Macro">Macro</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/macro/Apply_Macro">Apply Macro</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages">Message</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Channels">Channels</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Inbound_Messages">Inbound Messages</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Conversation_Fetch">Conversation Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Outbound_Messages_Posts">Outbound Messages (Posts)</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Fetch_Message_by_UMID">Read Message by UMID</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Message_Actions">Message Actions</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Message_Properties_Update">Message Properties Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Message_Conversation_Read">Message Conversation Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/messages/Update_Message_Queue_Sentiment">Update Message Queue/Sentiment</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/paid_initiative_creation">Paid Initiative</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/paid_initiative_creation/Create_Paid_Initiative">Create Paid Initiative</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Product_APIs_New">Product APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/product_apis_new/Create_Product">Create Product</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/product_apis_new/Update_Product">Update Product</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/product_apis_new/Delete_Product">Delete Product</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles">Profile</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_Conversation_Read">Profile Conversation Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_Custom_Field_Add">Profile Custom Field Add</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_Custom_Field_Replace">Profile Custom Field Replace</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_List_Update">Profile List Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_Read">Profile Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/profiles/Profile_Search">Profile Search</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing">Publishing</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Post_Draft_Create">Post Draft Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Post_Draft_Read">Post Draft Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Post_Draft_Update">Post Draft Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Post_Publishing">Post Publishing</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Fetch_Post_by_Post_Id">Read Post by Post Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/publishing/Update_Outbound_Message_Custom_Properties">Update Outbound Message Properties</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports">Reporting</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Report_Read">Report Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Account_Insights_Report">Account Insights Report</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Paid_Ad_Stat_Report">Paid Ad Stat Report</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Post_Insights_Report">Post Insights Report</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Report_Custom_Metrics_Read">Report Custom Metrics Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Surveys">Surveys</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/reports/Sprinklr_Reporting_Engines__Fetch_Metrics_and_Dimensions">Sprinklr Reporting Engines - Fetch Metrics and Dimensions</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/Assets">Sprinklr Asset Manager</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Import">Asset Import</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Import_Async">Asset Import Async</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Upload">Asset Upload</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Create">Asset Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Read">Asset Read</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Search">Asset Search</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Update">Asset Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Asset_Delete">Asset Delete</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/Media_Asset_Security">Media Asset Security</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition">Asset Definitions</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Digital_Asset">Digital Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Link_Asset">Link Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Post_Asset">Post Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Text_Asset">Text Asset</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Media_Asset_Type">Media Asset Type</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/assets/asset_definition/Uploaded_Content">Uploaded Content</a></li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users">User (SCIM)</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/User_Create">User Create</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/User_Read">User Read </a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/User_Search">User Search</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/User_Delete">User Delete</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/User_Update">User Update</a></li> <li><a href="https://developer.sprinklr.com/docs/read/api_10/users/Update_Agent_Status">Update Agent Status</a></li> </ul> </li> <li>guided workflow<ul> <li><a href="https://developer.sprinklr.com/docs/read/api_10/guided_workflow/Run_Guided_Workflow">Execute Guided Workflow</a></li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/sdks">SDKs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app">Live Chat SDKs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites">Install Web SDKs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/configure_settings">Configure Live Chat App Settings</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Open_and_close_chat">Open or Close the Live Chat Window</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Open_a_conversation">Open a Conversation</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Update_context_and_settings">Update Conversation Custom Fields or Context </a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Send_external_event_to_an_ongoing_conversation">Send a Message or Event to an Ongoing Conversation </a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Disable_or_enable_Live_Chat">Disable or Enable Live Chat</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Change_locale_of_Live_Chat">Change Language of Live Chat </a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Update_user_details">Update User Details</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Update_client_context">Update Client Custom Fields or Context</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Apply_Filter">Add Filter to Evaluate Live Chat State</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Remove_Filter">Remove Filter</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Type_references">Type References</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Subscribe_to_Live_Chat_Updates">Subscribe to Live Chat Updates</a></li> <li><a href="https://developer.sprinklr.com/docs/read/sdks/live_chat_app/integrate_with_websites/Unsubscribe_to_Live_Chat_Updates">Unsubscribe to Live Chat Updates</a></li> </ul> </li> </ul> </li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/Postman_Collection">Postman Collection for Sprinklr APIs</a></li> <li><a href="https://developer.sprinklr.com/docs/read/GDPR">Privacy (GDPR)</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Create_GDPR_View_Request">GDPR - Create View Request</a></li> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Fetch_GDPR_Request_Status">GDPR - Fetch Request Status</a></li> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Fetch_Audience_Profile_Data">GDPR - Fetch Profile Data</a></li> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Create_GDPR_Edit_Request">GDPR - Create Edit Request</a></li> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Create_GDPR_Delete_Request">GDPR - Create Delete Request</a></li> <li><a href="https://developer.sprinklr.com/docs/read/gdpr/Reference">Reference</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/Community_API">Community APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Create_Unauthnticated_Token">Create Unauthenticated Token</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Create_Authenticated_Token">Create Authenticated Token</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/SignUp_API">Signup - New User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Generate_OTP">Generate OTP</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Validate_OTP">Validate OTP</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Create_Post">Create Post </a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Create_Comment">Create Comment</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Create_Reply">Create Reply</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Update_User">Update User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Search_Messages_Posts">Search Messages/Posts</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Message_Lookup">Message Lookup</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Unrestricted_Search_Messages_1">Unrestricted Search Messages</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Unrestricted_message_streaming">Unrestricted Message Streaming</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Search_User">Search User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Search_Users_Using_Time_Filter">Search Users Using Time Filter</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Fetch_Categories_Using_Parent_Id">Fetch Categories Using Parent Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Fetch_Categories_Using_Category_Id">Fetch Categories Using Category Ids</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Give_Awards_to_Users">Give Awards to Users</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/search_Awards_by_Name">Search Awards by Name</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Remove_Awards_from_Users">Remove Awards from Users</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Mark_Unmark_Solution_as_Official">Mark/Unmark Solution as Official</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Fetch_Rank_Using_Rank_Id">Fetch Rank Using Rank Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Fetch_Topics">Fetch Topics</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Mark_Unmark_Solution_as_Accepted">Mark/Unmark Solution as Accepted</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Fetch_Role_Using_Role_Id">Fetch Role Using Role Id</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Block_User">Block User</a></li> <li><a href="https://developer.sprinklr.com/docs/read/community_api/Unblock_User">Unblock User</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_APIs">Live Chat Application APIs</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Handshake_API">Handshake API - Fetch Application Details</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/App_Handshake_API">App Handshake API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Create_New_Conversation">Create New Conversation</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Fetch_Conversations_API">Fetch Conversations API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Fetch_Single_Conversation">Fetch Single Conversation API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Fetch_Messages_API">Fetch Messages API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Fetch_Single_Message_API">Fetch Single Message API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Close_Conversation_API">Close Conversation API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/User_Lookup_API">User Lookup API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Start_Typing_API">Start Typing API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Stop_Typing_API">Stop Typing API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Message_Read_Validation">Message Read Validation</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Upload_File_API">Upload File API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Conversation_Send_API">Conversation Send API</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Fetch_Notifications_and_User_Heartbeat">Fetch Notifications and User Heartbeat</a></li> <li><a href="https://developer.sprinklr.com/docs/read/live_chat_apis/Post_Back_Message">Post Back Message</a></li> </ul> </li> <li><a href="https://developer.sprinklr.com/docs/read/FAQ">FAQs</a></li> <li><a href="https://developer.sprinklr.com/docs/read/Changelog">Changelog</a><ul> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q4_2024">Jan - Mar 2025</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q3_2024">Oct - Dec, 2024</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q2_2024">Jul - Sep, 2024</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q1_2024">Apr - June, 2024</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/qa4_2024">Jan - Mar, 2024</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q3_2023">Oct - Dec, 2023</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q2_2023">Jul - Sep, 2023</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/qa1_2023">Apr - Jun, 2023</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q4_2023">Jan - Mar, 2023</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q4_NDJ">Oct - Dec, 2022</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q3_2022">Jul - Sep, 2022</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q1_2022">Apr - Jun, 2022</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q4_2022">Jan - Mar, 2022</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q3_2021">Oct - Dec, 2021</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q2_2021">Jul - Sep, 2021</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q1_2021">Apr - Jun 2021</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/Q4_2021">Jan - Mar, 2021</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q3_2020">Oct - Dec, 2020</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/q2_2020">Jul - Sep, 2020</a></li> <li><a href="https://developer.sprinklr.com/docs/read/changelog/Q1_2020">Apr - Jun, 2020 </a></li> </ul> </li> </ul> </div> <!-- /SUB --> <div id="breadcrumbs"> </div><!-- /breadcrumbs --> <div id="local" class="local"> <ul> <li class=" first"><a href="https://developer.sprinklr.com/docs/read/API_Overview">Documentation</a></li> <li class=" last"><a href="https://developer.sprinklr.com/docs/read/api_overview/Getting_Started">Getting Started</a></li> </ul> </div><!-- /local --> <div id="nav" class="nav"> </div><!-- /nav --> </div> <!-- /CONTENT --> <div id="footer" class="footer"> <!-- SITEINFO --> <div id="siteinfo" class="siteinfo"> </div> <!-- /SITEINFO --> </div><!-- /footer --> </div> <!-- /page --> <!-- Start Branding script tag --> <script type="text/javascript" > // get the branding logo to set the mouseover/out and onclick var brandingLogo = document.getElementById('branding-logo'); if(brandingLogo != undefined) { brandingLogo.addEventListener("click", function () { location.href = "http://developer.sprinklr.com"; }); brandingLogo.addEventListener("mouseover", function () { this.style.cursor = 'pointer'; }); brandingLogo.addEventListener("mouseout", function () { this.style.cursor = 'auto'; }); } // get the mashery logo to set the mouseover/out and onclick var masheryLogo = document.getElementById('branding-mashery'); if(masheryLogo != undefined) { masheryLogo.addEventListener("click", function () { location.href = "http://www.mashery.com/"; }); masheryLogo.addEventListener("mouseover", function () { this.style.cursor = 'pointer'; }); masheryLogo.addEventListener("mouseout", function () { this.style.cursor = 'auto'; }); } </script> <!-- End Branding script tag --> <!-- <div id="extra1"> </div> <div id="extra2"> </div> --> <script type="text/javascript" > const enableBoomiTheme = 0; window.isOidcUser = 0; window.isPlatformUser = 0; </script> <script type="text/javascript" src="/public/Mashery/scripts/themes/blackbeard/app.js"></script> <script type="text/javascript"> //<![CDATA[ https://developer.sprinklr.com/blog/read/Checking_Sprinklr_Env. /*! * Templates & Initializations * sprinklr v1.0.0 * Portal Theme Starter Kit v2.7.17 - Default Theme * http://github.com/mashery/portal-theme-starter-kit */ /** * Theme Templates */ // Remove the user nav window.portalOptions.templates.userNav = null; // Adjust the primary nav window.portalOptions.templates.primaryNav = `<div class="nav-primary nav-wrap" id="nav-primary"> <div class="container padding-top-small padding-bottom-small"> <!-- <a id="logo" class="logo" href="/">{{content.logo}}</a> --> <a id="logo" class="logo" href="/"> <img src="/files/sprinklr-dev-portal-logonew.png" alt="sprinklr"> </a> <a role="button" class="nav-toggle" id="nav-primary-toggle" data-nav-toggle=".nav-collapse" href="#">{{content.menuToggle}}</a> <div class="nav-menu"> <div id="nav-user-menu" class="nav-collapse"> <ul class="nav" id="nav-user-list"> {{content.navItemsUser}} </ul> </div> <div id="nav-primary-menu" class="nav-collapse"> <ul class="nav" id="nav-primary-list"> {{content.navItemsPrimary}} <li style="height: 29px; width:29px; padding: 0"> <a href="/search" style="display: block; width:29px; height: 29px;"> <img src="/files/ic_search.svg" /> </a> </li> </ul> </div> </div> </div> </div>`; // Enable full width layouts window.portalOptions.templates.page = function () { return '<div class="main container container-small content" id="main">' + (mashery.globals.noHeading ? '' : '<h1>{{content.heading}}</h1>') + '{{content.main}}' + '</div>'; }; // Footer 2 // The second of two footer content sections. window.portalOptions.templates.footer2 = ` <div class="footer-2" id="footer-2"> <div class="container"> <div class="text-center"> <h2 class="text-white">Connect with us on Social</h2> <ul class="list-inline social-links"> <li><a href="https://www.facebook.com/sprinklr"><i class="fa fa-facebook"></i></a></li> <li><a href="https://twitter.com/Sprinklr"><i class="fa fa-twitter"></i></a></li> <li><a href="https://www.linkedin.com/company/sprinklr/"><i class="fa fa-linkedin"></i></a></li> <li><a href="https://www.youtube.com/c/sprinklr"><i class="fa fa-youtube-play"></i></a></li> </ul> </div> </div> </div> <div class="copyright-section"> <div class="container"> <div class="row"> <div class="grid-two-thirds text-left-large"> <ul class="list-inline no-margin-bottom" style="margin-top: 3px"> <li><a href="https://www.sprinklr.com/"><svg xmlns="http://www.w3.org/2000/svg" style="height:40px;width:48px;margin-bottom:-0.6em;" viewBox="0 0 137.31 111.2" aria-describedBy="logo-footer-title"><title id="logo-footer-title">Sprinklr</title><path fill="currentColor" d="M9.79 19.17A12.15 12.15 0 0 1 22.67 7.71a12.94 12.94 0 0 1 7.91 2.93C46.51 24.5 55.9 49 53.06 70.14c-.14 1-1.34 1-1.64 0C47 55 32.24 37.54 19.15 32.34c-6.2-2.46-9.76-7-9.36-13.18M122.84 17.95c0-9.64-8.09-18.21-19.89-17.94-22.4.51-52.5 58.14-35.27 110.48.21 1.06 1.24.86 1.31-.22 2.4-36.42 24.28-64.93 43.94-76 7.74-4.36 9.91-9.71 9.91-16.32M0 70.69C.51 78 6.6 81.54 12.21 81.54c12.79 0 28.78 6 38.19 13.83.78.65.92.43.41-1.34C47 80.71 26.64 58.4 11.83 58.4A11.6 11.6 0 0 0 0 70.69M137.28 70.69c-.49 7.28-6.57 10.85-12.18 10.85-12.79 0-28.78 6-38.19 13.83-.78.65-.92.43-.41-1.34 3.81-13.32 24.17-35.63 39-35.63a11.6 11.6 0 0 1 11.81 12.29"/></svg></a></li> <li><span class="text-small">© ${new Date().getFullYear()} Sprinklr Inc.</span></li> </ul> </div> <div class="grid-third text-right-large"><a target="_blank" href="https://sprinklr.com/contact-us" class="btn btn-primary">Contact</a></div> </div> </div> </div> `; // '<div class="footer-2 container" id="footer-2">' + // '<div class="row">' + // '<div class="grid-two-thirds text-left-large">' + // '<ul class="list-inline">' + // '<li><a href="https://www.sprinklr.com/"><svg xmlns="http://www.w3.org/2000/svg" style="height:2em;width:1.6em;margin-bottom:-0.6em;" viewBox="0 0 137.31 111.2" aria-describedBy="logo-footer-title"><title id="logo-footer-title">Sprinklr</title><path fill="currentColor" d="M9.79 19.17A12.15 12.15 0 0 1 22.67 7.71a12.94 12.94 0 0 1 7.91 2.93C46.51 24.5 55.9 49 53.06 70.14c-.14 1-1.34 1-1.64 0C47 55 32.24 37.54 19.15 32.34c-6.2-2.46-9.76-7-9.36-13.18M122.84 17.95c0-9.64-8.09-18.21-19.89-17.94-22.4.51-52.5 58.14-35.27 110.48.21 1.06 1.24.86 1.31-.22 2.4-36.42 24.28-64.93 43.94-76 7.74-4.36 9.91-9.71 9.91-16.32M0 70.69C.51 78 6.6 81.54 12.21 81.54c12.79 0 28.78 6 38.19 13.83.78.65.92.43.41-1.34C47 80.71 26.64 58.4 11.83 58.4A11.6 11.6 0 0 0 0 70.69M137.28 70.69c-.49 7.28-6.57 10.85-12.18 10.85-12.79 0-28.78 6-38.19 13.83-.78.65-.92.43-.41-1.34 3.81-13.32 24.17-35.63 39-35.63a11.6 11.6 0 0 1 11.81 12.29"/></svg></a></li>' + // '<li><span class="text-small">© ' + new Date().getFullYear() + ' Sprinklr Inc.</span></li>' + // '</ul>' + // '</div>' + // '<div class="grid-third text-right-large"><p>{{content.masheryMade}}</p></div>' + // '</div>' + // '</div>'; // Custom Footer 2 // The second of two footer content sections. // window.portalOptions.templates.footer2 = // '<div class="footer-2 container" id="footer-2">' + // '<div class="grid">' + // '<div class="footer_menu_company">' + // '<img src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/logo_burst_white.svg"> <span class="footer__copyright">©2019 SPRINKLR INC.</span>' + // '</div>' + // '<ul class="footer_menu_aux" id="menu-footer-menu-aux">' + // '<li class="menu-item menu-item-type-post_type menu-item-object-page"><a href="https://www.sprinklr.com/privacy/">Privacy</a></li>' + // '<li class="menu-item menu-item-type-post_type menu-item-object-page"><a href="https://www.sprinklr.com/terms/">Terms</a></li>' + // '<li class="menu-item menu-item-type-custom menu-item-object-custom"><a>Cookies</a></li>' + // '</ul>' + // '<ul class="footer_menu" id="menu-footer-menu">' + // '<li class="menu-item menu-item-type-custom menu-item-object-custom"><a href="http://sprinklr.com/contact-us">CONTACT</a></li>' + // '<li class="menu-item menu-item-type-post_type menu-item-object-page"><a href="https://www.sprinklr.com/careers/">CAREERS</a></li>' + // '<li class="menu-item menu-item-type-post_type menu-item-object-page"><a href="https://www.sprinklr.com/impressum/">IMPRESSUM</a></li>' + // '<li class="menu-item menu-item-type-custom menu-item-object-custom"><a href="https://www.sprinklr.com/preference-center">PREFERENCE CENTER</a></li>' + // '</ul>' + // '<ul class="footer_menu_social">' + // '<li><a href="https://www.facebook.com/sprinklr"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/facebook_logo.svg"></a></li>' + // '<li><a href="https://twitter.com/sprinklr"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/twitter_logo.svg"></a></li>' + // '<li><a href="https://www.linkedin.com/company/sprinklr"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/linkedin_logo.svg"></a></li>' + // '<li><a href="https://www.youtube.com/c/sprinklr"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/youtube_logo.svg"></a></li>' + // '<li><span class="separator"></span></li>' + // '<li><a href="https://itunes.apple.com/us/app/sprinklr/id413619434?mt=8"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/apple_logo.svg"></a></li>' + // '<li><a href="https://play.google.com/store/apps/details?id=com.sprinklr.android&hl=en"><img class="footer_menu_social_logo" src="https://www.sprinklr.com/wp-content/themes/sprinklr/assets/images/icons/android_logo.svg"></a></li>' + // '</ul>' + // '</div>' + // '</div>'; // Add theme style hook document.documentElement.className += ' js-theme-skinny-nav'; /** * Load custom typeface */ window.addEventListener('portalAfterInit', function () { m$.loadJS('https://cdn.jsdelivr.net/gh/bramstein/fontfaceobserver@2.1.0/fontfaceobserver.standalone.js', function () { m$.loadCSS('https://fonts.googleapis.com/css?family=Open+Sans:300,400,400i,700,700i'); var font = new FontFaceObserver('Open Sans'); font.load().then(function () { document.documentElement.classList.add('fonts-loaded'); }); }); // Load jQuery m$.loadJS('https://code.jquery.com/jquery-3.2.1.min.js', function () { // $("#nav-docs li button.btn-link").each(function( index ) { // var link = $(this).prev('a'); // var button = $(this).detach(); // $(link).prepend(button); // }); $(".api-method").contents().detach().prependTo(".grid-three-fourths h1"); $(".try-it-btn").detach().appendTo(".grid-three-fourths h1").show(); $("#nav-docs ul li a").each(function( index ) { if($(this).next().next('ul').length) { $(this).addClass('expandable'); } var value = $(this).text().toLowerCase().replace(/ /g,"_").replace(/\./g, '_'); $(this).parent().addClass(value); }); }); }, false); window.addEventListener('portalBeforeRender', function () { if (mashery.globals.noHeading) { document.documentElement.classList.add('page-no-heading'); } else { document.documentElement.classList.remove('page-no-heading'); } }, false); /** * Favicon * Add a favicon/tab icon for your Portal. */ window.portalOptions.favicon = true; /** * Logo * Add a custom logo. Accepts any markup as a string (`<img src>`, `<svg></svg>`, etc.). */ portalOptions.logo = '<svg version="1.1"xmlns="http://www.w3.org/2000/svg" style="height:35px;width:86px;" viewBox="0 0 199.9 92.3" xml:space="preserve" aria-labelledby="logo-title"><title>Sprinklr Developer Portal</title><path fill="#ffffff" d="M.3 74.6l.4-.5c.3-.4.9-.6 1.4-.2.1 0 .1.1.2.2 2.6 2.2 5.9 3.3 9.3 3.3 4 0 7.5-2.1 7.5-6.1 0-8.3-18-6-18-16.6 0-5.8 4.9-8.8 10.5-8.8 3.2-.1 6.3.9 8.9 2.8.5.3.6.9.4 1.4l-.1.1-.4.5c-.3.5-.9.6-1.4.3-.1 0-.1-.1-.2-.2-2.1-1.6-4.7-2.4-7.4-2.3-3.7 0-7.4 1.7-7.4 5.9 0 8.5 18 6 18 16.8 0 5.2-4.5 8.8-10.5 8.8-4.1.1-8-1.3-11-4-.5-.3-.6-.9-.2-1.4-.1 0-.1 0 0 0M30.4 47.7c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9v3c0 .9-.1 1.8-.2 2.6h.1s2.7-7.3 11.8-7.3c8.8 0 14.1 7 14.1 17.1 0 10.4-6.1 17.1-14.5 17.1-4.9 0-9.4-2.9-11.4-7.4h-.1c.2.9.3 1.9.3 2.9v15.7c.1.5-.3 1-.9 1.1h-.7c-.5.1-1-.3-1.1-.9v-.2l-.1-43.5zm14 29.7c6.4 0 11.6-5.3 11.6-14.5 0-8.8-4.7-14.4-11.4-14.4-6 0-11.6 4.2-11.6 14.5 0 7.2 4.1 14.4 11.4 14.4M67.7 47.7c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9v5.3c0 .9-.1 1.8-.2 2.7h.1c1.6-5 5.5-9.1 11-9.1.6-.1 1.2.2 1.3.8V48.1c0 .7-.6 1.2-1.3 1.1h-.2c-7.3 0-10.8 8.7-10.8 16v13c.1.5-.3 1-.9 1.1h-.7c-.5.1-1-.3-1.1-.9v-.2l.1-30.5zM88.5 47.7c-.1-.5.3-1.1.8-1.1h1c.5-.1 1.1.3 1.1.8v30.8c.1.5-.3 1.1-.8 1.1h-1c-.5.1-1.1-.3-1.1-.8V47.7zM101.7 47.7c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9v4.8c0 .9-.1 1.8-.3 2.7h.1c2.3-5.6 7.8-9.2 13.8-9.2 8.5 0 10.8 5 10.8 12.8v19.6c.1.5-.3 1-.9 1.1h-.7c-.5.1-1-.3-1.1-.9V59.5c0-5.7-.7-11.1-8-11.1s-13.7 6.1-13.7 14.5v15.2c.1.5-.3 1-.9 1.1h-.7c-.5.1-1-.3-1.1-.9V47.7zM139.5 34.6c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9v25h5.8l10.1-12.2c.3-.4.8-.7 1.4-.6h1c.9 0 1.2.6.6 1.4l-10.7 12.7v.1l12 17.1c.5.8.2 1.4-.7 1.4h-1c-.5 0-1.1-.2-1.3-.7L148.1 62h-5.8v16.2c.1.5-.3 1-.9 1.1h-.7c-.5.1-1-.3-1.1-.9v-.2l-.1-43.6zM170 34.6c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9V71.7c0 4.6 2.2 5 3.8 5.2.6 0 1 .4 1 1v.4c.1.5-.2 1.1-.8 1.2h-.4c-1.9 0-6.4-.7-6.4-6.9l.1-38zM184.9 47.7c-.1-.5.3-1 .9-1.1h.7c.5-.1 1 .3 1.1.9v5.3c0 .9-.1 1.8-.3 2.7h.1c1.6-5 5.5-9.1 11-9.1.6-.1 1.2.2 1.3.8V48.1c0 .7-.6 1.2-1.3 1.1h-.2c-7.3 0-10.8 8.7-10.8 16v13c.1.5-.3 1-.9 1.1h-.5c-.5.1-1-.3-1.1-.9V47.7zM69.6 6.6c.1-2.3 2.1-4.1 4.4-4h.1c1 0 2 .4 2.7 1 5.7 5.2 8.6 12.9 7.8 20.5 0 .4-.5.4-.6 0-1.5-5.2-6.6-11.3-11.1-13.1-2.2-.7-3.4-2.3-3.3-4.4M108.6 6.2c-.1-3.5-3-6.3-6.6-6.2h-.3C94 .2 83.6 20.1 89.6 38.2c.1.4.4.3.5-.1.8-12.6 8.4-22.4 15.2-26.2 2.1-1.1 3.5-3.3 3.3-5.7M66.2 24.4c.1 2.2 2 3.9 4.2 3.8 4.8.2 9.4 1.8 13.2 4.8.3.2.3.1.1-.5-1.3-4.6-8.3-12.3-13.5-12.3-2.2 0-4 1.7-4.1 3.9.1.1.1.2.1.3M113.6 24.4c-.1 2.2-2 3.9-4.2 3.8-4.8.2-9.4 1.8-13.2 4.8-.3.2-.3.1-.1-.5 1.3-4.6 8.3-12.3 13.5-12.3 2.2 0 4 1.7 4.1 3.9 0 .1 0 .2-.1.3"/></svg>'; /** * Initialize plugins */ window.addEventListener('portalAfterRender', function () { // Expand-and-collapse nav on small viewports astro.init(); // Enhanced documentation var docs = {}; if (document.querySelector('.better-docs-nav')) { docs = new BetterDocs('.content', { langs: { bash: { selector: 'bash', title: 'Bash' }, js: { selector: 'javascript, js', title: 'JavaScript', }, ruby: { selector: 'ruby', title: 'Ruby' }, python: { selector: 'python', title: 'Python' } }, langDefault: 'js', wideLayout: (document.documentElement.classList.contains('js-theme-sidebar') ? true : false), }); } // Destroy instantiation on Ajax page reload window.addEventListener('portalBeforeRender', function () { if ('destroy' in docs) { docs.destroy(); } }, false); // Conditional content // Add logged-in/logged-out class if (window.mashery.loggedIn) { document.documentElement.classList.add('is-logged-in'); document.documentElement.classList.remove('is-logged-out'); } else { document.documentElement.classList.add('is-logged-out'); document.documentElement.classList.remove('is-logged-in'); } // Responsive iFrame Videos fluidvids.init({ selector: ['iframe', 'object'], // runs querySelectorAll() players: ['www.youtube.com', 'player.vimeo.com'] // players to support }); // Get the latest blog posts latestBlogPosts(); // Smooth scrolling to anchor links var scroll = {}; scroll = new SmoothScroll('.category-page #main-wrapper a[href*="#"], .category-docs #main-wrapper a[href*="#"], .category-docs #main-wrapper a[href*="#"], .category-blogall #main-wrapper a[href*="#"], .category-blogsingle #main-wrapper a[href*="#"], #nav-docs a[href*="#"]', { ignore: '.js-scroll-ignore' }); // Destroy instantiation on Ajax page reload window.addEventListener('portalBeforeRender', function () { if ('destroy' in scroll) { scroll.destroy(); } }, false); // Language translation // NOTE: You should update this with your desired options, languages, and translations. // Details at https://developer.mashery.com/docs/customizing_your_portal/plugins/Translate // var translate = new Translate(); // Sticky footer stickyFooter('#footer'); if (mashery.contentType === 'ioDocs') { window.setTimeout(function () { stickyFooter('#footer'); }, 300); } // Expand/collapse docs navigation docsNavCollapse.init(); }, false); // Registration page link window.addEventListener('portalAfterRender', function () { if (mashery.contentId !== 'apps-register') return; let legends = document.querySelectorAll('legend'); for (let legend of legends) { if (!legend.textContent.includes('Select the Sprinklr Environment')) continue; legend.innerHTML += ' <a target="_blank" href="https://developer.sprinklr.com/blog/read/Checking_Sprinklr_Env">Click here</a> for steps for extracting your Sprinklr environment.<br><span class="descr padding-top-small"><strong>Note:</strong> Select API Bundle checkbox for the relevant Sprinklr environment</span>'; } }); window.addEventListener('portalAfterRenderAjax', function() { $(".api-method").contents().detach().prependTo(".grid-three-fourths h1"); $(".try-it-btn").detach().appendTo(".grid-three-fourths h1").show(); $("#nav-docs ul li a").each(function( index ) { if($(this).next().next('ul').length) { $(this).addClass('expandable'); } var value = $(this).text().toLowerCase().replace(/ /g,"_").replace(/\./g, '_'); $(this).parent().addClass(value); }); }); window.addEventListener('load', function() { var element = document.querySelectorAll('#nav-docs ul'); Array.from(element).forEach(function(ele, i) { ele.setAttribute("id", 'item' + (i + 1)); }); }); window.addEventListener('portalAfterRender', function () { $(".api-method").contents().detach().prependTo(".grid-three-fourths h1"); $(".try-it-btn").detach().appendTo(".grid-three-fourths h1").show(); }, false); // update 2020 function createNotification(data) { var notification = document.createElement('div') notification.classList.add('notification') notification.innerHTML = `<div class="notification-head">${data.heading}</div><div class="notification-body">${data.message}</div>` return notification } function getNotification(options) { var notificationType = '' var heading = (options.heading) ? options.heading.trim() : ''; var message = (options.message) ? options.message.trim() : ''; var time = parseInt(options.time); time = (options.time && time) ? time : 4000; if(document.getElementsByClassName('notifications').length){ let notificationElement = createNotification({ heading: heading, message: message }); if (options.type) { let type = options.type.toLocaleLowerCase().trim() notificationType = (['primary', 'success', 'danger', 'info', 'warning', 'dark'].includes(type)) ? type : ''; notificationElement.classList.add(notificationType) } setTimeout(() => { notificationElement.remove() }, time) document.getElementsByClassName('notifications')[0].appendChild(notificationElement) } else{ let notificationWrapper = document.createElement('div') notificationWrapper.classList.add('notifications') document.body.appendChild(notificationWrapper) getNotification(options) } } function copyToClip(str) { if(typeof(str) == 'string'){ function listener(e) { e.clipboardData.setData("text/html", str); e.clipboardData.setData("text/plain", str); e.preventDefault(); } document.addEventListener("copy", listener); document.execCommand("copy"); document.removeEventListener("copy", listener); return true } return false }; function thankyou(isShowing = true){ if(isShowing){ document.querySelector('.form-wrapper .form-details').style.visibility = "hidden" document.querySelector('.form-wrapper .after-form-submit').style.display = "flex" } else{ document.querySelector('.form-wrapper .form-details').style.visibility = "visible" document.querySelector('.form-wrapper .after-form-submit').style.display = "none" } } function copyCode(clickedElement){ if(copyToClip(clickedElement.parentNode.parentNode.children[1].children[0].innerText)){ getNotification({ heading: 'Success', message: "Code copy to clipboard.", type: "success" }) } else{ getNotification({ heading: 'Error!!', message: "Type error!!", type: "error" }) } } function submitForm(form) { form.classList.add('loading') const data = new FormData(form) fetch("https://sprinklr.tfaforms.net/responses/processor", { method: "POST", body: data, // "no-cors" mode + redirect: "follow" allows us to handle the redirect ourselves // and FormAssembly ALWAYS wants to redirect :( // solution inspired from: https://stackoverflow.com/questions/37668282/unable-to-fetch-post-without-no-cors-in-header mode: "no-cors", redirect: "follow", }).then( res => { debugger form.classList.remove('loading') // the forms have a redirect // this identifies that we got a response if (res.type === "opaque") { //setIsSubmitSuccess("success") // Change this to trigger the success message form.reset() thankyou() // Change this to trigger the success message console.log({res}) return res } }, // Note: it's important to handle errors here // instead of a catch() block so that we don't swallow // exceptions from actual bugs in components. error => { form.classList.remove('loading') console.log({error}) getNotification({ heading: 'Error!!', message: "Oops! Something went wrong.", type: "error" }) // Change this to trigger the error message } ) return false } // rating function raterInit(selector = "#rater", starCount = 5){ var wrapper = document.querySelector(selector); var ul = document.createElement('ul') ul.classList.add('rating') while(starCount > 0){ let li = document.createElement('li') li.setAttribute('data-rating', starCount) li.setAttribute('data-title', `${starCount} star`) li.appendChild(document.createTextNode('☆')) ul.appendChild(li) starCount-- } wrapper.appendChild(ul) } window.addEventListener('load', (event) => { raterInit("#rater") var ratingStars = document.querySelectorAll('.rating li') ratingStars.forEach(listItem => { listItem.addEventListener('click', function(e){ let element = e.target let parent = e.currentTarget.parentElement ratingStars.forEach(star => { star.classList.remove('active') }); element.classList.add('active') parent.classList.add('rated') submitRating(element) }); }); }); function submitRating(selectedStar) { let rate = parseInt(selectedStar.dataset.rating); let pageLocation = window.location.href let user = (typeof mashery != 'undefined') ? mashery.username : 'Anonymous'; fetch('https://us-central1-sprinklr-9adfa.cloudfunctions.net/insertRating', { method: 'post', headers: { 'Content-Type': 'application/json' // 'Content-Type': 'application/x-www-form-urlencoded', }, body: JSON.stringify({ rate: rate, pageLocation: pageLocation, user: user }), }).then(function (response) { return response.json(); }).then(function (data) { console.log(data) }).catch(function (err) { console.log(err) }); }; //]]> </script> <script src="/files/main.min.js" type="text/javascript"></script> <script type="text/javascript" > m$.init(portalOptions); </script> </body> </html>