CINXE.COM
API OpenSRS Email
<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="api-opensrs-email-hub2"><meta name="readme-version" content="1.1"><title>API OpenSRS Email</title><meta name="description"><meta property="og:title" content="API OpenSRS Email"><meta property="og:description"><meta property="og:site_name" content="API OpenSRS Email"><meta name="twitter:title" content="API OpenSRS Email"><meta name="twitter:description"><meta name="twitter:card" content="summary_large_image"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta property="og:image" content="https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png"><meta name="twitter:image" content="https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/49bce28-Favicon_regular.svg" type="image/svg+xml"><link rel="canonical" href="https://email.opensrs.guide/"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-PageNotFound" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"> <link data-chunk="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"> <link data-chunk="CustomPage" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"> <link data-chunk="core-icons-more-vertical-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"> <link data-chunk="core-icons-lock-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"> <link data-chunk="core-icons-alert-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"> <link data-chunk="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"> <link data-chunk="core-icons-arrow-up-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"> <link data-chunk="routes-Changelog" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"> <link data-chunk="Post" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"> <link data-chunk="core-icons-arrow-right-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"> <link data-chunk="core-icons-x-circle-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"> <link data-chunk="core-icons-suggested-edits-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"> <link data-chunk="core-icons-search-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"> <link data-chunk="core-icons-custom-pages-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"> <link data-chunk="rmdx" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="core-icons-chevron-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"> <link data-chunk="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"> <link data-chunk="core-icons-trending-up-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"> <link data-chunk="core-icons-callout-info-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#076AFB;--project-color-inverse:#fff;--recipe-button-color:#076AFB;--recipe-button-color-hover:#024099;--recipe-button-color-active:#022b67;--recipe-button-color-focus:rgba(7, 106, 251, 0.25);--recipe-button-color-disabled:#d0e3fe}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#076AFB;--project-color-inverse:#fff}a{color:var(--color-link-primary,#076afb)}a:hover{color:var(--color-link-primary-darken-5,#024099)}a.text-muted:hover{color:var(--color-link-primary,#076afb)}.btn.btn-primary{background-color:#076afb}.btn.btn-primary:hover{background-color:#024099}.theme-line #hub-landing-top h2{color:#076afb}#hub-landing-top .btn:hover{color:#076afb}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#076afb}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#076afb,#004ab5)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#076afb}.theme-line header#hub-header #header-top .btn{background-color:#076afb}header#hub-header #header-top #header-logo{width:139px;height:40px;margin-top:0;background-image:url(https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#076afb}#subheader-links a.active{color:#076afb!important;box-shadow:inset 0 -2px 0 #076afb}#subheader-links a:hover{color:#076afb!important;box-shadow:inset 0 -2px 0 #076afb;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#076afb}section#hub-discuss .discussion a .discuss-body h4{color:#076afb}section#hub-discuss .discussion a:hover .discuss-body h4{color:#024099}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#076afb}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#076afb}#hub-search-results h3 em{color:#076afb}.main_background,.tag-item{background:#076afb!important}.main_background:hover{background:#024099!important}.main_color{color:#076afb!important}.border_bottom_main_color{border-bottom:2px solid #076afb}.main_color_hover:hover{color:#076afb!important}section#hub-discuss h1{color:#076afb}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#076afb;background-color:#076afb}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#024099;border-color:#024099}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#076afb;color:#076afb}#hub-reference .hub-reference .logs .logs-empty .logs-login-button,#hub-reference .hub-reference .logs .logs-login .logs-login-button{background-color:var(--project-color-primary,#076afb);border-color:var(--project-color-primary,#076afb)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#024099;border-color:#024099}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#076afb;fill:var(--project-color-primary,#076afb)}#hub-reference .hub-reference .logs:last-child .logs-empty,#hub-reference .hub-reference .logs:last-child .logs-login{margin-bottom:35px}#hub-reference .hub-reference .hub-reference-section .hub-reference-left header .hub-reference-edit:hover{color:#076afb}.main-color-accent{border-bottom:3px solid #076afb;padding-bottom:8px}</style><meta name="loadedProject" content="api-opensrs-email-hub2"><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-line header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal no-sidebar hub-is-home"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark ThemeContext_line" style="--color-primary:#076AFB;--color-primary-inverse:#fff;--color-primary-alt:#004ab5;--color-primary-darken-10:#0355cc;--color-primary-darken-20:#024099;--color-primary-alpha-25:rgba(7, 106, 251, 0.25);--color-link-primary:#076AFB;--color-link-primary-darken-5:#045fe5;--color-link-primary-darken-10:#0355cc;--color-link-primary-darken-20:#024099;--color-link-primary-alpha-50:rgba(7, 106, 251, 0.5);--color-link-primary-alpha-25:rgba(7, 106, 251, 0.25);--color-link-background:rgba(7, 106, 251, 0.09);--color-link-text:#fff;--color-login-link:#018ef5;--color-login-link-text:#fff;--color-login-link-darken-10:#0171c2;--color-login-link-primary-alpha-50:rgba(1, 142, 245, 0.5)"><header class="Header3zzata9F_ZPQ rm-Header "><div class="rm-Header-top Header-topuTMpygDG4e1V"><div class="rm-Container rm-Container_flex"><div style="outline:none" tabindex="-1"><a href="#content" target="_self" class="Button Button_md rm-JumpTo Header-jumpTo3IWKQXmhSI5D Button_primary">Jump to Content</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU"><a class="rm-Logo Header-logo1Xy41PtkzbdG" href="/" target="_self"><img alt="API OpenSRS Email" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/docs" target="_self">Guides</a></div><div class="rm-Header-left Header-leftADQdGVqx1wqU Header-left_mobile1RG-X93lx6PF"><div><button aria-label="Toggle navigation menu" class="icon-menu menu3d6DYNDa3tk5" type="button"></button><div class=""><div class="Flyout95xhYIIoTKtc undefined rm-Flyout" data-testid="flyout"><div class="MobileFlyout1hHJpUd-nYkd"><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Changelog</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/discuss" target="_self"><i class="icon-discussions NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Discussions</span></a><select class="Select Select_md NavItem-item1gDDTqaXGhm1 NavItem-item_select3UEfLN-oSjxp NavItem-item_mobile1qG3gd-Mkck-"><option data-url="/v1.0/" value="1.0">v1.0</option><option selected="" data-url="#" value="1.1">v1.1</option></select><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/docs" target="_self">Guides</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/login?redirect_uri=/" target="_self" to="/login?redirect_uri=/">Log In</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="API OpenSRS Email" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-landing-page-2 Header-left-nav-icon10glJKFwewOv"></i>Home</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a href="/login?redirect_uri=/" target="_self" class="Button Button_slate_text Button_md Header-link2tXYTgXq85zW undefined NavItem_mdrYO3ChA2kYvP rm-Header-top-link rm-Header-top-link_login Button_primary">Log In</a></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div><div class="undefined container"><section class="LandingPageHeader20SNhBZ58Jy5 rm-LandingPageHeader"><h1 class="LandingPageHeader-title16RMwPkp2O2W">The API: OpenSRS Hosted Email Developer Hub</h1><div class="rm-Markdown markdown-body LandingPageHeader-text3zJOEVqnHdlf" data-testid="RDMD"><p>Welcome to the API: OpenSRS Hosted Email developer hub. You'll find comprehensive guides and documentation to help you start working with API: OpenSRS Hosted Email as quickly as possible, as well as support if you get stuck. Let's jump right in!</p></div><div align="center" class="Flex Flex_row " justify="start" style="--flex-gap:var(--md)"><a class="Button Button_md LandingPageHeader-button_primaryLpo1zn3KXh20" href="/docs" target="_self"><i class="icon-guides"></i><span>Get Started</span></a></div></section></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="rm-VersionDropdown Dropdown Dropdown_closed"><button aria-haspopup="dialog" class="Button Button_slate_text Button_md rm-Header-bottom-link Dropdown-toggle Button_primary" type="button"><span>v<!-- -->1.1</span><i class="icon icon-chevron-down"></i></button></div><div class="Dropdown Dropdown_closed"><div class="Dropdown-toggle" aria-haspopup="dialog"><button class="rm-Header-link rm-Header-bottom-link undefined Button Button_slate_text Button_md" type="button"><span>Home</span><i class="undefined icon-chevron-down"></i></button></div></div></nav><div class="rm-Header-search Header-searchtb6Foi0-D9Vx rm-Header-search_feather Header-search_featherYsmQBn55F3d9"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div><div class="Header-search-placeholder3Vx4OmMPcjAi rm-SearchToggle-placeholder">Search</div><div class="rm-SearchToggle-shortcut"></div></button></div></div></div><div class="hub-search-results--reactApp " id="hub-search-results"><div class="hub-container"><div class="modal-backdrop show-modal rm-SearchModal" role="button" tabindex="0"></div></div></div></header><main class="LandingWrap16kRMSdr5J8g rm-LandingPage" id="content"><div class="LandingBlock3PM-HyBxby3X LandingBlock-Links38HRtdeemVvp"><div class="markdown-body"><h3>Guides</h3><ul><li><a href="/docs/overview">Introduction</a></li><li><a href="/docs/overview-1">Authentication Methods</a></li><li><a href="/docs/overview-2">Company methods</a></li><li><a href="/docs/overview-3">Domain methods</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/docs">View All…</a></li></ul></div><div class="markdown-body"><h3>Changelog</h3><ul>No changelogs found.</ul></div><div class="markdown-body"><h3>Discussions</h3><ul><li><a href="/discuss/6705a7a711bf0b005533c7cf" to="/discuss/6705a7a711bf0b005533c7cf">search_user lastlogin</a></li><li><a href="/discuss/65271b7256dbba000df1762b" to="/discuss/65271b7256dbba000df1762b">login to webmail with an obtained token</a></li><li><a href="/discuss/62d012f7df11ad0059642526" to="/discuss/62d012f7df11ad0059642526">Login Credentials for https://admin.test.hostedemail.com/api</a></li><li><a class="LandingBlock-link_viewAllX8PdNqsaoOrY" href="/discuss" to="/discuss">View All…</a></li></ul></div></div></main><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><div class="ModalWrapper" id="ChatGPT-modal"></div></div></div><div class="ng-non-bindable"><script id="ssr-props" data-initial-props="{"sidebars":{"docs":[{"_id":"5ec5b1919c42390057d90f2e","__v":6,"createdAt":"2016-01-29T21:45:37.383Z","version":"5ec5b1919c42390057d90f23","slug":"introduction","title":"Introduction","from_sync":false,"order":2,"pages":[{"_id":"5ec5b1919c42390057d90f83","link_url":"","slug":"overview","sync_unique":"","title":"Overview","category":"5ec5b1919c42390057d90f2e","order":0,"api":{"settings":"","auth":"required","params":[],"url":"","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"type":"basic","createdAt":"2016-01-29T21:46:59.788Z","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f84","category":"5ec5b1919c42390057d90f2e","hidden":false,"link_external":false,"order":1,"isReference":false,"type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"createdAt":"2016-01-29T21:47:46.901Z","link_url":"","slug":"roles","sync_unique":"","title":"Roles","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f85","category":"5ec5b1919c42390057d90f2e","type":"basic","sync_unique":"","hidden":false,"link_url":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","method":"get"},"order":2,"slug":"sending-requests","title":"Sending requests","createdAt":"2016-01-29T21:57:51.930Z","isReference":false,"link_external":false,"parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f87","link_external":false,"sync_unique":"","category":"5ec5b1919c42390057d90f2e","createdAt":"2016-01-30T20:42:59.846Z","hidden":false,"link_url":"","order":3,"slug":"errors","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"title":"Errors","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f88","category":"5ec5b1919c42390057d90f2e","hidden":false,"slug":"example-clients","type":"basic","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"order":4,"isReference":false,"link_external":false,"link_url":"","sync_unique":"","title":"Example clients","createdAt":"2016-01-30T21:26:42.242Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f89","title":"Data constraints","type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f2e","link_external":false,"slug":"data-constraints","link_url":"","sync_unique":"","createdAt":"2016-01-30T21:30:14.975Z","isReference":false,"hidden":false,"order":5,"parentDoc":null,"isBodyEmpty":false,"children":[]}],"project":"5ec5b1919c42390057d90fce","reference":false},{"_id":"5ec5b1919c42390057d90f30","order":3,"project":"5ec5b1919c42390057d90fce","version":"5ec5b1919c42390057d90f23","pages":[{"_id":"5ec5b1919c42390057d90f8a","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2016-01-30T21:51:05.081Z","slug":"overview-1","title":"Overview","type":"basic","hidden":false,"link_url":"","order":0,"category":"5ec5b1919c42390057d90f30","isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8b","hidden":false,"slug":"authenticate","category":"5ec5b1919c42390057d90f30","isReference":false,"link_url":"","title":"authenticate","createdAt":"2016-01-30T21:52:30.087Z","order":1,"sync_unique":"","type":"basic","link_external":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8c","hidden":false,"isReference":false,"link_external":false,"type":"basic","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"link_url":"","order":2,"title":"echo","category":"5ec5b1919c42390057d90f30","createdAt":"2016-01-30T23:50:04.667Z","slug":"echo","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcb","category":"5ec5b1919c42390057d90f30","createdAt":"2018-10-01T19:51:41.978Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"t2fa_setup","type":"basic","title":"t2fa_setup","isBodyEmpty":false,"children":[]}],"reference":false,"slug":"authentication-methods","title":"Authentication Methods","__v":3,"createdAt":"2016-01-30T21:47:55.396Z","from_sync":false},{"_id":"5ec5b1919c42390057d90f31","from_sync":false,"order":4,"pages":[{"_id":"5ec5b1919c42390057d90f8d","hidden":false,"link_external":false,"link_url":"","order":0,"title":"Overview","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"createdAt":"2016-01-30T23:58:55.961Z","category":"5ec5b1919c42390057d90f31","isReference":false,"slug":"overview-2","sync_unique":"","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8e","link_external":false,"sync_unique":"","createdAt":"2016-01-31T00:11:26.419Z","hidden":false,"order":1,"title":"change_company","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"category":"5ec5b1919c42390057d90f31","slug":"change_company","link_url":"","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8f","hidden":false,"link_url":"","title":"change_company_bulletin","createdAt":"2016-02-01T00:28:28.613Z","category":"5ec5b1919c42390057d90f31","link_external":false,"order":2,"sync_unique":"","isReference":false,"slug":"change_company_bulletin","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f90","link_external":false,"link_url":"","type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"isReference":false,"order":3,"title":"get_company","category":"5ec5b1919c42390057d90f31","createdAt":"2016-02-01T00:56:22.274Z","hidden":false,"slug":"get_company","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f91","createdAt":"2016-02-01T22:41:05.000Z","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f31","hidden":false,"link_external":false,"order":4,"slug":"get_company_bulletin","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"isReference":false,"link_url":"","title":"get_company_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f92","createdAt":"2016-02-01T23:01:47.071Z","link_url":"","slug":"get_company_changes","sync_unique":"","link_external":false,"title":"get_company_changes","category":"5ec5b1919c42390057d90f31","order":5,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"hidden":false,"isReference":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f93","category":"5ec5b1919c42390057d90f31","order":6,"type":"basic","hidden":false,"link_external":false,"sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2016-02-01T23:15:53.875Z","isReference":false,"link_url":"","slug":"post_company_bulletin-1","title":"post_company_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]}],"slug":"company-methods","title":"Company methods","version":"5ec5b1919c42390057d90f23","__v":9,"createdAt":"2016-01-30T23:58:20.127Z","project":"5ec5b1919c42390057d90fce","reference":false},{"_id":"5ec5b1919c42390057d90f32","version":"5ec5b1919c42390057d90f23","createdAt":"2016-02-02T01:48:08.558Z","from_sync":false,"project":"5ec5b1919c42390057d90fce","reference":false,"__v":10,"order":5,"pages":[{"_id":"5ec5b1919c42390057d90f95","category":"5ec5b1919c42390057d90f32","order":0,"slug":"overview-3","sync_unique":"","createdAt":"2016-02-02T01:50:05.505Z","hidden":false,"title":"Overview","link_external":false,"link_url":"","type":"basic","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f96","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"isReference":false,"createdAt":"2016-02-02T01:51:25.598Z","hidden":false,"link_url":"","link_external":false,"order":1,"slug":"change_domain","sync_unique":"","title":"change_domain","category":"5ec5b1919c42390057d90f32","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f97","hidden":false,"isReference":false,"order":2,"title":"change_domain_bulletin","type":"basic","sync_unique":"","createdAt":"2016-02-02T02:39:48.576Z","link_url":"","category":"5ec5b1919c42390057d90f32","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"link_external":false,"slug":"change_domain_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f98","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_url":"","order":3,"sync_unique":"","title":"delete_domain","type":"basic","hidden":false,"isReference":false,"slug":"delete_domain","link_external":false,"category":"5ec5b1919c42390057d90f32","createdAt":"2016-02-02T17:35:06.947Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f99","api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"type":"basic","category":"5ec5b1919c42390057d90f32","createdAt":"2016-02-02T18:03:31.572Z","link_external":false,"link_url":"","isReference":false,"slug":"get_domain","hidden":false,"order":4,"sync_unique":"","title":"get_domain","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9a","type":"basic","order":5,"title":"get_domain_bulletin","isReference":false,"link_external":false,"sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2016-02-03T15:29:44.209Z","hidden":false,"link_url":"","slug":"get_domain_bulletin","category":"5ec5b1919c42390057d90f32","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9b","createdAt":"2016-02-03T15:37:13.798Z","hidden":false,"isReference":false,"category":"5ec5b1919c42390057d90f32","title":"get_domain_changes","sync_unique":"","type":"basic","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"link_external":false,"link_url":"","order":6,"slug":"testinput","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9c","link_external":false,"isReference":false,"category":"5ec5b1919c42390057d90f32","hidden":false,"link_url":"","order":7,"slug":"post_domain_bulletin","sync_unique":"","title":"post_domain_bulletin","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"type":"basic","createdAt":"2016-02-03T15:48:39.449Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9d","link_url":"","type":"basic","createdAt":"2016-02-03T16:02:58.259Z","isReference":false,"sync_unique":"","category":"5ec5b1919c42390057d90f32","hidden":false,"order":8,"slug":"restore_domain","title":"restore_domain","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9e","createdAt":"2016-02-03T16:10:15.253Z","hidden":false,"link_external":false,"order":9,"slug":"search_domains","type":"basic","link_url":"","title":"search_domains","category":"5ec5b1919c42390057d90f32","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"isReference":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcd","category":"5ec5b1919c42390057d90f32","createdAt":"2018-11-16T20:13:33.692Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"push_domain","type":"basic","title":"push_domain","isBodyEmpty":false,"children":[]}],"slug":"domain-methods","title":"Domain methods"},{"_id":"5ec5b1919c42390057d90f33","order":6,"pages":[{"_id":"5ec5b1919c42390057d90f9f","link_external":false,"slug":"overview-4","type":"basic","hidden":false,"category":"5ec5b1919c42390057d90f33","title":"Overview","createdAt":"2016-02-03T18:13:28.260Z","isReference":false,"order":0,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_url":"","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa0","createdAt":"2016-02-03T18:14:35.407Z","isReference":false,"type":"basic","link_url":"","order":1,"slug":"create_workgroup","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required"},"category":"5ec5b1919c42390057d90f33","sync_unique":"","title":"create_workgroup","hidden":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa1","hidden":false,"link_url":"","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"category":"5ec5b1919c42390057d90f33","createdAt":"2016-02-03T18:26:22.770Z","isReference":false,"order":2,"slug":"delete_workgroup","title":"delete_workgroup","type":"basic","link_external":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa2","isReference":false,"createdAt":"2016-02-03T18:35:26.050Z","order":3,"slug":"search_workgroups","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"link_external":false,"title":"search_workgroups","hidden":false,"link_url":"","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f33","parentDoc":null,"isBodyEmpty":false,"children":[]}],"title":"Workgroup methods","reference":false,"slug":"workgroup-methods","version":"5ec5b1919c42390057d90f23","__v":4,"createdAt":"2016-02-03T18:13:02.463Z","from_sync":false,"project":"5ec5b1919c42390057d90fce"},{"_id":"5ec5b1919c42390057d90f34","project":"5ec5b1919c42390057d90fce","reference":false,"version":"5ec5b1919c42390057d90f23","createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90f94","order":0,"slug":"search_admins","title":"search_admins","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","hidden":false,"link_url":"","type":"basic","isReference":false,"sync_unique":"","link_external":false,"createdAt":"2016-02-02T01:30:59.043Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa3","link_url":"","order":1,"slug":"overview-5","title":"Overview","isReference":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","hidden":false,"sync_unique":"","createdAt":"2016-02-03T19:42:50.939Z","link_external":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa4","title":"change_user","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get"},"link_url":"","order":2,"createdAt":"2016-02-03T19:51:21.769Z","hidden":false,"isReference":false,"type":"basic","category":"5ec5b1919c42390057d90f34","link_external":false,"slug":"change_user","sync_unique":"","parentDoc":null,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa5","hidden":false,"link_url":"","slug":"delete_user","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","sync_unique":"","createdAt":"2016-02-03T21:39:20.120Z","isReference":false,"order":3,"link_external":false,"title":"delete_user","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa6","link_url":"","title":"generate_token","isReference":false,"category":"5ec5b1919c42390057d90f34","hidden":false,"link_external":false,"order":4,"sync_unique":"","type":"basic","createdAt":"2016-02-05T16:46:07.069Z","slug":"generate_token","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","params":[]},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa7","category":"5ec5b1919c42390057d90f34","hidden":false,"isReference":false,"order":5,"api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"link_external":false,"sync_unique":"","createdAt":"2016-02-05T19:15:46.685Z","link_url":"","slug":"get_deleted_contacts","title":"get_deleted_contacts","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa8","hidden":false,"link_url":"","slug":"get_deleted_messages","sync_unique":"","order":6,"type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T19:22:58.539Z","title":"get_deleted_messages","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa9","createdAt":"2016-02-05T19:38:37.113Z","link_url":"","category":"5ec5b1919c42390057d90f34","order":7,"title":"get_user","hidden":false,"isReference":false,"type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_external":false,"slug":"get_user","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90faa","isReference":false,"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"link_external":false,"link_url":"","order":8,"slug":"get_user_attribute_history","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T20:52:56.348Z","title":"get_user_attribute_history","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fab","createdAt":"2016-02-05T21:20:53.992Z","title":"get_user_changes","hidden":false,"link_url":"","slug":"get_user_changes","sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","link_external":false,"order":9,"isReference":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fac","link_url":"","link_external":false,"createdAt":"2016-02-05T22:12:23.446Z","isReference":false,"title":"get_user_folders","type":"basic","hidden":false,"order":10,"slug":"get_user_folders","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fad","link_external":false,"order":11,"slug":"get_user_messages","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"type":"basic","createdAt":"2016-02-05T22:28:27.548Z","link_url":"","hidden":false,"isReference":false,"sync_unique":"","title":"get_user_messages","category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fae","order":12,"api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]}},"hidden":false,"isReference":false,"type":"basic","link_external":false,"slug":"logout_user","sync_unique":"","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T22:40:12.856Z","link_url":"","title":"logout_user","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90faf","type":"basic","createdAt":"2016-02-05T22:46:51.699Z","hidden":false,"link_url":"","sync_unique":"","category":"5ec5b1919c42390057d90f34","isReference":false,"link_external":false,"title":"move_user_messages","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"order":13,"slug":"move_user_messages","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb0","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"link_external":false,"slug":"reindex","sync_unique":"","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-07T16:43:47.141Z","hidden":false,"link_url":"","order":14,"title":"reindex","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb1","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"category":"5ec5b1919c42390057d90f34","type":"basic","createdAt":"2016-02-07T17:34:10.522Z","isReference":false,"link_external":false,"link_url":"","slug":"rename_user","sync_unique":"","hidden":false,"order":15,"title":"rename_user","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb2","createdAt":"2016-02-07T17:44:50.073Z","link_external":false,"slug":"restore_deleted_contacts","title":"restore_deleted_contacts","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f34","isReference":false,"link_url":"","type":"basic","hidden":false,"order":16,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb3","createdAt":"2016-02-07T18:00:26.545Z","isReference":false,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f34","type":"basic","link_url":"","title":"restore_deleted_messages","hidden":false,"link_external":false,"order":17,"slug":"restore_deleted_messages","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb4","link_url":"","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"sync_unique":"","createdAt":"2016-02-07T18:39:36.068Z","slug":"restore_user","type":"basic","title":"restore_user","category":"5ec5b1919c42390057d90f34","hidden":false,"link_external":false,"order":18,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb5","order":19,"title":"search_users","createdAt":"2016-02-07T19:00:38.963Z","link_external":false,"sync_unique":"","type":"basic","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","method":"get"},"category":"5ec5b1919c42390057d90f34","hidden":false,"isReference":false,"link_url":"","slug":"search_users","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc4","category":"5ec5b1919c42390057d90f34","createdAt":"2018-05-01T20:51:28.967Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":20,"slug":"add_role","type":"basic","title":"add_role","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb6","hidden":false,"slug":"set_role","createdAt":"2016-02-07T20:26:05.273Z","link_external":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"isReference":false,"title":"set_role","link_url":"","order":21,"sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb7","isReference":false,"slug":"user_notify","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_external":false,"link_url":"","order":22,"title":"user_notify","type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-07T20:41:53.083Z","hidden":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc9","category":"5ec5b1919c42390057d90f34","createdAt":"2018-05-01T21:10:26.199Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":23,"slug":"remove_role","type":"basic","title":"remove_role","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fca","category":"5ec5b1919c42390057d90f34","createdAt":"2018-10-01T19:17:57.546Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"user_disable_2fa","type":"basic","title":"user_disable_2fa","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcc","category":"5ec5b1919c42390057d90f34","createdAt":"2018-10-01T20:19:09.848Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"app_password","type":"basic","title":"app_password","isBodyEmpty":false,"children":[]},{"_id":"60d22d8d3ef8360055c1c050","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"reset_email_test","type":"basic","slug":"reset_email_test","order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-22T18:35:57.356Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]},{"_id":"61784133ae735005383571f5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"get_sieve","type":"basic","slug":"get_sieve","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-26T17:56:03.873Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]},{"_id":"61784870ee606d00550f7de0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"set_sieve","type":"basic","slug":"set_sieve","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-26T18:26:56.255Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]}],"slug":"user-methods","title":"User methods","__v":21,"order":7},{"_id":"5ec5b1919c42390057d90f35","createdAt":"2016-02-07T20:55:06.303Z","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90fb8","type":"basic","hidden":false,"isReference":false,"slug":"overview-6","title":"Overview","category":"5ec5b1919c42390057d90f35","createdAt":"2016-02-08T16:26:09.160Z","order":0,"sync_unique":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_external":false,"link_url":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb9","isReference":false,"sync_unique":"","title":"search_brands","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required"},"category":"5ec5b1919c42390057d90f35","slug":"search_brands","createdAt":"2016-02-08T16:26:45.839Z","link_url":"","type":"basic","hidden":false,"link_external":false,"order":1,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc5","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T20:56:14.992Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"slug":"_change_brand","type":"basic","title":"_change_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc6","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T20:57:10.039Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"slug":"_get_brand","type":"basic","title":"_get_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc7","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T21:01:00.326Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"slug":"_delete_brand","type":"basic","title":"_delete_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc8","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T21:09:28.179Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"slug":"search_brand_members","type":"basic","title":"search_brand_members","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"slug":"brand-methods","version":"5ec5b1919c42390057d90f23","__v":3,"order":8,"project":"5ec5b1919c42390057d90fce","title":"Brand Methods"},{"_id":"5ec5b1919c42390057d90f36","project":"5ec5b1919c42390057d90fce","title":"Stats methods","version":"5ec5b1919c42390057d90f23","order":9,"pages":[{"_id":"5ec5b1919c42390057d90fba","isReference":false,"link_external":false,"order":0,"sync_unique":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f36","hidden":false,"title":"Overview","type":"basic","createdAt":"2016-02-08T16:40:33.050Z","link_url":"","slug":"overview-7","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbb","category":"5ec5b1919c42390057d90f36","slug":"stats_list","title":"stats_list","createdAt":"2016-02-08T16:42:05.554Z","hidden":false,"link_url":"","order":1,"link_external":false,"type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"isReference":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbc","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"slug":"stats_snapshot","type":"basic","category":"5ec5b1919c42390057d90f36","hidden":false,"order":2,"title":"stats_snapshot","createdAt":"2016-02-08T16:53:07.423Z","isReference":false,"link_external":false,"link_url":"","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbd","createdAt":"2016-02-08T16:58:09.250Z","link_external":false,"link_url":"","order":3,"slug":"stats_summary","type":"basic","hidden":false,"isReference":false,"api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"category":"5ec5b1919c42390057d90f36","title":"stats_summary","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"slug":"stats-methods","__v":3,"createdAt":"2016-02-08T16:39:53.889Z","from_sync":false},{"_id":"5ec5b1919c42390057d90f37","__v":5,"createdAt":"2016-02-08T17:17:31.562Z","order":9999,"reference":false,"title":"Migration methods","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90fbe","link_url":"","title":"Overview","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"createdAt":"2016-02-08T17:18:17.737Z","isReference":false,"sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f37","hidden":false,"link_external":false,"order":0,"slug":"overview-8","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbf","link_url":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"sync_unique":"","createdAt":"2016-02-08T17:22:05.990Z","hidden":false,"title":"migration_add","category":"5ec5b1919c42390057d90f37","isReference":false,"link_external":false,"order":1,"slug":"migration_add","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc0","hidden":false,"link_url":"","slug":"testinput-1","isReference":false,"link_external":false,"order":2,"title":"migration_jobs","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"category":"5ec5b1919c42390057d90f37","sync_unique":"","createdAt":"2016-02-08T17:37:51.174Z","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc1","title":"migration_status","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":""},"link_url":"","slug":"migration_status","isReference":false,"sync_unique":"","category":"5ec5b1919c42390057d90f37","hidden":false,"link_external":false,"order":3,"type":"basic","createdAt":"2016-02-08T17:43:01.125Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc2","category":"5ec5b1919c42390057d90f37","link_external":false,"sync_unique":"","type":"basic","createdAt":"2016-02-08T17:58:37.208Z","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"isReference":false,"link_url":"","title":"migration_trace","hidden":false,"order":4,"slug":"migration_trace","parentDoc":null,"isBodyEmpty":false,"children":[]}],"project":"5ec5b1919c42390057d90fce","slug":"migration-methods","version":"5ec5b1919c42390057d90f23"}],"refs":[]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"MzViMjIyMWFmMmQ5ZjExOWI0ZTEwNDk2NmYyNWY5MWFhZmM2ZDQ2MDRjZDdkY2E4MGNjZmI3ZDA1MWQ2NTJjOXRhZ0ZpbHRlcnM9KHByb2plY3Q6NWVjNWIxOTE5YzQyMzkwMDU3ZDkwZmNlKSwodmVyc2lvbjpub25lLHZlcnNpb246NWVjNWIxOTE5YzQyMzkwMDU3ZDkwZjIzKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6RGlzY3Vzcyk=","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"docs":true,"examples":true,"reference":false,"blog":true,"changelog":true,"discuss":true,"suggested_edits":true,"custompages":false,"logs":false,"tutorials":false,"graphql":false},"id":"5ec5b1919c42390057d90fce","name":"API OpenSRS Email","subdomain":"api-opensrs-email-hub2","subpath":"","nav_names":{"docs":"","reference":"","blog":"","changelog":"","discuss":"","tutorials":"","recipes":""}}],"UrlManager":{"options":{"child":false,"parent":null,"hasOneChild":false,"project":null,"version":null,"lang":"en"},"defaults":{"lang":"en"}},"urlManagerOpts":{"lang":"en","parent":{"childrenProjects":[]},"project":{"subdomain":"api-opensrs-email-hub2"},"version":"1.1"}},"changelogs":[],"discuss":[{"anonymous_user":{"name":"Adam"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2024-11-26T18:55:49.443Z"},"title":"search_user lastlogin","votes":0,"voters":[],"hub2voters":[],"views":126,"type":"question","solved":false,"body":"The lastlogin property returned when calling the /search_user endpoint seems to also include the \"smtpin\" (Last Delivery Date) field among the possible candidates (imap4, oma, pop3, --smtpin, smtprelay, webmail).","isSpam":false,"isFAQ":false,"edited":false,"comments":[],"tags":[],"revision":128,"_id":"6705a7a711bf0b005533c7cf","createdAt":"2024-10-08T21:44:07.580Z","updatedAt":"2024-10-08T21:44:07.580Z","project":"5ec5b1919c42390057d90fce","initVersion":"5ec5b1919c42390057d90f23","__v":0,"effective_user":{"name":"Adam","isAdmin":false},"vote_count":0,"id":"6705a7a711bf0b005533c7cf"},{"anonymous_user":{"name":"Grifo"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2024-11-27T16:31:34.652Z"},"title":"login to webmail with an obtained token","votes":0,"voters":[],"hub2voters":[],"views":1240,"type":"question","solved":false,"body":"I had success obtaining a token via API, and also could use the token in place of a password, but can't find any documentation on how to use such token to redirect the user to it's inbox automatically\n\nI believe that it would be the most obvious use to a token, so we can provide a single sign on and integrate the inbox with our control panel","isSpam":false,"isFAQ":false,"edited":false,"comments":["6709178d6b30e5006d4ff851"],"tags":[],"revision":1243,"_id":"65271b7256dbba000df1762b","createdAt":"2023-10-11T22:02:26.420Z","updatedAt":"2023-10-11T22:02:26.420Z","project":"5ec5b1919c42390057d90fce","initVersion":"5ec5b1919c42390057d90f23","__v":1,"effective_user":{"name":"Grifo","isAdmin":false},"vote_count":0,"id":"65271b7256dbba000df1762b"},{"anonymous_user":{"name":"Simon Jenny"},"algolia":{"recordCount":1,"publishPending":false,"updatedAt":"2024-11-27T13:54:57.853Z"},"title":"Login Credentials for https://admin.test.hostedemail.com/api","votes":0,"voters":[],"hub2voters":[],"views":1802,"type":"question","solved":false,"body":"Hi\n\nI cannot find the documentation to define the Login Credentials for https://admin.test.hostedemail.com/api. In the Admin Panel we are able to create and set a User for the production environment but not for the test environment.\n\nRegards,\nSimon Jenny","isSpam":false,"isFAQ":false,"edited":false,"comments":["62d04493cdfd7700135c08a7","62d04d0a74c52700760d68cf","670a5a4cbdcf8d003d809c09"],"tags":[],"revision":1178,"_id":"62d012f7df11ad0059642526","pendingAlgoliaPublish":false,"updatedAt":null,"createdAt":"2022-07-14T12:58:31.079Z","project":"5ec5b1919c42390057d90fce","initVersion":"5ec5b1919c42390057d90f23","__v":3,"effective_user":{"name":"Simon Jenny","isAdmin":false},"vote_count":0,"id":"62d012f7df11ad0059642526"}],"docsCategories":[{"_id":"5ec5b1919c42390057d90f2e","__v":6,"createdAt":"2016-01-29T21:45:37.383Z","version":"5ec5b1919c42390057d90f23","slug":"introduction","title":"Introduction","from_sync":false,"order":2,"pages":[{"_id":"5ec5b1919c42390057d90f83","link_url":"","slug":"overview","sync_unique":"","title":"Overview","category":"5ec5b1919c42390057d90f2e","order":0,"api":{"settings":"","auth":"required","params":[],"url":"","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"type":"basic","createdAt":"2016-01-29T21:46:59.788Z","hidden":false,"isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f84","category":"5ec5b1919c42390057d90f2e","hidden":false,"link_external":false,"order":1,"isReference":false,"type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"createdAt":"2016-01-29T21:47:46.901Z","link_url":"","slug":"roles","sync_unique":"","title":"Roles","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f85","category":"5ec5b1919c42390057d90f2e","type":"basic","sync_unique":"","hidden":false,"link_url":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","method":"get"},"order":2,"slug":"sending-requests","title":"Sending requests","createdAt":"2016-01-29T21:57:51.930Z","isReference":false,"link_external":false,"parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f87","link_external":false,"sync_unique":"","category":"5ec5b1919c42390057d90f2e","createdAt":"2016-01-30T20:42:59.846Z","hidden":false,"link_url":"","order":3,"slug":"errors","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"title":"Errors","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f88","category":"5ec5b1919c42390057d90f2e","hidden":false,"slug":"example-clients","type":"basic","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"order":4,"isReference":false,"link_external":false,"link_url":"","sync_unique":"","title":"Example clients","createdAt":"2016-01-30T21:26:42.242Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f89","title":"Data constraints","type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f2e","link_external":false,"slug":"data-constraints","link_url":"","sync_unique":"","createdAt":"2016-01-30T21:30:14.975Z","isReference":false,"hidden":false,"order":5,"parentDoc":null,"isBodyEmpty":false,"children":[]}],"project":"5ec5b1919c42390057d90fce","reference":false},{"_id":"5ec5b1919c42390057d90f30","order":3,"project":"5ec5b1919c42390057d90fce","version":"5ec5b1919c42390057d90f23","pages":[{"_id":"5ec5b1919c42390057d90f8a","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"createdAt":"2016-01-30T21:51:05.081Z","slug":"overview-1","title":"Overview","type":"basic","hidden":false,"link_url":"","order":0,"category":"5ec5b1919c42390057d90f30","isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8b","hidden":false,"slug":"authenticate","category":"5ec5b1919c42390057d90f30","isReference":false,"link_url":"","title":"authenticate","createdAt":"2016-01-30T21:52:30.087Z","order":1,"sync_unique":"","type":"basic","link_external":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8c","hidden":false,"isReference":false,"link_external":false,"type":"basic","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"link_url":"","order":2,"title":"echo","category":"5ec5b1919c42390057d90f30","createdAt":"2016-01-30T23:50:04.667Z","slug":"echo","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcb","category":"5ec5b1919c42390057d90f30","createdAt":"2018-10-01T19:51:41.978Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"t2fa_setup","type":"basic","title":"t2fa_setup","isBodyEmpty":false,"children":[]}],"reference":false,"slug":"authentication-methods","title":"Authentication Methods","__v":3,"createdAt":"2016-01-30T21:47:55.396Z","from_sync":false},{"_id":"5ec5b1919c42390057d90f31","from_sync":false,"order":4,"pages":[{"_id":"5ec5b1919c42390057d90f8d","hidden":false,"link_external":false,"link_url":"","order":0,"title":"Overview","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"createdAt":"2016-01-30T23:58:55.961Z","category":"5ec5b1919c42390057d90f31","isReference":false,"slug":"overview-2","sync_unique":"","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8e","link_external":false,"sync_unique":"","createdAt":"2016-01-31T00:11:26.419Z","hidden":false,"order":1,"title":"change_company","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"category":"5ec5b1919c42390057d90f31","slug":"change_company","link_url":"","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f8f","hidden":false,"link_url":"","title":"change_company_bulletin","createdAt":"2016-02-01T00:28:28.613Z","category":"5ec5b1919c42390057d90f31","link_external":false,"order":2,"sync_unique":"","isReference":false,"slug":"change_company_bulletin","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f90","link_external":false,"link_url":"","type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"isReference":false,"order":3,"title":"get_company","category":"5ec5b1919c42390057d90f31","createdAt":"2016-02-01T00:56:22.274Z","hidden":false,"slug":"get_company","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f91","createdAt":"2016-02-01T22:41:05.000Z","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f31","hidden":false,"link_external":false,"order":4,"slug":"get_company_bulletin","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"isReference":false,"link_url":"","title":"get_company_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f92","createdAt":"2016-02-01T23:01:47.071Z","link_url":"","slug":"get_company_changes","sync_unique":"","link_external":false,"title":"get_company_changes","category":"5ec5b1919c42390057d90f31","order":5,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"hidden":false,"isReference":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f93","category":"5ec5b1919c42390057d90f31","order":6,"type":"basic","hidden":false,"link_external":false,"sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2016-02-01T23:15:53.875Z","isReference":false,"link_url":"","slug":"post_company_bulletin-1","title":"post_company_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]}],"slug":"company-methods","title":"Company methods","version":"5ec5b1919c42390057d90f23","__v":9,"createdAt":"2016-01-30T23:58:20.127Z","project":"5ec5b1919c42390057d90fce","reference":false},{"_id":"5ec5b1919c42390057d90f32","version":"5ec5b1919c42390057d90f23","createdAt":"2016-02-02T01:48:08.558Z","from_sync":false,"project":"5ec5b1919c42390057d90fce","reference":false,"__v":10,"order":5,"pages":[{"_id":"5ec5b1919c42390057d90f95","category":"5ec5b1919c42390057d90f32","order":0,"slug":"overview-3","sync_unique":"","createdAt":"2016-02-02T01:50:05.505Z","hidden":false,"title":"Overview","link_external":false,"link_url":"","type":"basic","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f96","type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"isReference":false,"createdAt":"2016-02-02T01:51:25.598Z","hidden":false,"link_url":"","link_external":false,"order":1,"slug":"change_domain","sync_unique":"","title":"change_domain","category":"5ec5b1919c42390057d90f32","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f97","hidden":false,"isReference":false,"order":2,"title":"change_domain_bulletin","type":"basic","sync_unique":"","createdAt":"2016-02-02T02:39:48.576Z","link_url":"","category":"5ec5b1919c42390057d90f32","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"link_external":false,"slug":"change_domain_bulletin","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f98","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_url":"","order":3,"sync_unique":"","title":"delete_domain","type":"basic","hidden":false,"isReference":false,"slug":"delete_domain","link_external":false,"category":"5ec5b1919c42390057d90f32","createdAt":"2016-02-02T17:35:06.947Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f99","api":{"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"type":"basic","category":"5ec5b1919c42390057d90f32","createdAt":"2016-02-02T18:03:31.572Z","link_external":false,"link_url":"","isReference":false,"slug":"get_domain","hidden":false,"order":4,"sync_unique":"","title":"get_domain","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9a","type":"basic","order":5,"title":"get_domain_bulletin","isReference":false,"link_external":false,"sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"createdAt":"2016-02-03T15:29:44.209Z","hidden":false,"link_url":"","slug":"get_domain_bulletin","category":"5ec5b1919c42390057d90f32","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9b","createdAt":"2016-02-03T15:37:13.798Z","hidden":false,"isReference":false,"category":"5ec5b1919c42390057d90f32","title":"get_domain_changes","sync_unique":"","type":"basic","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"link_external":false,"link_url":"","order":6,"slug":"testinput","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9c","link_external":false,"isReference":false,"category":"5ec5b1919c42390057d90f32","hidden":false,"link_url":"","order":7,"slug":"post_domain_bulletin","sync_unique":"","title":"post_domain_bulletin","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"type":"basic","createdAt":"2016-02-03T15:48:39.449Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9d","link_url":"","type":"basic","createdAt":"2016-02-03T16:02:58.259Z","isReference":false,"sync_unique":"","category":"5ec5b1919c42390057d90f32","hidden":false,"order":8,"slug":"restore_domain","title":"restore_domain","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90f9e","createdAt":"2016-02-03T16:10:15.253Z","hidden":false,"link_external":false,"order":9,"slug":"search_domains","type":"basic","link_url":"","title":"search_domains","category":"5ec5b1919c42390057d90f32","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"isReference":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcd","category":"5ec5b1919c42390057d90f32","createdAt":"2018-11-16T20:13:33.692Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"push_domain","type":"basic","title":"push_domain","isBodyEmpty":false,"children":[]}],"slug":"domain-methods","title":"Domain methods"},{"_id":"5ec5b1919c42390057d90f33","order":6,"pages":[{"_id":"5ec5b1919c42390057d90f9f","link_external":false,"slug":"overview-4","type":"basic","hidden":false,"category":"5ec5b1919c42390057d90f33","title":"Overview","createdAt":"2016-02-03T18:13:28.260Z","isReference":false,"order":0,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_url":"","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa0","createdAt":"2016-02-03T18:14:35.407Z","isReference":false,"type":"basic","link_url":"","order":1,"slug":"create_workgroup","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required"},"category":"5ec5b1919c42390057d90f33","sync_unique":"","title":"create_workgroup","hidden":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa1","hidden":false,"link_url":"","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]}},"category":"5ec5b1919c42390057d90f33","createdAt":"2016-02-03T18:26:22.770Z","isReference":false,"order":2,"slug":"delete_workgroup","title":"delete_workgroup","type":"basic","link_external":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa2","isReference":false,"createdAt":"2016-02-03T18:35:26.050Z","order":3,"slug":"search_workgroups","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"link_external":false,"title":"search_workgroups","hidden":false,"link_url":"","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f33","parentDoc":null,"isBodyEmpty":false,"children":[]}],"title":"Workgroup methods","reference":false,"slug":"workgroup-methods","version":"5ec5b1919c42390057d90f23","__v":4,"createdAt":"2016-02-03T18:13:02.463Z","from_sync":false,"project":"5ec5b1919c42390057d90fce"},{"_id":"5ec5b1919c42390057d90f34","project":"5ec5b1919c42390057d90fce","reference":false,"version":"5ec5b1919c42390057d90f23","createdAt":"2016-02-03T19:42:30.051Z","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90f94","order":0,"slug":"search_admins","title":"search_admins","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","hidden":false,"link_url":"","type":"basic","isReference":false,"sync_unique":"","link_external":false,"createdAt":"2016-02-02T01:30:59.043Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa3","link_url":"","order":1,"slug":"overview-5","title":"Overview","isReference":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","hidden":false,"sync_unique":"","createdAt":"2016-02-03T19:42:50.939Z","link_external":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa4","title":"change_user","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get"},"link_url":"","order":2,"createdAt":"2016-02-03T19:51:21.769Z","hidden":false,"isReference":false,"type":"basic","category":"5ec5b1919c42390057d90f34","link_external":false,"slug":"change_user","sync_unique":"","parentDoc":null,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa5","hidden":false,"link_url":"","slug":"delete_user","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","sync_unique":"","createdAt":"2016-02-03T21:39:20.120Z","isReference":false,"order":3,"link_external":false,"title":"delete_user","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa6","link_url":"","title":"generate_token","isReference":false,"category":"5ec5b1919c42390057d90f34","hidden":false,"link_external":false,"order":4,"sync_unique":"","type":"basic","createdAt":"2016-02-05T16:46:07.069Z","slug":"generate_token","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","params":[]},"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa7","category":"5ec5b1919c42390057d90f34","hidden":false,"isReference":false,"order":5,"api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required"},"link_external":false,"sync_unique":"","createdAt":"2016-02-05T19:15:46.685Z","link_url":"","slug":"get_deleted_contacts","title":"get_deleted_contacts","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa8","hidden":false,"link_url":"","slug":"get_deleted_messages","sync_unique":"","order":6,"type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T19:22:58.539Z","title":"get_deleted_messages","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fa9","createdAt":"2016-02-05T19:38:37.113Z","link_url":"","category":"5ec5b1919c42390057d90f34","order":7,"title":"get_user","hidden":false,"isReference":false,"type":"basic","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_external":false,"slug":"get_user","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90faa","isReference":false,"api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"link_external":false,"link_url":"","order":8,"slug":"get_user_attribute_history","sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T20:52:56.348Z","title":"get_user_attribute_history","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fab","createdAt":"2016-02-05T21:20:53.992Z","title":"get_user_changes","hidden":false,"link_url":"","slug":"get_user_changes","sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"category":"5ec5b1919c42390057d90f34","link_external":false,"order":9,"isReference":false,"type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fac","link_url":"","link_external":false,"createdAt":"2016-02-05T22:12:23.446Z","isReference":false,"title":"get_user_folders","type":"basic","hidden":false,"order":10,"slug":"get_user_folders","sync_unique":"","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fad","link_external":false,"order":11,"slug":"get_user_messages","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"type":"basic","createdAt":"2016-02-05T22:28:27.548Z","link_url":"","hidden":false,"isReference":false,"sync_unique":"","title":"get_user_messages","category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fae","order":12,"api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]}},"hidden":false,"isReference":false,"type":"basic","link_external":false,"slug":"logout_user","sync_unique":"","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-05T22:40:12.856Z","link_url":"","title":"logout_user","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90faf","type":"basic","createdAt":"2016-02-05T22:46:51.699Z","hidden":false,"link_url":"","sync_unique":"","category":"5ec5b1919c42390057d90f34","isReference":false,"link_external":false,"title":"move_user_messages","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"order":13,"slug":"move_user_messages","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb0","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":""},"isReference":false,"link_external":false,"slug":"reindex","sync_unique":"","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-07T16:43:47.141Z","hidden":false,"link_url":"","order":14,"title":"reindex","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb1","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"category":"5ec5b1919c42390057d90f34","type":"basic","createdAt":"2016-02-07T17:34:10.522Z","isReference":false,"link_external":false,"link_url":"","slug":"rename_user","sync_unique":"","hidden":false,"order":15,"title":"rename_user","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb2","createdAt":"2016-02-07T17:44:50.073Z","link_external":false,"slug":"restore_deleted_contacts","title":"restore_deleted_contacts","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f34","isReference":false,"link_url":"","type":"basic","hidden":false,"order":16,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb3","createdAt":"2016-02-07T18:00:26.545Z","isReference":false,"api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f34","type":"basic","link_url":"","title":"restore_deleted_messages","hidden":false,"link_external":false,"order":17,"slug":"restore_deleted_messages","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb4","link_url":"","api":{"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"isReference":false,"sync_unique":"","createdAt":"2016-02-07T18:39:36.068Z","slug":"restore_user","type":"basic","title":"restore_user","category":"5ec5b1919c42390057d90f34","hidden":false,"link_external":false,"order":18,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb5","order":19,"title":"search_users","createdAt":"2016-02-07T19:00:38.963Z","link_external":false,"sync_unique":"","type":"basic","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","method":"get"},"category":"5ec5b1919c42390057d90f34","hidden":false,"isReference":false,"link_url":"","slug":"search_users","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc4","category":"5ec5b1919c42390057d90f34","createdAt":"2018-05-01T20:51:28.967Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":20,"slug":"add_role","type":"basic","title":"add_role","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb6","hidden":false,"slug":"set_role","createdAt":"2016-02-07T20:26:05.273Z","link_external":false,"api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"isReference":false,"title":"set_role","link_url":"","order":21,"sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f34","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb7","isReference":false,"slug":"user_notify","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"link_external":false,"link_url":"","order":22,"title":"user_notify","type":"basic","category":"5ec5b1919c42390057d90f34","createdAt":"2016-02-07T20:41:53.083Z","hidden":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc9","category":"5ec5b1919c42390057d90f34","createdAt":"2018-05-01T21:10:26.199Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":23,"slug":"remove_role","type":"basic","title":"remove_role","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fca","category":"5ec5b1919c42390057d90f34","createdAt":"2018-10-01T19:17:57.546Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"user_disable_2fa","type":"basic","title":"user_disable_2fa","isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fcc","category":"5ec5b1919c42390057d90f34","createdAt":"2018-10-01T20:19:09.848Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":999,"slug":"app_password","type":"basic","title":"app_password","isBodyEmpty":false,"children":[]},{"_id":"60d22d8d3ef8360055c1c050","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"reset_email_test","type":"basic","slug":"reset_email_test","order":999,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-06-22T18:35:57.356Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]},{"_id":"61784133ae735005383571f5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"get_sieve","type":"basic","slug":"get_sieve","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-26T17:56:03.873Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]},{"_id":"61784870ee606d00550f7de0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"set_sieve","type":"basic","slug":"set_sieve","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-10-26T18:26:56.255Z","category":"5ec5b1919c42390057d90f34","isBodyEmpty":false,"children":[]}],"slug":"user-methods","title":"User methods","__v":21,"order":7},{"_id":"5ec5b1919c42390057d90f35","createdAt":"2016-02-07T20:55:06.303Z","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90fb8","type":"basic","hidden":false,"isReference":false,"slug":"overview-6","title":"Overview","category":"5ec5b1919c42390057d90f35","createdAt":"2016-02-08T16:26:09.160Z","order":0,"sync_unique":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"link_external":false,"link_url":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fb9","isReference":false,"sync_unique":"","title":"search_brands","api":{"examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"","auth":"required"},"category":"5ec5b1919c42390057d90f35","slug":"search_brands","createdAt":"2016-02-08T16:26:45.839Z","link_url":"","type":"basic","hidden":false,"link_external":false,"order":1,"parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc5","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T20:56:14.992Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":2,"slug":"_change_brand","type":"basic","title":"_change_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc6","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T20:57:10.039Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":3,"slug":"_get_brand","type":"basic","title":"_get_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc7","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T21:01:00.326Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"isReference":false,"order":4,"slug":"_delete_brand","type":"basic","title":"_delete_brand","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc8","category":"5ec5b1919c42390057d90f35","createdAt":"2018-05-01T21:09:28.179Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"examples":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":5,"slug":"search_brand_members","type":"basic","title":"search_brand_members","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"slug":"brand-methods","version":"5ec5b1919c42390057d90f23","__v":3,"order":8,"project":"5ec5b1919c42390057d90fce","title":"Brand Methods"},{"_id":"5ec5b1919c42390057d90f36","project":"5ec5b1919c42390057d90fce","title":"Stats methods","version":"5ec5b1919c42390057d90f23","order":9,"pages":[{"_id":"5ec5b1919c42390057d90fba","isReference":false,"link_external":false,"order":0,"sync_unique":"","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"category":"5ec5b1919c42390057d90f36","hidden":false,"title":"Overview","type":"basic","createdAt":"2016-02-08T16:40:33.050Z","link_url":"","slug":"overview-7","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbb","category":"5ec5b1919c42390057d90f36","slug":"stats_list","title":"stats_list","createdAt":"2016-02-08T16:42:05.554Z","hidden":false,"link_url":"","order":1,"link_external":false,"type":"basic","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"isReference":false,"sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbc","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"slug":"stats_snapshot","type":"basic","category":"5ec5b1919c42390057d90f36","hidden":false,"order":2,"title":"stats_snapshot","createdAt":"2016-02-08T16:53:07.423Z","isReference":false,"link_external":false,"link_url":"","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbd","createdAt":"2016-02-08T16:58:09.250Z","link_external":false,"link_url":"","order":3,"slug":"stats_summary","type":"basic","hidden":false,"isReference":false,"api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":""},"category":"5ec5b1919c42390057d90f36","title":"stats_summary","sync_unique":"","parentDoc":null,"isBodyEmpty":false,"children":[]}],"reference":false,"slug":"stats-methods","__v":3,"createdAt":"2016-02-08T16:39:53.889Z","from_sync":false},{"_id":"5ec5b1919c42390057d90f37","__v":5,"createdAt":"2016-02-08T17:17:31.562Z","order":9999,"reference":false,"title":"Migration methods","from_sync":false,"pages":[{"_id":"5ec5b1919c42390057d90fbe","link_url":"","title":"Overview","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[]},"createdAt":"2016-02-08T17:18:17.737Z","isReference":false,"sync_unique":"","type":"basic","category":"5ec5b1919c42390057d90f37","hidden":false,"link_external":false,"order":0,"slug":"overview-8","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fbf","link_url":"","api":{"auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":""},"sync_unique":"","createdAt":"2016-02-08T17:22:05.990Z","hidden":false,"title":"migration_add","category":"5ec5b1919c42390057d90f37","isReference":false,"link_external":false,"order":1,"slug":"migration_add","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc0","hidden":false,"link_url":"","slug":"testinput-1","isReference":false,"link_external":false,"order":2,"title":"migration_jobs","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":""},"category":"5ec5b1919c42390057d90f37","sync_unique":"","createdAt":"2016-02-08T17:37:51.174Z","type":"basic","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc1","title":"migration_status","api":{"url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":""},"link_url":"","slug":"migration_status","isReference":false,"sync_unique":"","category":"5ec5b1919c42390057d90f37","hidden":false,"link_external":false,"order":3,"type":"basic","createdAt":"2016-02-08T17:43:01.125Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"5ec5b1919c42390057d90fc2","category":"5ec5b1919c42390057d90f37","link_external":false,"sync_unique":"","type":"basic","createdAt":"2016-02-08T17:58:37.208Z","api":{"settings":"","url":"","auth":"required","examples":{"codes":[]},"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"isReference":false,"link_url":"","title":"migration_trace","hidden":false,"order":4,"slug":"migration_trace","parentDoc":null,"isBodyEmpty":false,"children":[]}],"project":"5ec5b1919c42390057d90fce","slug":"migration-methods","version":"5ec5b1919c42390057d90f23"}],"refCategories":[],"meta":{"title":"API OpenSRS Email","type":"home"},"config":{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}},"context":{"labs":{},"user":{},"terms":[],"variables":{"user":{},"defaults":[]},"project":{"_id":"5ec5b1919c42390057d90fce","appearance":{"main_body":{"type":"none"},"colors":{"highlight":"","main":"#076AFB","main_alt":"","header_text":"","body_highlight":"#076AFB","custom_login_link_color":""},"typography":{"headline":"Open+Sans:400:sans-serif","body":"Open+Sans:400:sans-serif","typekit":false,"tk_key":"","tk_headline":"","tk_body":""},"header":{"style":"solid","img":[],"img_size":"auto","img_pos":"tl"},"body":{"style":"none"},"link_logo_to_url":false,"theme":"line","notheme":false,"overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"logo":["https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png","OpenSRS knowledgebase (1).png",221,64,"#c6eff5","https://files.readme.io/b4e3c2a-OpenSRS_knowledgebase_1.png"],"logo_white":[],"logo_white_use":false,"favicon":["https://files.readme.io/49bce28-Favicon_regular.svg","Favicon_regular.svg",32,32,"#04034a"],"stylesheet":"","stylesheet_hub2":"","javascript":"","javascript_hub2":"","html_promo":"","html_body":"","html_footer":"","html_head":"","html_footer_meta":"","html_hidelinks":false,"showVersion":true,"hideTableOfContents":false,"nextStepsLabel":"","promos":[{"extras":{"type":"buttons","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"The API: OpenSRS Hosted Email Developer Hub","text":"Welcome to the API: OpenSRS Hosted Email developer hub. You'll find comprehensive guides and documentation to help you start working with API: OpenSRS Hosted Email as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"569f9cf6650e1d1900f96b5c"}],"subheaderStyle":"dropdown","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":"","markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"referenceLayout":"row","splitReferenceDocs":false,"showMetricsInReference":true,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"colorScheme":"light","allowApiExplorerJsonEditor":false,"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"logo_large":false},"custom_domain":"email.opensrs.guide","childrenProjects":[],"derivedPlan":"startup2018","description":"","error404":"","experiments":[],"first_page":"landing","flags":{"allow_hub2":true,"hub2":true,"migrationRun":true,"oauth":false,"swagger":false,"correctnewlines":false,"speedyRender":false,"allowXFrame":false,"jwt":false,"hideGoogleAnalytics":false,"stripe":false,"disableDiscuss":false,"newSearch":true,"tutorials":true,"useReactApp":true,"allowApiExplorerJsonEditor":false,"alwaysShowDocPublishStatus":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"migrationSwaggerRun":false,"newEditor":true,"newMarkdownBetaProgram":true,"oldMarkdown":false,"rdmdCompatibilityMode":false,"singleProjectEnterprise":false,"staging":false,"translation":false,"dashReact":false,"allowReferenceUpgrade":false,"metricsV2":true,"allowDarkMode":false,"disablePasswordlessLogin":false,"forceDarkMode":false,"newEditorDash":true,"reviewWorkflow":true,"star":false,"useReactGLP":false,"billingRedesignEnabled":true,"allowReusableOTPs":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"annualBillingEnabled":true,"apiAccessRevoked":false,"developerPortal":false,"disableAutoTranslate":false,"disableSAMLScoping":false,"disableSignups":false,"mdx":false,"owlbotAi":false,"passwordlessLogin":"default","superHub":false,"superHubDevelopment":false,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true},"fullBaseUrl":"https://email.opensrs.guide/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[],"graphqlSchema":"","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"","settings":{}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"type":"links"}],"mdxMigrationStatus":"rdmd","metrics":{"monthlyLimit":0,"thumbsEnabled":false,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":true,"reference":false,"blog":true,"changelog":true,"discuss":true,"suggested_edits":true,"custompages":false,"logs":false,"tutorials":false,"graphql":false},"name":"API OpenSRS Email","nav_names":{"docs":"","reference":"","blog":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"api":false,"appearance":false,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"owlbot":{"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"enabled":false,"isPaying":false,"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":null,"planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":false,"points":50},"tryItNow":{"enabled":false,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":false,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":true,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":false,"points":1},"integrations":{"enabled":false,"points":2}},"totalScore":80},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"5ec5b1919c42390057d90f23","project":"5ec5b1919c42390057d90fce","__v":0,"forked_from":"5ec5b1919c42390057d90f22","createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","5ec5b1919c42390057d90f2e","5ec5b1919c42390057d90f2f","5ec5b1919c42390057d90f30","5ec5b1919c42390057d90f31","5ec5b1919c42390057d90f32","5ec5b1919c42390057d90f33","5ec5b1919c42390057d90f34","5ec5b1919c42390057d90f35","5ec5b1919c42390057d90f36","5ec5b1919c42390057d90f37","58599813cf9e112d0032cdab","6376be1b127d99000315a404"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"subdomain":"api-opensrs-email-hub2","subpath":"","superHubWaitlist":false,"topnav":{"left":[{"type":"docs","text":"Guides"}],"right":[{"type":"user","text":"User","url":"/login?redirect_uri=/"}],"edited":true,"bottom":[]},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2024-05-22T15:30:19.474Z"},"translate":{"key_public":"","languages":[],"org_name":"","project_name":"","provider":"transifex","show_widget":false},"url":"","versions":[{"_id":"5ec5b1919c42390057d90f22","is_hidden":false,"project":"5ec5b1919c42390057d90fce","categories":["569f9cf7650e1d1900f96b5f","5ec5b1919c42390057d90f24","5ec5b1919c42390057d90f25","5ec5b1919c42390057d90f26","5ec5b1919c42390057d90f27","5ec5b1919c42390057d90f28","5ec5b1919c42390057d90f29","5ec5b1919c42390057d90f2a","5ec5b1919c42390057d90f2b","5ec5b1919c42390057d90f2c","5ec5b1919c42390057d90f2d","58599813cf9e112d0032cdab","6376be1b127d99000315a405"],"codename":"","is_beta":false,"is_deprecated":false,"version_clean":"1.0.0","__v":12,"createdAt":"2016-01-20T14:43:02.785Z","is_stable":false,"releaseDate":"2016-01-20T14:43:02.785Z","version":"1.0"},{"_id":"5ec5b1919c42390057d90f23","project":"5ec5b1919c42390057d90fce","__v":0,"forked_from":"5ec5b1919c42390057d90f22","createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","5ec5b1919c42390057d90f2e","5ec5b1919c42390057d90f2f","5ec5b1919c42390057d90f30","5ec5b1919c42390057d90f31","5ec5b1919c42390057d90f32","5ec5b1919c42390057d90f33","5ec5b1919c42390057d90f34","5ec5b1919c42390057d90f35","5ec5b1919c42390057d90f36","5ec5b1919c42390057d90f37","58599813cf9e112d0032cdab","6376be1b127d99000315a404"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"}],"variableDefaults":[],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[],"canonical_url":null,"description":null,"parent":null,"homepage_url":null,"id":"5ec5b1919c42390057d90fce","is_migrated":false,"name":"API OpenSRS Email","redirects":[],"sitemap":"disabled","subdomain":"api-opensrs-email-hub2","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":false,"appearance":false,"documentation":true,"domain":false,"jwt":false,"logs":false,"metricsSDK":false},"pages":{"not_found":null},"privacy":{"view":"public","password":null},"reference":{"api_sdk_snippets":"enabled","defaults":"always_use","json_editor":"disabled","oauth_flows":"disabled","request_history":"enabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"startup2018","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2024-05-22T15:30:19.474Z"}},"health_check":{"provider":"none","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":null}}},"integrations":{"bing":{"verify":null},"google":{"analytics":null,"site_verification":null},"heap":{"id":null},"koala":{"key":null},"localize":{"key":null},"recaptcha":{"site_key":null,"secret_key":null},"segment":{"key":null,"domain":null},"typekit":{"key":null},"zendesk":{"subdomain":null},"intercom":{"app_id":null,"secure_mode":{"key":null,"email_only":false}}},"permissions":{"appearance":{"private_label":"disabled","custom_code":{"css":"disabled","html":"disabled","js":"disabled"}}},"appearance":{"brand":{"primary_color":"#076AFB","link_color":"#076AFB","theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"show"},"logo":{"size":"default","dark_mode":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}},"main":{"uri":null,"url":"https://files.readme.io/fd0f1b4-small-OpenSRS_knowledgebase_1.png","name":"OpenSRS knowledgebase (1).png","width":221,"height":64,"color":"#c6eff5","links":{"original_url":"https://files.readme.io/b4e3c2a-OpenSRS_knowledgebase_1.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/49bce28-Favicon_regular.svg","name":"Favicon_regular.svg","width":32,"height":32,"color":"#04034a","links":{"original_url":null}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"line","gradient_color":null,"overlay":{"fill":"auto","type":"triangles","position":"top-left","image":{"uri":null,"url":null,"name":null,"width":null,"height":null,"color":null,"links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"guides","title":null,"url":null,"custom_page":null}],"logo_link":"landing_page","right":[{"type":"user_controls","title":null,"url":null,"custom_page":null}],"sub_nav":[],"subheader_layout":"dropdown","version":"enabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":null,"visibility":"disabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"enabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"enabled"}}}}}},"version":{"_id":"5ec5b1919c42390057d90f23","project":"5ec5b1919c42390057d90fce","__v":0,"forked_from":"5ec5b1919c42390057d90f22","createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","5ec5b1919c42390057d90f2e","5ec5b1919c42390057d90f2f","5ec5b1919c42390057d90f30","5ec5b1919c42390057d90f31","5ec5b1919c42390057d90f32","5ec5b1919c42390057d90f33","5ec5b1919c42390057d90f34","5ec5b1919c42390057d90f35","5ec5b1919c42390057d90f36","5ec5b1919c42390057d90f37","58599813cf9e112d0032cdab","6376be1b127d99000315a404"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"}},"reqUrl":"/","version":{"_id":"5ec5b1919c42390057d90f23","project":"5ec5b1919c42390057d90fce","__v":0,"forked_from":"5ec5b1919c42390057d90f22","createdAt":"2016-01-20T14:43:02.785Z","releaseDate":"2016-01-20T14:43:02.785Z","categories":["569f9cf7650e1d1900f96b5f","5ec5b1919c42390057d90f2e","5ec5b1919c42390057d90f2f","5ec5b1919c42390057d90f30","5ec5b1919c42390057d90f31","5ec5b1919c42390057d90f32","5ec5b1919c42390057d90f33","5ec5b1919c42390057d90f34","5ec5b1919c42390057d90f35","5ec5b1919c42390057d90f36","5ec5b1919c42390057d90f37","58599813cf9e112d0032cdab","6376be1b127d99000315a404"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.1.0","version":"1.1"},"lang":"en","langFull":"Default","isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,4935,7971,6722,153,1313,5798,6841,1936,1666,6922,2859,1343,6060,4002,3787,1202,5408,2637,2402,8063,2144,9141,9575,1080,9852,8684,3221,7327,7285,3307,1948,2578,3859,4467,4674,1731,2616,3412]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Reference","Footer","routes-Doc","routes-PageNotFound","CustomPage","core-icons-more-vertical-svg","core-icons-lock-svg","routes-Landing","core-icons-alert-circle-svg","routes-Discuss","Page","core-icons-arrow-up-right-svg","routes-Changelog","Post","core-icons-arrow-right-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","core-icons-eye-off-svg","core-icons-chevron-down-svg","routes-CustomPage","routes-Tutorials","List","core-icons-trending-up-svg","core-icons-callout-info-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.js"></script> <script async data-chunk="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/6922.e8247ef6931a72e55b3e.js"></script> <script async data-chunk="CustomPage" src="https://cdn.readme.io/public/hub/web/2859.94b03b9a9585460aa921.js"></script> <script async data-chunk="core-icons-more-vertical-svg" src="https://cdn.readme.io/public/hub/web/core-icons-more-vertical-svg.4822b3f831e11095980d.js"></script> <script async data-chunk="core-icons-lock-svg" src="https://cdn.readme.io/public/hub/web/core-icons-lock-svg.70942d3ee6bad6267696.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"></script> <script async data-chunk="core-icons-alert-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-alert-circle-svg.4cee8264c97045599b56.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.js"></script> <script async data-chunk="core-icons-arrow-up-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-up-right-svg.8ec73f7e322d79a2695b.js"></script> <script async data-chunk="routes-Changelog" src="https://cdn.readme.io/public/hub/web/routes-Changelog.3f125a62ed05cc53aec4.js"></script> <script async data-chunk="Post" src="https://cdn.readme.io/public/hub/web/Post.cced33af5051de7f473f.js"></script> <script async data-chunk="core-icons-arrow-right-svg" src="https://cdn.readme.io/public/hub/web/core-icons-arrow-right-svg.eadb74658f93b4e7d75f.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/Editor.002979730c36f9c65ad3.js"></script> <script async data-chunk="core-icons-x-circle-svg" src="https://cdn.readme.io/public/hub/web/core-icons-x-circle-svg.abc0e0ea5b7f9dff667c.js"></script> <script async data-chunk="core-icons-suggested-edits-svg" src="https://cdn.readme.io/public/hub/web/core-icons-suggested-edits-svg.8d2d8ac2fd22ded9238d.js"></script> <script async data-chunk="core-icons-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script> <script async data-chunk="core-icons-chevron-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-down-svg.e20b84e9871bd73d1b8c.js"></script> <script async data-chunk="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/4674.13378da16ce7b5beba66.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/List.12cee315afa198c8e23e.js"></script> <script async data-chunk="core-icons-trending-up-svg" src="https://cdn.readme.io/public/hub/web/core-icons-trending-up-svg.0dd920b0698e57f75afa.js"></script> <script async data-chunk="core-icons-callout-info-svg" src="https://cdn.readme.io/public/hub/web/core-icons-callout-info-svg.79b14e8568c9cecbc827.js"></script></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"MzViMjIyMWFmMmQ5ZjExOWI0ZTEwNDk2NmYyNWY5MWFhZmM2ZDQ2MDRjZDdkY2E4MGNjZmI3ZDA1MWQ2NTJjOXRhZ0ZpbHRlcnM9KHByb2plY3Q6NWVjNWIxOTE5YzQyMzkwMDU3ZDkwZmNlKSwodmVyc2lvbjpub25lLHZlcnNpb246NWVjNWIxOTE5YzQyMzkwMDU3ZDkwZjIzKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6RGlzY3Vzcyk=","filters":"tagFilters=(project:5ec5b1919c42390057d90fce),(version:none,version:5ec5b1919c42390057d90f23),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog,index:Discuss)","metaData":[{"modules":{"landing":true,"docs":true,"examples":true,"reference":false,"blog":true,"changelog":true,"discuss":true,"suggested_edits":true,"custompages":false,"logs":false,"tutorials":false,"graphql":false},"id":"5ec5b1919c42390057d90fce","name":"API OpenSRS Email","subdomain":"api-opensrs-email-hub2","subpath":"","nav_names":{"docs":"","reference":"","blog":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>