<!DOCTYPE html>
<html>
  <head>
    <title>Wix Internal Client API</title>
    <meta charset="UTF-8" />
    <meta name="description" content="" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1, minimum-scale=1" />
    <meta name="apple-mobile-web-app-capable" content="yes" />
    <link type="image/png" href="https://www.wix.com/favicon.ico" rel="shortcut icon" />
    <link type="text/css" rel="stylesheet"
      href="//static.parastorage.com/services/third-party/fonts/Helvetica/fontFace.css" />
    <link rel="stylesheet" href="//static.parastorage.com/services/wix-internal-client-docs-viewer/1.286.0/app.min.css" />
    <script
      src="https://static.parastorage.com/polyfill/v2/polyfill.min.js?features=default,es6,es7,es2017,IntersectionObserver&flags=gated&unknown=polyfill&rum=0"></script>
    <script src="//static.parastorage.com/unpkg/react@16.8.6/umd/react.production.min.js"></script>
    <script src="//static.parastorage.com/unpkg/react-dom@16.8.6/umd/react-dom.production.min.js"></script>
      
    <!-- Global Site Tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=UA-54339416-1"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag() {
        dataLayer.push(arguments);
      }
      gtag('js', new Date());
      gtag('config', 'UA-54339416-1');
    </script>
  </head>
  <body>
    
    <div id="modal-root"></div>
    <div id="root"><main class="_36KeU"><div class="_3-B7z "><nav class="_2M7s5"><a href="https://dev.wix.com/dc3/my-apps" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">My Apps</p></a><a href="https://bo.wix.com/wix-docs" target="_blank" class="_2oLtq _1GKFt" data-active="true" rel="noopener"><p class="HP2KZ _1_vMl ">API Reference</p></a><a href="http://dev.wix.com/docs" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">SDK</p></a><a href="https://pbo.wixpress.com/wix-api-explorer" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">RPC API Explorer</p></a><a href="https://pbo.wixpress.com/rpc-console-poc" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">RPC Console</p></a><a href="https://pbo.wix.com/fire-console" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">GRPC Console</p></a></nav><div class="d4FTW"><svg viewBox="0 0 24 24" fill="currentColor" width="18px" height="18px"><path d="M6,6 L18,6 C19.104,6 20,6.896 20,8 L20,16 C20,17.104 19.104,18 18,18 L13.6400003,18 L8.756,20.93 C8.677,20.977 8.588,21 8.5,21 C8.414,21 8.33,20.979 8.253,20.935 C8.097,20.846 8,20.68 8,20.5 L8,18 L6,18 C4.896,18 4,17.104 4,16 L4,8 C4,6.896 4.896,6 6,6 Z M19,16 L19,8 C19,7.447 18.553,7 18,7 L6,7 C5.447,7 5,7.447 5,8 L5,16 C5,16.553 5.447,17 6,17 L9,17 L9,19.621 L13.3599997,17 L18,17 C18.553,17 19,16.553 19,16 Z M8,11 L8,10 L16,10 L16,11 L8,11 Z M8,14 L8,13 L13,13 L13,14 L8,14 Z"></path></svg><p class="HP2KZ _3Nqec ">Have feedback?<!-- --> <span>Let us know.</span></p></div></div><div class="_3kkVL"><img src="/wix-docs/client/assets/images/burger@2x.png" class="_3NLhm" alt="mobile menu icon"/><div class="_2oLXi"><img src="/wix-docs/client/assets/images/group-10@3x.png" class="_21Ro2" alt="wix logo"/><span class="gzfOf">Docs</span><span class="_3U9VY">Internal</span></div><div class="_1cBaO"><nav class="_2M7s5"><a href="https://dev.wix.com/dc3/my-apps" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">My Apps</p></a><a href="https://bo.wix.com/wix-docs" target="_blank" class="_2oLtq _1GKFt" data-active="true" rel="noopener"><p class="HP2KZ _1_vMl ">API Reference</p></a><a href="http://dev.wix.com/docs" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">SDK</p></a><a href="https://pbo.wixpress.com/wix-api-explorer" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">RPC API Explorer</p></a><a href="https://pbo.wixpress.com/rpc-console-poc" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">RPC Console</p></a><a href="https://pbo.wix.com/fire-console" target="_blank" class="_2oLtq" data-active="undefined" rel="noopener"><p class="HP2KZ _1_vMl ">GRPC Console</p></a></nav></div><div class="_1RouH"><div class="d4FTW"><svg viewBox="0 0 24 24" fill="currentColor" width="18px" height="18px"><path d="M6,6 L18,6 C19.104,6 20,6.896 20,8 L20,16 C20,17.104 19.104,18 18,18 L13.6400003,18 L8.756,20.93 C8.677,20.977 8.588,21 8.5,21 C8.414,21 8.33,20.979 8.253,20.935 C8.097,20.846 8,20.68 8,20.5 L8,18 L6,18 C4.896,18 4,17.104 4,16 L4,8 C4,6.896 4.896,6 6,6 Z M19,16 L19,8 C19,7.447 18.553,7 18,7 L6,7 C5.447,7 5,7.447 5,8 L5,16 C5,16.553 5.447,17 6,17 L9,17 L9,19.621 L13.3599997,17 L18,17 C18.553,17 19,16.553 19,16 Z M8,11 L8,10 L16,10 L16,11 L8,11 Z M8,14 L8,13 L13,13 L13,14 L8,14 Z"></path></svg><p class="HP2KZ _3Nqec ">Have feedback?<!-- --> <span>Let us know.</span></p></div></div></div><div class="_3Omxd"><span class="_11rdH"><nav class="_1gdG4"></nav></span><div style="padding:30px"><div data-hook="open-search-modal-btn" class="_18ID2"><svg viewBox="0 0 24 24" fill="currentColor" width="24" height="24" class="_2L7vi"><path d="M19.8535534,19.1464466 C20.0488155,19.3417088 20.0488155,19.6582912 19.8535534,19.8535534 C19.6582912,20.0488155 19.3417088,20.0488155 19.1464466,19.8535534 L15.4380219,16.1451287 C14.1187738,17.3000688 12.3911257,18 10.5,18 C6.35786438,18 3,14.6421356 3,10.5 C3,6.35786438 6.35786438,3 10.5,3 C14.6421356,3 18,6.35786438 18,10.5 C18,12.3911257 17.3000688,14.1187738 16.1451287,15.4380219 L19.8535534,19.1464466 Z M17,10.5 C17,6.91014913 14.0898509,4 10.5,4 C6.91014913,4 4,6.91014913 4,10.5 C4,14.0898509 6.91014913,17 10.5,17 C14.0898509,17 17,14.0898509 17,10.5 Z"></path></svg>Search API library<span class="_1WbYi"> / </span></div></div></div><div class="oJz6J" data-hook="breadcrumbs-container"><a class="" href="/using-wix-docs#top"><p data-hook="breadcrumbs-0" class="HP2KZ _3Nqec ">Using Wix Docs</p></a><svg viewBox="0 0 24 24" fill="currentColor" width="24" height="24" class="_2jq_y"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><a class="jUjQS _2ywv3" href="/using-wix-docs#generating-your-documentation"><p data-hook="breadcrumbs-1" class="HP2KZ _3Nqec ">Generating Your Documentation</p></a></div><button class="_1Ybpn"><p class="HP2KZ _3hc0- _1Brl0 ">Menu</p></button><nav class="_2zBQL _3sFek"><p data-hook="sub-menu-title" class="HP2KZ _1_vMl _1hyGZ">Articles</p><section data-hook="Using Wix Docs-top-level-guides-section" class="_2MUs-" data-section="markdown-menu-section-0"><a href="/using-wix-docs#top"><p data-hook="markdown-section-title-text" class="HP2KZ _2ktMM mVJlB">Using Wix Docs</p></a><a class="NjuIb" href="/using-wix-docs#generating-your-documentation"><svg viewBox="0 0 18 18" fill="currentColor" width="18" height="18"><path d="M6,4 L12,4 C12.5522847,4 13,4.44771525 13,5 L13,14 C13,14.5522847 12.5522847,15 12,15 L6,15 C5.44771525,15 5,14.5522847 5,14 L5,5 C5,4.44771525 5.44771525,4 6,4 Z M6,5 L6,14 L12,14 L12,5 L6,5 Z M7,7 L11,7 L11,8 L7,8 L7,7 Z M7,9 L11,9 L11,10 L7,10 L7,9 Z M7,11 L11,11 L11,12 L7,12 L7,11 Z"></path></svg><p data-hook="md-guide-link-text" class="HP2KZ undefined ">Generating Your Documentation</p></a><a class="NjuIb" href="/using-wix-docs#exposing-your-service-to-tpa&#x27;s"><svg viewBox="0 0 18 18" fill="currentColor" width="18" height="18"><path d="M6,4 L12,4 C12.5522847,4 13,4.44771525 13,5 L13,14 C13,14.5522847 12.5522847,15 12,15 L6,15 C5.44771525,15 5,14.5522847 5,14 L5,5 C5,4.44771525 5.44771525,4 6,4 Z M6,5 L6,14 L12,14 L12,5 L6,5 Z M7,7 L11,7 L11,8 L7,8 L7,7 Z M7,9 L11,9 L11,10 L7,10 L7,9 Z M7,11 L11,11 L11,12 L7,12 L7,11 Z"></path></svg><p data-hook="md-guide-link-text" class="HP2KZ undefined ">Exposing Your Service to TPA&#x27;s</p></a></section><p data-hook="sub-menu-title" class="HP2KZ _1_vMl _1hyGZ">API Reference</p><section class="_2TOK3" data-hook="Client Frameworks-tree-menu-section" data-section="tree-menu-section-0"><a href="/client-frameworks#top"><p data-hook="tree-section-title-text" class="HP2KZ _2ktMM mVJlB">Client Frameworks</p></a><div class="_2AVSv _3M2pE" data-hook="tree-menu-depth-0"><a class="_1viIh _3M2pE" href="/client-frameworks#account-manager"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Account Manager</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#business-manager"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Business Manager</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#editor-platform"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Editor Platform</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#email-marketing-(shoutout)"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Email Marketing (ShoutOut)</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#offline-migration"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Offline Migration</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#tag-bundler"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Tag Bundler</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#test"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Test</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#user-feedback"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">User Feedback</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#video-maker"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Video Maker</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#viewer-platform-(ooi)"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Viewer Platform (OOI)</p></a><a class="_1viIh _3M2pE" href="/client-frameworks#wix-photo-studio"><svg viewBox="0 0 24 24" fill="currentColor" width="15px" height="15px" class="_1-2eb _3M2pE"><path d="M9.14644661,8.14512634 C9.34170876,7.9498642 9.65829124,7.9498642 9.85355339,8.14512634 L14.206596,12.5 L9.85355339,16.8536987 C9.65829124,17.0489609 9.34170876,17.0489609 9.14644661,16.8536987 C8.95118446,16.6584366 8.95118446,16.3418541 9.14644661,16.1465919 L12.7923824,12.5 L9.14644661,8.85223312 C8.95118446,8.65697098 8.95118446,8.34038849 9.14644661,8.14512634 Z"></path></svg><p data-hook="sub-tree-link" class="HP2KZ undefined ">Wix Photo Studio</p></a></div></section></nav><main class="_3j0sh"></main></main></div>
    <script>
      window.__BASEURL__ = '/wix-docs/client';
      window.__EXPERIMENTS__ = {"specs.wix-docs.NewCorvidComponents":"false","specs.wix-docs.NavigationBugFix":"false","specs.wix-docs.NewExamplesDesign":"true"};
    </script>

    <script crossorigin src="//static.parastorage.com/services/wix-internal-client-docs-viewer/1.286.0/app.bundle.min.js"></script>
  </body>
</html>
