CINXE.COM
Getting started with the Influence.io Platform API
<!DOCTYPE html><html lang="en" style="" data-color-mode="system" 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="influenceio"><meta name="readme-version" content="1.0"><title>Getting started with the Influence.io Platform API</title><meta name="description" content="A brief overview of what is needed for running Influence.io using our Platform API"><meta property="og:title" content="Getting started with the Influence.io Platform API"><meta property="og:description" content="A brief overview of what is needed for running Influence.io using our Platform API"><meta property="og:site_name" content="Influence.io"><meta name="twitter:title" content="Getting started with the Influence.io Platform API"><meta name="twitter:description" content="A brief overview of what is needed for running Influence.io using our Platform API"><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/9a0cd33-small-influenceio-icon-white-bg-square.png"><meta name="twitter:image" content="https://files.readme.io/9a0cd33-small-influenceio-icon-white-bg-square.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/c0e709b-small-influenceio-favicon.png" type="image/png"><link rel="canonical" href="https://developer.influence.io/docs/getting-started-with-the-influenceio-platform-api"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><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="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.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-Changelog" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.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="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.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-Landing" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.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="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="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.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-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.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/6722.e485c5aa155bd0f0ccf8.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-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/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="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="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="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="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="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-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="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="List" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.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-star-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.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="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-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.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-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="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-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#7034e4;--project-color-inverse:#fff;--recipe-button-color:#0048dc;--recipe-button-color-hover:#002776;--recipe-button-color-active:#001643;--recipe-button-color-focus:rgba(0, 72, 220, 0.25);--recipe-button-color-disabled:#a9c5ff}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#7034e4;--project-color-inverse:#fff}a{color:var(--color-link-primary,#0048dc)}a:hover{color:var(--color-link-primary-darken-5,#002776)}a.text-muted:hover{color:var(--color-link-primary,#0048dc)}.btn.btn-primary{background-color:#0048dc}.btn.btn-primary:hover{background-color:#002776}.theme-line #hub-landing-top h2{color:#0048dc}#hub-landing-top .btn:hover{color:#0048dc}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#7034e4}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#7034e4,#4809c3)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(undefined)}.theme-line header#hub-header #header-top{border-bottom-color:#7034e4}.theme-line header#hub-header #header-top .btn{background-color:#7034e4}header#hub-header #header-top #header-logo{width:179px;height:40px;margin-top:0;background-image:url(https://files.readme.io/c0a292a-small-influenceio-logo--inverted3x.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#7034e4}#subheader-links a.active{color:#7034e4!important;box-shadow:inset 0 -2px 0 #7034e4}#subheader-links a:hover{color:#7034e4!important;box-shadow:inset 0 -2px 0 #7034e4;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#0048dc}section#hub-discuss .discussion a .discuss-body h4{color:#0048dc}section#hub-discuss .discussion a:hover .discuss-body h4{color:#002776}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#0048dc}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#0048dc}#hub-search-results h3 em{color:#0048dc}.main_background,.tag-item{background:#0048dc!important}.main_background:hover{background:#002776!important}.main_color{color:#7034e4!important}.border_bottom_main_color{border-bottom:2px solid #7034e4}.main_color_hover:hover{color:#7034e4!important}section#hub-discuss h1{color:#0048dc}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#0048dc;background-color:#0048dc}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#002776;border-color:#002776}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#0048dc;color:#0048dc}#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,#0048dc);border-color:var(--project-color-primary,#0048dc)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#002776;border-color:#002776}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#0048dc;fill:var(--project-color-primary,#0048dc)}#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:#0048dc}.main-color-accent{border-bottom:3px solid #7034e4;padding-bottom:8px}</style><meta name="loadedProject" content="influenceio"><script>var storedColorMode = `system` === 'system' ? window.localStorage.getItem('color-scheme') : `system` 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-solid header-solid header-bg-size-auto header-bg-pos-tl header-overlay-triangles reference-layout-row lumosity-normal "><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#7034e4;--color-primary-inverse:#fff;--color-primary-alt:#4809c3;--color-primary-darken-10:#571bca;--color-primary-darken-20:#43159d;--color-primary-alpha-25:rgba(112, 52, 228, 0.25);--color-link-primary:#0048dc;--color-link-primary-darken-5:#0040c2;--color-link-primary-darken-10:#0037a9;--color-link-primary-darken-20:#002776;--color-link-primary-alpha-50:rgba(0, 72, 220, 0.5);--color-link-primary-alpha-25:rgba(0, 72, 220, 0.25);--color-link-background:rgba(0, 72, 220, 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="Influence.io" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/c0a292a-small-influenceio-logo--inverted3x.png"/></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 class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/" target="_self"><i class="icon-landing-page-2 NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Home</span></a><a aria-current="page" class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- active" 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="/reference" target="_self"><i class="icon-references NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">API Reference</span></a><div class="NavItem-item1gDDTqaXGhm1 NavItem-item_inactiveMQoyhN045qAn">v<!-- -->1.0</div><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://dashboard.influence.io" rel="noopener" target="_blank" to="https://dashboard.influence.io">Dashboard</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="/" target="_self"><img alt="Influence.io" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/c0a292a-small-influenceio-logo--inverted3x.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="icon-guides Header-left-nav-icon10glJKFwewOv"></i>Guides</div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://dashboard.influence.io" target="_self" to="https://dashboard.influence.io">Dashboard</a></span><div class="ThemeToggle-wrapper1M_iJESXCpGR Dropdown Dropdown_closed"><button aria-label="Toggle to light mode" id="ThemeToggle-button-static-id-placeholder" aria-haspopup="dialog" class="Button Button_slate_text Button_sm rm-ThemeToggle ThemeToggle2tVPbUyQbWDo Dropdown-toggle Button_primary" type="button"><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv " role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Moon (Dark Mode)</title><path d="M19 14.79C18.8427 16.4922 18.2039 18.1144 17.1582 19.4668C16.1126 20.8192 14.7035 21.8458 13.0957 22.4265C11.4879 23.0073 9.74798 23.1181 8.0795 22.7461C6.41102 22.3741 4.88299 21.5345 3.67423 20.3258C2.46546 19.117 1.62594 17.589 1.25391 15.9205C0.881876 14.252 0.992717 12.5121 1.57346 10.9043C2.1542 9.29651 3.18083 7.88737 4.53321 6.84175C5.8856 5.79614 7.5078 5.15731 9.21 5C8.21341 6.34827 7.73385 8.00945 7.85853 9.68141C7.98322 11.3534 8.70386 12.9251 9.8894 14.1106C11.0749 15.2961 12.6466 16.0168 14.3186 16.1415C15.9906 16.2662 17.6517 15.7866 19 14.79Z"></path><path class="ThemeToggle-Icon-star3wweJby1gM4w" d="M18.3707 1C18.3707 3.22825 16.2282 5.37069 14 5.37069C16.2282 5.37069 18.3707 7.51313 18.3707 9.74138C18.3707 7.51313 20.5132 5.37069 22.7414 5.37069C20.5132 5.37069 18.3707 3.22825 18.3707 1Z"></path></svg><svg aria-labelledby="ThemeToggle-button-static-id-placeholder" class="Icon ThemeToggle-Icon3g9ZT7pRMwCv ThemeToggle-Icon_active18I2-19CkbgD" role="img" viewBox="0 0 24 24" xmlns="http://www.w3.org/2000/svg"><title>Sun (Light Mode)</title><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 1V3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 5.64L19.78 4.22"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M21 12H23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M18.36 18.36L19.78 19.78"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M12 21V23"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 19.78L5.64 18.36"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M1 12H3"></path><path class="ThemeToggle-Icon-ray2ab8_BwBkrTx" d="M4.22 4.22L5.64 5.64"></path><path d="M12 17C14.7614 17 17 14.7614 17 12C17 9.23858 14.7614 7 12 7C9.23858 7 7 9.23858 7 12C7 14.7614 9.23858 17 12 17Z"></path></svg></button></div><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><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><span class="undefined NavItem_inactive1YE6SGanIJp5 rm-Header-bottom-link">v<!-- -->1.0</span><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/" target="_self"><i class="icon-landing-page-2"></i><span>Home</span></a><a aria-current="page" class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile active" href="/docs" target="_self"><i class="icon-guides"></i><span>Guides</span></a><a class="Button Button_md rm-Header-link rm-Header-bottom-link Button_slate_text Header-bottom-link_mobile " href="/reference" target="_self"><i class="icon-references"></i><span>API Reference</span></a></nav><button align="center" justify="between" style="--flex-gap:var(--xs)" class="Button Button_sm Flex Flex_row MobileSubnav1DsTfasXloM2 Button_contrast Button_contrast_outline" type="button"><span class="Button-label">Getting started with the Influence.io Platform API</span><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a" data-name="chevron-up-down" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="m6 16 6 6 6-6M18 8l-6-6-6 6" class="icon-stroke-width"></path></svg></span></button><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="rm-Guides"><div class="rm-Container rm-Container_flex"><nav aria-label="Page navigation" class="rm-Sidebar hub-sidebar reference-redesign Nav3C5f8FcjkaHj rm-Sidebar_guides" id="hub-sidebar"><div class="Sidebar1t2G1ZJq-vU1 rm-Sidebar hub-sidebar-content"><section class="Sidebar-listWrapper6Q9_yUrG906C rm-Sidebar-section"><h2 class="Sidebar-headingTRQyOa2pk0gh rm-Sidebar-heading">Getting started</h2><ul class="Sidebar-list3cZWQLaBf9k8 rm-Sidebar-list"><li class="Sidebar-item23D-2Kd61_k3"><a aria-current="page" class="Sidebar-link2Dsha-r-GKh2 childless text-wrap rm-Sidebar-link active" target="_self" href="/docs/getting-started-with-the-influenceio-platform-api"><span class="Sidebar-link-textLuTE1ySm4Kqn"><span class="Sidebar-link-text_label1gCT_uPnx7Gu">Getting started with the Influence.io Platform API</span></span></a></li></ul></section><div class="readme-logo" id="readmeLogo">Powered by <a aria-label="ReadMe" href="https://readme.com?ref_src=hub&project=influenceio" style="color:unset"><i class="icon icon-readme" style="display:inline-block;min-width:71px"></i></a></div></div></nav><article class="rm-Article " id="content"><header id="content-head"><div class="row clearfix"><div class="col-xs-9"><h1>Getting started with the Influence.io Platform API</h1><div class="excerpt"><div class="rm-Markdown markdown-body" data-testid="RDMD"><p>A brief overview of what is needed for running Influence.io using our Platform API</p></div></div></div><div class="col-xs-3"><a class="suggestEdits" rel="nofollow" href="/edit/getting-started-with-the-influenceio-platform-api"><i aria-hidden="true" class="icon icon-edit"></i> Suggest Edits</a></div></div></header><div class="grid-container-fluid" id="content-container"><section class="content-body grid-75"><div dehydrated="<h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-introduction"></div><div class="heading-text"><div id="section-👩🏫-introduction" class="heading-anchor_backwardsCompatibility"></div>👩🏫 Introduction</div><a aria-label="Skip link to 👩🏫 Introduction" class="heading-anchor-icon fa fa-anchor" href="#-introduction"></a></h2> <p>Our API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>There are three main considerations for setting up the platform via our API:</p></h2><ol> <li>Importing your customers</li> <li>The processing of Customer, Order, and Product data</li> <li>The handling of our webhooks</li> </ol></blockquote> <p>You can see the documentation for the Platform API here: <a href="https://developer.influence.io/reference/platform-api-introduction" target="" title="">Platform API documentation</a></p> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="♂️-importing-your-customers"></div><div class="heading-text"><div id="section-🙎♂️-importing-your-customers" class="heading-anchor_backwardsCompatibility"></div>🙎♂️ Importing your customers</div><a aria-label="Skip link to 🙎♂️ Importing your customers" class="heading-anchor-icon fa fa-anchor" href="#♂️-importing-your-customers"></a></h2> <p>The first step for integrating with influence.io will be to ensure your customers have been properly imported into the platform. </p> <blockquote class="callout callout_okay" theme="👍"><h2 class="callout-heading"><span class="callout-icon">👍</span><p>We have a customer PUT endpoint for creating and updating customer records: <a href="https://developer.influence.io/reference/put_v1-customers-customerid" target="" title="">PUT Customers</a></p></h2><p>Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.</p></blockquote> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-processing-of-customer-order-and-product-data"></div><div class="heading-text"><div id="section-📊-processing-of-customer-order-and-product-data" class="heading-anchor_backwardsCompatibility"></div>📊 Processing of Customer, Order, and Product data</div><a aria-label="Skip link to 📊 Processing of Customer, Order, and Product data" class="heading-anchor-icon fa fa-anchor" href="#-processing-of-customer-order-and-product-data"></a></h2> <p>We’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="♀️-updating-customer-data"></div><div class="heading-text"><div id="section-🙍♀️-updating-customer-data" class="heading-anchor_backwardsCompatibility"></div>🙍♀️ Updating Customer Data</div><a aria-label="Skip link to 🙍♀️ Updating Customer Data" class="heading-anchor-icon fa fa-anchor" href="#♀️-updating-customer-data"></a></h3> <ul> <li>You will need to hit the above endpoint with new/updated customers: <a href="https://developer.influence.io/reference/put_v1-customers-customerid" target="" title="">PUT Customers</a></li> </ul> <p>This needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="🛒-managing-orders"></div><div class="heading-text"><div id="section-🛒-managing-orders" class="heading-anchor_backwardsCompatibility"></div>🛒 Managing Orders</div><a aria-label="Skip link to 🛒 Managing Orders" class="heading-anchor-icon fa fa-anchor" href="#🛒-managing-orders"></a></h3> <ul> <li>One of the most important endpoints for you to handle is the Order endpoint: <a href="https://developer.influence.io/reference/post_v1-orders" target="" title="">POST Orders</a></li> </ul> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>Sending us order details is crucial to ensuring that your customers are being awarded points.</p></h2><p>We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.</p></blockquote> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="️-managing-products"></div><div class="heading-text"><div id="section-🛍️-managing-products" class="heading-anchor_backwardsCompatibility"></div>🛍️ Managing Products</div><a aria-label="Skip link to 🛍️ Managing Products" class="heading-anchor-icon fa fa-anchor" href="#️-managing-products"></a></h3> <ul> <li>One of the less important endpoints is for Products: <a href="https://developer.influence.io/reference/put_v1-products-productid" target="" title="">PUT Products</a></li> </ul> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.</p></h2><p>The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.</p></blockquote> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="️-handling-our-webhooks"></div><div class="heading-text"><div id="section-⚙️-handling-our-webhooks" class="heading-anchor_backwardsCompatibility"></div>⚙️ Handling our webhooks</div><a aria-label="Skip link to ⚙️ Handling our webhooks" class="heading-anchor-icon fa fa-anchor" href="#️-handling-our-webhooks"></a></h2> <p>Whenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.</p> <p>You can see the documentation for these webhooks here: <a href="https://developer.influence.io/reference/introduction-to-webhooks" target="" title="">Webhook Documentation</a></p> <blockquote class="callout callout_error" theme="❗️"><h2 class="callout-heading"><span class="callout-icon">❗️</span><p>The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.</p></h2><p>This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.</p></blockquote> <p>To re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.</p>" style="margin-left:31px" class="rm-Markdown markdown-body rm-Markdown markdown-body ng-non-bindable" data-testid="RDMD"><h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-introduction"></div><div class="heading-text"><div id="section-👩🏫-introduction" class="heading-anchor_backwardsCompatibility"></div>👩🏫 Introduction</div><a aria-label="Skip link to 👩🏫 Introduction" class="heading-anchor-icon fa fa-anchor" href="#-introduction"></a></h2> <p>Our API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.</p> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>There are three main considerations for setting up the platform via our API:</p></h2><ol> <li>Importing your customers</li> <li>The processing of Customer, Order, and Product data</li> <li>The handling of our webhooks</li> </ol></blockquote> <p>You can see the documentation for the Platform API here: <a target="_self" href="/reference/platform-api-introduction">Platform API documentation</a></p> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="♂️-importing-your-customers"></div><div class="heading-text"><div id="section-🙎♂️-importing-your-customers" class="heading-anchor_backwardsCompatibility"></div>🙎♂️ Importing your customers</div><a aria-label="Skip link to 🙎♂️ Importing your customers" class="heading-anchor-icon fa fa-anchor" href="#♂️-importing-your-customers"></a></h2> <p>The first step for integrating with influence.io will be to ensure your customers have been properly imported into the platform. </p> <blockquote class="callout callout_okay" theme="👍"><h2 class="callout-heading"><span class="callout-icon">👍</span><p>We have a customer PUT endpoint for creating and updating customer records: <a target="_self" href="/reference/put_v1-customers-customerid">PUT Customers</a></p></h2><p>Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.</p></blockquote> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="-processing-of-customer-order-and-product-data"></div><div class="heading-text"><div id="section-📊-processing-of-customer-order-and-product-data" class="heading-anchor_backwardsCompatibility"></div>📊 Processing of Customer, Order, and Product data</div><a aria-label="Skip link to 📊 Processing of Customer, Order, and Product data" class="heading-anchor-icon fa fa-anchor" href="#-processing-of-customer-order-and-product-data"></a></h2> <p>We’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="♀️-updating-customer-data"></div><div class="heading-text"><div id="section-🙍♀️-updating-customer-data" class="heading-anchor_backwardsCompatibility"></div>🙍♀️ Updating Customer Data</div><a aria-label="Skip link to 🙍♀️ Updating Customer Data" class="heading-anchor-icon fa fa-anchor" href="#♀️-updating-customer-data"></a></h3> <ul> <li>You will need to hit the above endpoint with new/updated customers: <a target="_self" href="/reference/put_v1-customers-customerid">PUT Customers</a></li> </ul> <p>This needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.</p> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="🛒-managing-orders"></div><div class="heading-text"><div id="section-🛒-managing-orders" class="heading-anchor_backwardsCompatibility"></div>🛒 Managing Orders</div><a aria-label="Skip link to 🛒 Managing Orders" class="heading-anchor-icon fa fa-anchor" href="#🛒-managing-orders"></a></h3> <ul> <li>One of the most important endpoints for you to handle is the Order endpoint: <a target="_self" href="/reference/post_v1-orders">POST Orders</a></li> </ul> <blockquote class="callout callout_warn" theme="🚧"><h2 class="callout-heading"><span class="callout-icon">🚧</span><p>Sending us order details is crucial to ensuring that your customers are being awarded points.</p></h2><p>We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.</p></blockquote> <h3 class="heading heading-3 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="️-managing-products"></div><div class="heading-text"><div id="section-🛍️-managing-products" class="heading-anchor_backwardsCompatibility"></div>🛍️ Managing Products</div><a aria-label="Skip link to 🛍️ Managing Products" class="heading-anchor-icon fa fa-anchor" href="#️-managing-products"></a></h3> <ul> <li>One of the less important endpoints is for Products: <a target="_self" href="/reference/put_v1-products-productid">PUT Products</a></li> </ul> <blockquote class="callout callout_info" theme="📘"><h2 class="callout-heading"><span class="callout-icon">📘</span><p>There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.</p></h2><p>The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.</p></blockquote> <hr/> <h2 class="heading heading-2 header-scroll" align=""><div class="heading-anchor anchor waypoint" id="️-handling-our-webhooks"></div><div class="heading-text"><div id="section-⚙️-handling-our-webhooks" class="heading-anchor_backwardsCompatibility"></div>⚙️ Handling our webhooks</div><a aria-label="Skip link to ⚙️ Handling our webhooks" class="heading-anchor-icon fa fa-anchor" href="#️-handling-our-webhooks"></a></h2> <p>Whenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.</p> <p>You can see the documentation for these webhooks here: <a target="_self" href="/reference/introduction-to-webhooks">Webhook Documentation</a></p> <blockquote class="callout callout_error" theme="❗️"><h2 class="callout-heading"><span class="callout-icon">❗️</span><p>The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.</p></h2><p>This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.</p></blockquote> <p>To re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.</p></div><div class="UpdatedAt"><p class="DateLine "><i class="icon icon-watch"></i>Updated<!-- --> <!-- -->over 1 year ago<!-- --> </p></div><hr class="NextStepsDivider"/><div class="WhatsNext-wrapper3DTnpcPqKoHg"><header class="APISectionHeader3LN_-QIR0m7x rm-APISectionHeader WhatsNext-headingQHN33r4trf_s"><div class="APISectionHeader-heading4MUMLbp4_nLs">What’s Next</div></header><div class="rm-Markdown markdown-body WhatsNext-description1zZyZLPCGmaa" data-testid="RDMD"><p>Platform API & Webhook documentation</p></div><ul><li><a class="WhatsNext-link" target="_self" href="/reference/platform-api-introduction">Platform API Reference</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li><li><a class="WhatsNext-link" target="_self" href="/reference/webhook">webhook</a><span class="IconWrapper Icon-wrapper2z2wVIeGsiUy"><svg fill="none" viewBox="0 0 24 24" class="Icon Icon3_D2ysxFZ_ll Icon-svg2Lm7f6G9Ly5a icon" data-name="arrow-right" role="img" style="--icon-color:inherit;--icon-size:inherit;--icon-stroke-width:2px"><path stroke="currentColor" stroke-linecap="round" stroke-linejoin="round" d="M5 12h14M12 5l7 7-7 7" class="icon-stroke-width"></path></svg></span></li></ul></div></section><section class="content-toc grid-25"><nav><ul class="toc-list"><li><a class="tocHeader" href="#"><i class="icon icon-text-align-left"></i>Table of Contents</a></li><li class="toc-children"><ul> <li> <a href="#-introduction">👩🏫 Introduction</a> </li> <li> <a href="#%E2%99%82%EF%B8%8F-importing-your-customers">🙎♂️ Importing your customers</a> </li> <li> <a href="#-processing-of-customer-order-and-product-data">📊 Processing of Customer, Order, and Product data</a> <ul> <li><a href="#%E2%99%80%EF%B8%8F-updating-customer-data">🙍♀️ Updating Customer Data</a></li> <li><a href="#%F0%9F%9B%92-managing-orders">🛒 Managing Orders</a></li> <li><a href="#%EF%B8%8F-managing-products">🛍️ Managing Products</a></li> </ul> </li> <li> <a href="#%EF%B8%8F-handling-our-webhooks">⚙️ Handling our webhooks</a> </li> </ul></li></ul></nav></section></div><div class="ModalWrapper" id="tutorialmodal-root"></div></article></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":"632c5ef4e2eea4096d97e68e","title":"Getting started","slug":"documentation","order":9999,"reference":false,"version":"632c5ef4e2eea4096d97e68c","project":"632c5ef4e2eea4096d97e687","createdAt":"2022-09-22T13:11:16.438Z","__v":0,"pages":[{"_id":"63ca9ced81694f00950d917a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Getting started with the Influence.io Platform API","icon":"","type":"basic","slug":"getting-started-with-the-influenceio-platform-api","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"632c5ef4e2eea4096d97e68e","createdAt":"2023-01-20T13:53:49.102Z","isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"632c5f3d2c4b5b0d3601da37","title":"Influence.io Platform API","slug":"influenceio-platform-api-1","order":9999,"reference":true,"project":"632c5ef4e2eea4096d97e687","version":"632c5ef4e2eea4096d97e68c","createdAt":"2022-09-22T13:12:29.361Z","__v":0,"pages":[{"_id":"632c67a7a79da30afa4e0c22","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Platform API Reference","icon":"","type":"basic","slug":"platform-api-introduction","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction","createdAt":"2022-09-22T13:48:23.854Z","category":"632c5f3d2c4b5b0d3601da37","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"6633760d4989ae002b3f1c82","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"collection","icon":"","type":"basic","slug":"collection","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__collection","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.596Z","isBodyEmpty":true,"children":[{"_id":"6633760d4989ae002b3f1c84","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Retrieve a collection","icon":"","type":"endpoint","slug":"get_v1-collections-collectionid","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-collections-collectionid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.686Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]},{"_id":"6633760d4989ae002b3f1c85","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update or create a collection","icon":"","type":"endpoint","slug":"put_v1-collections-collectionid","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-collections-collectionid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.687Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]},{"_id":"6633760d4989ae002b3f1c86","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Delete a collection","icon":"","type":"endpoint","slug":"delete_v1-collections-collectionid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v1-collections-collectionid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.687Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]},{"_id":"666706cb6a95df0030918ecd","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Get products in a collection","icon":"","type":"endpoint","slug":"get_v1-collections-collectionid-products","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-collections-collectionid-products","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-06-10T13:59:39.236Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]},{"_id":"6633760d4989ae002b3f1c87","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Add a product to a collection","icon":"","type":"endpoint","slug":"post_v1-collections-collectionid-products","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-collections-collectionid-products","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.688Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]},{"_id":"6633760d4989ae002b3f1c88","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Remove a product from a collection","icon":"","type":"endpoint","slug":"delete_v1-collections-collectionid-products-productid","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v1-collections-collectionid-products-productid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.688Z","parentDoc":"6633760d4989ae002b3f1c82","isBodyEmpty":true,"children":[]}]},{"_id":"632c5f3f2c4b5b0d3601da3a","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"customer","icon":"","type":"basic","slug":"customer","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__customer","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.170Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"670fbf4ec50a20006de05610","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Retrieve a list of customers","icon":"","type":"endpoint","slug":"get_v1-customers","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customers","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-10-16T13:27:42.540Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"636a430a1093930b6014ee5d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Retrieve a customer","icon":"","type":"endpoint","slug":"get_v1-customers-customerid","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customers-customerid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-11-08T11:52:42.970Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"636a430a1093930b6014ee5e","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update or create a customer","icon":"","type":"endpoint","slug":"put_v1-customers-customerid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-customers-customerid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-11-08T11:52:42.972Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"636a430a1093930b6014ee5f","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update a customer's birthday","icon":"","type":"endpoint","slug":"put_v1-customers-customerid-birthday","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-customers-customerid-birthday","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-11-08T11:52:42.973Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"64246ee96b2542003cc2b6bd","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Award points to a customer.","icon":"","type":"endpoint","slug":"post_v1-customers-customerid-points","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customers-customerid-points","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2023-03-29T17:01:29.594Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"636a430a1093930b6014ee61","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Deduct points from a customer","icon":"","type":"endpoint","slug":"post_v1-customers-customerid-points-remove","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customers-customerid-points-remove","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-11-08T11:52:42.975Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]},{"_id":"66c44b12f111d3005bce3b44","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Award a stamp card stamp to a customer","icon":"","type":"endpoint","slug":"post_v1-customers-customerid-stamp","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customers-customerid-stamp","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-08-20T07:51:46.676Z","parentDoc":"632c5f3f2c4b5b0d3601da3a","isBodyEmpty":true,"children":[]}]},{"_id":"632c5f3f2c4b5b0d3601da3b","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"order","icon":"","type":"basic","slug":"order","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__order","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.172Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"643527f6cf50480b652415d2","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Create an order","icon":"","type":"endpoint","slug":"post_v1-orders","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-orders","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2023-04-11T09:27:18.064Z","parentDoc":"632c5f3f2c4b5b0d3601da3b","isBodyEmpty":true,"children":[]},{"_id":"643527f6cf50480b652415d3","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update an order","icon":"","type":"endpoint","slug":"patch_v1-orders-orderid","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v1-orders-orderid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2023-04-11T09:27:18.065Z","parentDoc":"632c5f3f2c4b5b0d3601da3b","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da4e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Get an order","icon":"","type":"endpoint","slug":"get_v1-orders-orderid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-orders-orderid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.256Z","parentDoc":"632c5f3f2c4b5b0d3601da3b","isBodyEmpty":true,"children":[]}]},{"_id":"632c5f3f2c4b5b0d3601da3c","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"product","icon":"","type":"basic","slug":"product","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__product","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.172Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"632c5f3f2c4b5b0d3601da4f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Get a product","icon":"","type":"endpoint","slug":"get_v1-products-productid","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-products-productid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.257Z","parentDoc":"632c5f3f2c4b5b0d3601da3c","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da50","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update or create a product","icon":"","type":"endpoint","slug":"put_v1-products-productid","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-products-productid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.257Z","parentDoc":"632c5f3f2c4b5b0d3601da3c","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da51","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Delete a product","icon":"","type":"endpoint","slug":"delete_v1-products-productid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v1-products-productid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.258Z","parentDoc":"632c5f3f2c4b5b0d3601da3c","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da52","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Updates or creates a list or product variants","icon":"","type":"endpoint","slug":"post_v1-products-productid-variants","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-products-productid-variants","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.258Z","parentDoc":"632c5f3f2c4b5b0d3601da3c","isBodyEmpty":true,"children":[]},{"_id":"6633760d4989ae002b3f1c89","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Get collections of a product","icon":"","type":"endpoint","slug":"get_v1-products-productid-collections","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-products-productid-collections","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-05-02T11:16:29.692Z","parentDoc":"632c5f3f2c4b5b0d3601da3c","isBodyEmpty":true,"children":[]}]},{"_id":"666706cb6a95df0030918ecb","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"reward","icon":"","type":"basic","slug":"reward","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__reward","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-06-10T13:59:39.047Z","isBodyEmpty":true,"children":[{"_id":"666706cb6a95df0030918ece","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Marks reward as used within Influence.io","icon":"","type":"endpoint","slug":"post_v1-rewards-couponcode-use","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-rewards-couponcode-use","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2024-06-10T13:59:39.242Z","parentDoc":"666706cb6a95df0030918ecb","isBodyEmpty":true,"children":[]}]},{"_id":"632c5f3f2c4b5b0d3601da3d","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c5f3d2c4b5b0d3601da36","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"webhook","icon":"","type":"basic","slug":"webhook","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__webhook","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.173Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"632c5f3f2c4b5b0d3601da53","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Retrieve a list of webhooks","icon":"","type":"endpoint","slug":"get_v1-webhooks","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-webhooks","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.259Z","parentDoc":"632c5f3f2c4b5b0d3601da3d","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da54","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Create a webhook","icon":"","type":"endpoint","slug":"post_v1-webhooks","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-webhooks","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.260Z","parentDoc":"632c5f3f2c4b5b0d3601da3d","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da55","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Retrieve a webhook","icon":"","type":"endpoint","slug":"get_v1-webhooks-webhookid","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-webhooks-webhookid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.260Z","parentDoc":"632c5f3f2c4b5b0d3601da3d","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da56","api":{"method":"patch","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Update a webhook","icon":"","type":"endpoint","slug":"patch_v1-webhooks-webhookid","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"patch_v1-webhooks-webhookid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.261Z","parentDoc":"632c5f3f2c4b5b0d3601da3d","isBodyEmpty":true,"children":[]},{"_id":"632c5f3f2c4b5b0d3601da57","api":{"method":"delete","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c5f3d2c4b5b0d3601da36"},"title":"Delete a webhook","icon":"","type":"endpoint","slug":"delete_v1-webhooks-webhookid","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"delete_v1-webhooks-webhookid","link_url":"","link_external":false,"previousSlug":"","category":"632c5f3d2c4b5b0d3601da37","createdAt":"2022-09-22T13:12:31.261Z","parentDoc":"632c5f3f2c4b5b0d3601da3d","isBodyEmpty":true,"children":[]}]}]},{"_id":"632c674df3326b005e6ac0a7","title":"Influence.io Launcher API","slug":"influenceio-launcher-api","order":9999,"reference":true,"project":"632c5ef4e2eea4096d97e687","version":"632c5ef4e2eea4096d97e68c","createdAt":"2022-09-22T13:46:53.238Z","__v":0,"pages":[{"_id":"632c67c0b4b5e2098761e296","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Launcher API Reference","icon":"","type":"basic","slug":"launcher-api-introduction","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"introduction-1","createdAt":"2022-09-22T13:48:48.405Z","category":"632c674df3326b005e6ac0a7","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632c6753f3326b005e6ac0ad","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c674df3326b005e6ac0a6"},"title":"customer","icon":"","type":"basic","slug":"customer-1","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__customer","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2022-09-22T13:46:59.032Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"63c16a30339419006f958b13","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Retrieve a customer","icon":"","type":"endpoint","slug":"get_v1-customer","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.718Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a66659","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get all active rewards","icon":"","type":"endpoint","slug":"get_v1-customer-all-rewards","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-all-rewards","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.076Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a6665a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get a count of all active rewards.","icon":"","type":"endpoint","slug":"get_v1-customer-all-rewards-count","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-all-rewards-count","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.077Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b16","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Authenticate customer digest","icon":"","type":"endpoint","slug":"post_v1-customer-auth","order":3,"isReference":true,"deprecated":true,"hidden":false,"sync_unique":"post_v1-customer-auth","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.720Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b17","api":{"method":"put","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Update Birthday","icon":"","type":"endpoint","slug":"put_v1-customer-birthday","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"put_v1-customer-birthday","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.721Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"6426b6440a8e8504c0512fe7","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Action Landing Page","icon":"","type":"endpoint","slug":"post_v1-customer-dynamic-link","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customer-dynamic-link","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-03-31T10:30:28.834Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"6661a2f77896f50012ad1037","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Loyalty Card Lookup","icon":"","type":"endpoint","slug":"get_v1-customer-loyalty-card-lookup","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-loyalty-card-lookup","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-06-06T11:52:23.645Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b18","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List points activity","icon":"","type":"endpoint","slug":"get_v1-customer-points","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-points","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.722Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b19","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Redeem a reward","icon":"","type":"endpoint","slug":"post_v1-customer-redeem","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customer-redeem","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.722Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b1a","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List referral activity","icon":"","type":"endpoint","slug":"get_v1-customer-referrals","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-referrals","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.723Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"63c16a30339419006f958b1b","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Action social","icon":"","type":"endpoint","slug":"post_v1-customer-social","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customer-social","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-01-13T14:26:56.724Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"66c472d761daf600186d9bbc","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get current stamps","icon":"","type":"endpoint","slug":"get_v1-customer-stamps","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-customer-stamps","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-08-20T10:41:27.480Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":true,"children":[]},{"_id":"6538ec6ad497ab004c058b93","api":{"method":"post","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Upload a File","icon":"","type":"endpoint","slug":"post_v1-customer-upload-file","order":12,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"post_v1-customer-upload-file","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2023-10-25T10:22:34.905Z","parentDoc":"632c6753f3326b005e6ac0ad","isBodyEmpty":false,"children":[]}]},{"_id":"672a4443e8e64d0025a66657","api":{"method":"get","url":"","auth":"required","params":[],"apiSetting":"632c674df3326b005e6ac0a6"},"title":"shop","icon":"","type":"basic","slug":"shop","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"tag__shop","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.023Z","isBodyEmpty":true,"children":[{"_id":"672a4443e8e64d0025a6665b","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get Shop","icon":"","type":"endpoint","slug":"get_v1-shop","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.080Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a6665c","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List earn rules","icon":"","type":"endpoint","slug":"get_v1-shop-rules-earn","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-rules-earn","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.081Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a6665d","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List redeem rules","icon":"","type":"endpoint","slug":"get_v1-shop-rules-redeem","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-rules-redeem","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.081Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a6665e","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List earn product exclusions","icon":"","type":"endpoint","slug":"get_v1-shop-rules-earn-id-exclusions-product","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-rules-earn-id-exclusions-product","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.082Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a6665f","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List earn product variant exclusions","icon":"","type":"endpoint","slug":"get_v1-shop-rules-earn-id-exclusions-variant","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-rules-earn-id-exclusions-variant","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.082Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a66660","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List referral rules","icon":"","type":"endpoint","slug":"get_v1-shop-rules-referral","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-rules-referral","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.083Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a66661","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"List loyalty tiers","icon":"","type":"endpoint","slug":"get_v1-shop-tiers","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-tiers","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.083Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a66662","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get a loyalty tier","icon":"","type":"endpoint","slug":"get_v1-shop-tiers-id","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-tiers-id","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.084Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]},{"_id":"672a4443e8e64d0025a66663","api":{"method":"get","url":"","auth":"required","params":[],"results":{"codes":[]},"apiSetting":"632c674df3326b005e6ac0a6"},"title":"Get stamp card settings","icon":"","type":"endpoint","slug":"get_v1-shop-stamp-card","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"get_v1-shop-stamp-card","link_url":"","link_external":false,"previousSlug":"","category":"632c674df3326b005e6ac0a7","createdAt":"2024-11-05T16:13:55.084Z","parentDoc":"672a4443e8e64d0025a66657","isBodyEmpty":true,"children":[]}]}]},{"_id":"632d9148f38a78001061031f","title":"Webhook Events","slug":"webhook-events","order":9999,"reference":true,"project":"632c5ef4e2eea4096d97e687","version":"632c5ef4e2eea4096d97e68c","createdAt":"2022-09-23T10:58:16.419Z","__v":0,"pages":[{"_id":"632d91cc50a5e600406c181f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Introduction to Webhooks","icon":"","type":"basic","slug":"introduction-to-webhooks","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T11:00:28.501Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632d95edc50871004ea92951","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"customers/updated","icon":"","type":"basic","slug":"customersupdated","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T11:18:05.841Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632da2e2739dc7009c617ca5","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"customers/tier_changed","icon":"","type":"basic","slug":"customerstier_changed","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T12:13:22.638Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632da3d7a1c55e003a1000cf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"points/earned","icon":"","type":"basic","slug":"pointsearned","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T12:17:27.151Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632da4ed94c82e006926cb23","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"points/redeemed","icon":"","type":"basic","slug":"pointsredeemed","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T12:22:05.967Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632daeaf89cdde0a3a34474a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"referrals/started","icon":"","type":"basic","slug":"referralsstarted","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T13:03:43.888Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"632db09d48dee8018ad4700e","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"referrals/completed","icon":"","type":"basic","slug":"referralscompleted","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-09-23T13:11:57.398Z","category":"632d9148f38a78001061031f","parentDoc":null,"isBodyEmpty":false,"children":[]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"M2JhYjljZGY4Nzg2ZTQwMjQ5ODgzZmU3NDM4MWUzYWQ0M2Y5YzE4NDk1ZWYzNDMzM2IwMjIyNDcyYzU3MDRlMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjMyYzVlZjRlMmVlYTQwOTZkOTdlNjg3KSwodmVyc2lvbjpub25lLHZlcnNpb246NjMyYzVlZjRlMmVlYTQwOTZkOTdlNjhjKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"632c5ef4e2eea4096d97e687","name":"Influence.io","subdomain":"influenceio","subpath":"","nav_names":{"docs":"","reference":"","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":"influenceio"},"version":"1.0"}},"activeDoc":"getting-started-with-the-influenceio-platform-api","rdmd":{"baseUrl":"/","body":"## 👩🏫 Introduction\n\nOur API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.\n\n> 📘 There are three main considerations for setting up the platform via our API:\n> \n> 1. Importing your customers\n> 2. The processing of Customer, Order, and Product data\n> 3. The handling of our webhooks\n\nYou can see the documentation for the Platform API here: [Platform API documentation](https://developer.influence.io/reference/platform-api-introduction)\n\n***\n\n## 🙎♂️ Importing your customers\n\nThe first step for integrating with influence.io will be to ensure your customers have been properly imported into the platform. \n\n> 👍 We have a customer PUT endpoint for creating and updating customer records: [PUT Customers](https://developer.influence.io/reference/put_v1-customers-customerid)\n> \n> Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.\n\n***\n\n## 📊 Processing of Customer, Order, and Product data\n\nWe’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.\n\n### 🙍♀️ Updating Customer Data\n\n- You will need to hit the above endpoint with new/updated customers: [PUT Customers](https://developer.influence.io/reference/put_v1-customers-customerid)\n\nThis needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.\n\n### 🛒 Managing Orders\n\n- One of the most important endpoints for you to handle is the Order endpoint: [POST Orders](https://developer.influence.io/reference/post_v1-orders)\n\n> 🚧 Sending us order details is crucial to ensuring that your customers are being awarded points.\n> \n> We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.\n\n### 🛍️ Managing Products\n\n- One of the less important endpoints is for Products: [PUT Products](https://developer.influence.io/reference/put_v1-products-productid)\n\n> 📘 There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.\n> \n> The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.\n\n***\n\n## ⚙️ Handling our webhooks\n\nWhenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.\n\nYou can see the documentation for these webhooks here: [Webhook Documentation](https://developer.influence.io/reference/introduction-to-webhooks)\n\n> ❗️ The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.\n> \n> This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.\n\nTo re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.","opts":{"alwaysThrow":false,"compatibilityMode":false,"copyButtons":true,"correctnewlines":false,"markdownOptions":{"fences":true,"commonmark":true,"gfm":true,"ruleSpaces":false,"listItemIndent":"1","spacedTable":true,"paddedTable":true},"normalize":true,"lazyImages":true,"reusableContent":{"tags":{},"wrap":false},"safeMode":false,"settings":{"position":true},"theme":"light","resourceID":"63ca9ced81694f00950d917a","resourceType":"page","baseUrl":"/","terms":[{"_id":"632c5ef4e2eea4096d97e688","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"670fbf4ec50a20006de0560f","name":"x-api-key","type":"apiKey","apiSetting":"632c5f3d2c4b5b0d3601da36"}]}},"terms":[{"_id":"632c5ef4e2eea4096d97e688","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"670fbf4ec50a20006de0560f","name":"x-api-key","type":"apiKey","apiSetting":"632c5f3d2c4b5b0d3601da36"}]},"mdx":false,"dehydrated":{"toc":"<nav><ul class=\"toc-list\"><li><a class=\"tocHeader\" href=\"#\"><i class=\"icon icon-text-align-left\"></i>Table of Contents</a></li><li class=\"toc-children\"><ul>\n<li>\n<a href=\"#-introduction\">👩🏫 Introduction</a>\n</li>\n<li>\n<a href=\"#%E2%99%82%EF%B8%8F-importing-your-customers\">🙎♂️ Importing your customers</a>\n</li>\n<li>\n<a href=\"#-processing-of-customer-order-and-product-data\">📊 Processing of Customer, Order, and Product data</a>\n<ul>\n<li><a href=\"#%E2%99%80%EF%B8%8F-updating-customer-data\">🙍♀️ Updating Customer Data</a></li>\n<li><a href=\"#%F0%9F%9B%92-managing-orders\">🛒 Managing Orders</a></li>\n<li><a href=\"#%EF%B8%8F-managing-products\">🛍️ Managing Products</a></li>\n</ul>\n</li>\n<li>\n<a href=\"#%EF%B8%8F-handling-our-webhooks\">⚙️ Handling our webhooks</a>\n</li>\n</ul></li></ul></nav>","body":"<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"-introduction\"></div><div class=\"heading-text\"><div id=\"section-👩🏫-introduction\" class=\"heading-anchor_backwardsCompatibility\"></div>👩🏫 Introduction</div><a aria-label=\"Skip link to 👩🏫 Introduction\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#-introduction\"></a></h2>\n<p>Our API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.</p>\n<blockquote class=\"callout callout_info\" theme=\"📘\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">📘</span><p>There are three main considerations for setting up the platform via our API:</p></h2><ol>\n<li>Importing your customers</li>\n<li>The processing of Customer, Order, and Product data</li>\n<li>The handling of our webhooks</li>\n</ol></blockquote>\n<p>You can see the documentation for the Platform API here: <a href=\"https://developer.influence.io/reference/platform-api-introduction\" target=\"\" title=\"\">Platform API documentation</a></p>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"♂️-importing-your-customers\"></div><div class=\"heading-text\"><div id=\"section-🙎♂️-importing-your-customers\" class=\"heading-anchor_backwardsCompatibility\"></div>🙎♂️ Importing your customers</div><a aria-label=\"Skip link to 🙎♂️ Importing your customers\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#♂️-importing-your-customers\"></a></h2>\n<p>The first step for integrating with influence.io will be to ensure your customers have been properly imported into the platform. </p>\n<blockquote class=\"callout callout_okay\" theme=\"👍\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">👍</span><p>We have a customer PUT endpoint for creating and updating customer records: <a href=\"https://developer.influence.io/reference/put_v1-customers-customerid\" target=\"\" title=\"\">PUT Customers</a></p></h2><p>Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.</p></blockquote>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"-processing-of-customer-order-and-product-data\"></div><div class=\"heading-text\"><div id=\"section-📊-processing-of-customer-order-and-product-data\" class=\"heading-anchor_backwardsCompatibility\"></div>📊 Processing of Customer, Order, and Product data</div><a aria-label=\"Skip link to 📊 Processing of Customer, Order, and Product data\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#-processing-of-customer-order-and-product-data\"></a></h2>\n<p>We’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"♀️-updating-customer-data\"></div><div class=\"heading-text\"><div id=\"section-🙍♀️-updating-customer-data\" class=\"heading-anchor_backwardsCompatibility\"></div>🙍♀️ Updating Customer Data</div><a aria-label=\"Skip link to 🙍♀️ Updating Customer Data\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#♀️-updating-customer-data\"></a></h3>\n<ul>\n<li>You will need to hit the above endpoint with new/updated customers: <a href=\"https://developer.influence.io/reference/put_v1-customers-customerid\" target=\"\" title=\"\">PUT Customers</a></li>\n</ul>\n<p>This needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.</p>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"🛒-managing-orders\"></div><div class=\"heading-text\"><div id=\"section-🛒-managing-orders\" class=\"heading-anchor_backwardsCompatibility\"></div>🛒 Managing Orders</div><a aria-label=\"Skip link to 🛒 Managing Orders\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#🛒-managing-orders\"></a></h3>\n<ul>\n<li>One of the most important endpoints for you to handle is the Order endpoint: <a href=\"https://developer.influence.io/reference/post_v1-orders\" target=\"\" title=\"\">POST Orders</a></li>\n</ul>\n<blockquote class=\"callout callout_warn\" theme=\"🚧\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">🚧</span><p>Sending us order details is crucial to ensuring that your customers are being awarded points.</p></h2><p>We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.</p></blockquote>\n<h3 class=\"heading heading-3 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"️-managing-products\"></div><div class=\"heading-text\"><div id=\"section-🛍️-managing-products\" class=\"heading-anchor_backwardsCompatibility\"></div>🛍️ Managing Products</div><a aria-label=\"Skip link to 🛍️ Managing Products\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#️-managing-products\"></a></h3>\n<ul>\n<li>One of the less important endpoints is for Products: <a href=\"https://developer.influence.io/reference/put_v1-products-productid\" target=\"\" title=\"\">PUT Products</a></li>\n</ul>\n<blockquote class=\"callout callout_info\" theme=\"📘\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">📘</span><p>There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.</p></h2><p>The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.</p></blockquote>\n<hr/>\n<h2 class=\"heading heading-2 header-scroll\" align=\"\"><div class=\"heading-anchor anchor waypoint\" id=\"️-handling-our-webhooks\"></div><div class=\"heading-text\"><div id=\"section-⚙️-handling-our-webhooks\" class=\"heading-anchor_backwardsCompatibility\"></div>⚙️ Handling our webhooks</div><a aria-label=\"Skip link to ⚙️ Handling our webhooks\" class=\"heading-anchor-icon fa fa-anchor\" href=\"#️-handling-our-webhooks\"></a></h2>\n<p>Whenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.</p>\n<p>You can see the documentation for these webhooks here: <a href=\"https://developer.influence.io/reference/introduction-to-webhooks\" target=\"\" title=\"\">Webhook Documentation</a></p>\n<blockquote class=\"callout callout_error\" theme=\"❗️\"><h2 class=\"callout-heading\"><span class=\"callout-icon\">❗️</span><p>The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.</p></h2><p>This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.</p></blockquote>\n<p>To re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.</p>"}},"doc":{"metadata":{"image":[],"title":"","description":"","keywords":"","robots":"index"},"mdx":{"altBody":"","status":"rdmd"},"api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"next":{"description":"Platform API & Webhook documentation","pages":[{"name":"Platform API Reference","slug":"platform-api-introduction","type":"ref","category":"Influence.io Platform API"},{"name":"webhook","slug":"webhook","type":"ref","category":"Influence.io Platform API"}]},"algolia":{"recordCount":7,"publishPending":false,"translationFailure":false,"updatedAt":"2023-06-28T21:00:05.207Z"},"title":"Getting started with the Influence.io Platform API","icon":"","updates":[],"type":"basic","slug":"getting-started-with-the-influenceio-platform-api","excerpt":"A brief overview of what is needed for running Influence.io using our Platform API","body":"## 👩🏫 Introduction\n\nOur API is designed to work across multiple platforms, but it may require some initial setup in order to function properly. We are currently working on building specific integrations for certain platforms, but in the meantime, this API is available for our customers to use.\n\n> 📘 There are three main considerations for setting up the platform via our API:\n> \n> 1. Importing your customers\n> 2. The processing of Customer, Order, and Product data\n> 3. The handling of our webhooks\n\nYou can see the documentation for the Platform API here: [Platform API documentation](https://developer.influence.io/reference/platform-api-introduction)\n\n***\n\n## 🙎♂️ Importing your customers\n\nThe first step for integrating with influence.io will be to ensure your customers have been properly imported into the platform. \n\n> 👍 We have a customer PUT endpoint for creating and updating customer records: [PUT Customers](https://developer.influence.io/reference/put_v1-customers-customerid)\n> \n> Given the API is platform agnostic, it’s required that you decide upon the best course of action for yourselves to ensure that your customer information is fed into this endpoint and thus, into our platform.\n\n***\n\n## 📊 Processing of Customer, Order, and Product data\n\nWe’ve gone through the necessity of performing your initial importing of customer data above. The next step is required to ensure that customer data is kept updated and is being created properly whenever a customer is created or updated in your store.\n\n### 🙍♀️ Updating Customer Data\n\n- You will need to hit the above endpoint with new/updated customers: [PUT Customers](https://developer.influence.io/reference/put_v1-customers-customerid)\n\nThis needs to be done so that when new customers signup to the site, they will be enrolled in the program and can earn points/redeem rewards. This also allows us to keep track of any changes to the customers, such as their name.\n\n### 🛒 Managing Orders\n\n- One of the most important endpoints for you to handle is the Order endpoint: [POST Orders](https://developer.influence.io/reference/post_v1-orders)\n\n> 🚧 Sending us order details is crucial to ensuring that your customers are being awarded points.\n> \n> We also use this endpoint to determine whenever any pending referrals are able to be marked as complete.\n\n### 🛍️ Managing Products\n\n- One of the less important endpoints is for Products: [PUT Products](https://developer.influence.io/reference/put_v1-products-productid)\n\n> 📘 There is functionality in the platform to offer rewards that are tied to a specific product. You can also create an earn rule that excludes certain products from rewarding customers with points when it has been purchased.\n> \n> The product endpoint can be used to import your products into our platform so that they can be used within those earn and redeem rules.\n\n***\n\n## ⚙️ Handling our webhooks\n\nWhenever a customer of yours interacts with our platform, be it directly through our widgets i.e redeeming a reward, or starting the referral process. Or by having their points balance increase after making an order. Our platform will dispatch the details of these changes via webhooks that you may set up.\n\nYou can see the documentation for these webhooks here: [Webhook Documentation](https://developer.influence.io/reference/introduction-to-webhooks)\n\n> ❗️ The most important webhook you will want to ensure is set up and handled on your end is the points/redeemed topic.\n> \n> This webhook is fired straight after a customer of yours uses their points to redeem a reward from within one of our widgets. This webhook will contain information you will need to use to create the discount coupon that they can apply to their next order.\n\nTo re-iterate. Our API is platform agnostic which means the method by which you create a discount coupon in your store is completely up to you, we merely provide you with the text of what that coupon should be.","order":999,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"reusableContent":[],"previousSlug":"","slugUpdatedAt":"2023-01-19T22:44:57.404Z","revision":21,"_id":"63ca9ced81694f00950d917a","user":"649c5487a3c56d000c348895","project":"632c5ef4e2eea4096d97e687","category":{"title":"Getting started","slug":"documentation","order":9999,"reference":false,"_id":"632c5ef4e2eea4096d97e68e","version":"632c5ef4e2eea4096d97e68c","project":"632c5ef4e2eea4096d97e687","createdAt":"2022-09-22T13:11:16.438Z","__v":0,"type":"guide","id":"632c5ef4e2eea4096d97e68e"},"createdAt":"2023-01-20T13:53:49.102Z","updatedAt":"2023-06-28T21:00:04.907Z","version":{"version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["632c5ef4e2eea4096d97e68e","632c5ef4e2eea4096d97e68e","632c5f1d7e7cc10016dc2348","632c5f3d2c4b5b0d3601da37","632c5f8e03ea450d548ac069","632c674df3326b005e6ac0a7","632c676c7a28b000320c648e","632d7cf80ce50b07127cb8a7","632d9148f38a78001061031f","6376bf6c127d99000317542a"],"pdfStatus":"","_id":"632c5ef4e2eea4096d97e68c","project":"632c5ef4e2eea4096d97e687","releaseDate":"2022-09-22T13:11:16.392Z","createdAt":"2022-09-22T13:11:16.392Z","__v":1},"__v":1,"isApi":false,"tutorials":[],"id":"63ca9ced81694f00950d917a"},"hideTOC":false,"meta":{"_id":"63ca9ced81694f00950d917a","description":"A brief overview of what is needed for running Influence.io using our Platform API","hidden":false,"image":[],"keywords":"","metaTitle":"Getting started with the Influence.io Platform API","robots":"index","slug":"getting-started-with-the-influenceio-platform-api","title":"Getting started with the Influence.io Platform API","type":"docs"},"slugUrl":"/docs/getting-started-with-the-influenceio-platform-api","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":[{"_id":"632c5ef4e2eea4096d97e688","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"variables":{"user":{},"defaults":[{"source":"security","_id":"670fbf4ec50a20006de0560f","name":"x-api-key","type":"apiKey","apiSetting":"632c5f3d2c4b5b0d3601da36"}]},"project":{"_id":"632c5ef4e2eea4096d97e687","appearance":{"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":""}},"main_body":{"type":"links"},"colors":{"highlight":"","main":"#7034e4","main_alt":"","header_text":"","body_highlight":"#0048dc","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"},"global_landing_page":{"html":"","redirect":""},"referenceSimpleMode":true,"referenceLayout":"row","link_logo_to_url":false,"theme":"solid","colorScheme":"system","overlay":"triangles","landing":true,"sticky":false,"hide_logo":false,"childrenAsPills":false,"subheaderStyle":"links","splitReferenceDocs":false,"showMetricsInReference":true,"logo":["https://files.readme.io/9a0cd33-small-influenceio-icon-white-bg-square.png","influenceio-icon-white-bg-square.png",80,80,"#000000","https://files.readme.io/218a88a-influenceio-icon-white-bg-square.png"],"loginLogo":[],"logo_white":["https://files.readme.io/c0a292a-small-influenceio-logo--inverted3x.png","c0a292a-small-influenceio-logo--inverted3x.png",357,80,"#000000","https://files.readme.io/509eb3d-influenceio-logo--inverted3x.png","650d8fc6fbfad1002634f393"],"logo_white_use":true,"logo_large":false,"favicon":["https://files.readme.io/c0e709b-small-influenceio-favicon.png","influenceio-favicon.png",32,32,"#000000","https://files.readme.io/9eb1ce2-influenceio-favicon.png"],"stylesheet":"","stylesheet_hub2":"","stylesheet_hub3":"","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":"docs","buttonSecondary":"reference"},"title":"The Influence.io Developer Hub","text":"Welcome to the Influence.io developer hub. You'll find comprehensive guides and documentation to help you start working with Influence.io as quickly as possible, as well as support if you get stuck. Let's jump right in!","_id":"632c5ef4e2eea4096d97e689"}],"changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"developer.influence.io","childrenProjects":[],"derivedPlan":"startup2018","description":"","error404":"","experiments":[],"first_page":"landing","flags":{"allowApiExplorerJsonEditor":false,"allowDarkMode":false,"alwaysShowDocPublishStatus":false,"allow_hub2":false,"allowXFrame":false,"correctnewlines":false,"dashReact":false,"disablePasswordlessLogin":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"graphql":false,"hub2":true,"migrationRun":false,"migrationSwaggerRun":false,"newEditor":true,"newEditorDash":true,"newMarkdownBetaProgram":true,"newSearch":true,"oauth":false,"oldMarkdown":false,"personalizedDocs":false,"rdmdCompatibilityMode":false,"reviewWorkflow":true,"singleProjectEnterprise":false,"speedyRender":false,"staging":false,"star":false,"swagger":false,"translation":false,"useReactApp":true,"useReactGLP":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"apiV2":false,"customBlocks":false,"devDashHub":false,"disableAutoTranslate":false,"disableSAMLScoping":false,"git":{"read":false,"write":false},"owlbotAi":false,"superHubBeta":false,"allowUnsafeCustomHtmlSuggestionsFromNonAdmins":false,"apiAccessRevoked":false,"passwordlessLogin":"default","disableSignups":false,"billingRedesignEnabled":true,"developerPortal":false,"mdx":false,"superHubDevelopment":false,"annualBillingEnabled":true,"devDashBillingRedesignEnabled":false,"enableOidc":false,"customComponents":false,"disableDiscussionSpamRecaptchaBypass":false,"developerViewUsersData":false,"changelogRssAlwaysPublic":false,"bidiSync":false,"superHubMigrationSelfServeFlow":true},"fullBaseUrl":"https://developer.influence.io/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"632c5ef4e2eea4096d97e688","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"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":[],"mdxMigrationStatus":"rdmd","metrics":{"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyLimit":0,"planLimit":2000000,"thumbsEnabled":true,"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"name":"Influence.io","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":false,"api":true,"logs":false,"domain":false,"metricsSDK":false},"owlbot":{"enabled":false,"isPaying":false,"customization":{"answerLength":"long","customTone":"","defaultAnswer":"","forbiddenWords":"","tone":"neutral"},"copilot":{"enabled":false,"hasBeenUsed":false,"installedCustomPage":""}},"owner":{"id":null,"email":null,"name":null},"plan":"startup2018","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"startup2018","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":true,"points":10},"customLogin":{"enabled":false,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":false,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":false,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":false,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":false,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":false,"points":2}},"totalScore":132},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"632c5ef4e2eea4096d97e68c","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["632c5ef4e2eea4096d97e68e","632c5ef4e2eea4096d97e68e","632c5f1d7e7cc10016dc2348","632c5f3d2c4b5b0d3601da37","632c5f8e03ea450d548ac069","632c674df3326b005e6ac0a7","632c676c7a28b000320c648e","632d7cf80ce50b07127cb8a7","632d9148f38a78001061031f","6376bf6c127d99000317542a"],"project":"632c5ef4e2eea4096d97e687","releaseDate":"2022-09-22T13:11:16.392Z","createdAt":"2022-09-22T13:11:16.392Z","__v":1},"subdomain":"influenceio","subpath":"","superHubWaitlist":false,"topnav":{"left":[],"right":[{"type":"url","text":"Dashboard","url":"https://dashboard.influence.io"}],"bottom":[],"edited":true},"trial":{"trialDeadlineEnabled":true,"trialEndsAt":"2022-10-06T13:11:16.050Z"},"translate":{"provider":"transifex","show_widget":false,"key_public":"","org_name":"","project_name":"","languages":[]},"url":"https://dashboard.influence.io","versions":[{"_id":"632c5ef4e2eea4096d97e68c","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["632c5ef4e2eea4096d97e68e","632c5ef4e2eea4096d97e68e","632c5f1d7e7cc10016dc2348","632c5f3d2c4b5b0d3601da37","632c5f8e03ea450d548ac069","632c674df3326b005e6ac0a7","632c676c7a28b000320c648e","632d7cf80ce50b07127cb8a7","632d9148f38a78001061031f","6376bf6c127d99000317542a"],"project":"632c5ef4e2eea4096d97e687","releaseDate":"2022-09-22T13:11:16.392Z","createdAt":"2022-09-22T13:11:16.392Z","__v":1}],"variableDefaults":[{"source":"security","_id":"670fbf4ec50a20006de0560f","name":"x-api-key","type":"apiKey","apiSetting":"632c5f3d2c4b5b0d3601da36"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"632c5ef4e2eea4096d97e688","term":"parliament","definition":"Owls are generally solitary, but when seen together the group is called a 'parliament'!"}],"canonical_url":null,"description":null,"parent":null,"homepage_url":"https://dashboard.influence.io","id":"632c5ef4e2eea4096d97e687","is_migrated":false,"name":"Influence.io","redirects":[],"sitemap":"disabled","subdomain":"influenceio","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"x-api-key","source":"security","type":"apiKey","id":"670fbf4ec50a20006de0560f"}],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":true,"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":"2022-10-06T13:11:16.050Z"}},"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":"#7034e4","link_color":"#0048dc","theme":"system"},"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":"/images/650d8fc6fbfad1002634f393","url":"https://files.readme.io/c0a292a-small-influenceio-logo--inverted3x.png","name":"c0a292a-small-influenceio-logo--inverted3x.png","width":357,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/509eb3d-influenceio-logo--inverted3x.png"}},"main":{"uri":null,"url":"https://files.readme.io/9a0cd33-small-influenceio-icon-white-bg-square.png","name":"influenceio-icon-white-bg-square.png","width":80,"height":80,"color":"#000000","links":{"original_url":"https://files.readme.io/218a88a-influenceio-icon-white-bg-square.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/c0e709b-small-influenceio-favicon.png","name":"influenceio-favicon.png","width":32,"height":32,"color":"#000000","links":{"original_url":"https://files.readme.io/9eb1ce2-influenceio-favicon.png"}}},"custom_code":{"css":null,"js":null,"html":{"header":null,"home_footer":null,"page_footer":null}},"header":{"type":"solid","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":[],"logo_link":"landing_page","right":[{"type":"link_url","title":"Dashboard","url":"https://dashboard.influence.io","custom_page":null}],"sub_nav":[],"subheader_layout":"links","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":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"disabled"},"changelog":{"label":"Changelog","alias":null,"visibility":"disabled"},"discussions":{"label":"Discussions","alias":null,"visibility":"disabled"}}}}}},"version":{"_id":"632c5ef4e2eea4096d97e68c","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["632c5ef4e2eea4096d97e68e","632c5ef4e2eea4096d97e68e","632c5f1d7e7cc10016dc2348","632c5f3d2c4b5b0d3601da37","632c5f8e03ea450d548ac069","632c674df3326b005e6ac0a7","632c676c7a28b000320c648e","632d7cf80ce50b07127cb8a7","632d9148f38a78001061031f","6376bf6c127d99000317542a"],"project":"632c5ef4e2eea4096d97e687","releaseDate":"2022-09-22T13:11:16.392Z","createdAt":"2022-09-22T13:11:16.392Z","__v":1}},"reqUrl":"/docs/getting-started-with-the-influenceio-platform-api","version":{"_id":"632c5ef4e2eea4096d97e68c","version":"1.0","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["632c5ef4e2eea4096d97e68e","632c5ef4e2eea4096d97e68e","632c5f1d7e7cc10016dc2348","632c5f3d2c4b5b0d3601da37","632c5f8e03ea450d548ac069","632c674df3326b005e6ac0a7","632c676c7a28b000320c648e","632d7cf80ce50b07127cb8a7","632d9148f38a78001061031f","6376bf6c127d99000317542a"],"project":"632c5ef4e2eea4096d97e687","releaseDate":"2022-09-22T13:11:16.392Z","createdAt":"2022-09-22T13:11:16.392Z","__v":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,4002,3787,5798,4935,1666,6841,6722,1936,7971,153,1313,1343,6060,3859,9575,8063,1202,2144,9141,5408,2637,4674,1731,4793,2616,3412,1080,9852,8684,678,6922,2859,3221,7327,7285,3307,1948]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","routes-Landing","Footer","core-icons-chevron-up-down-svg","routes-PageNotFound","routes-Doc","routes-Reference","core-icons-more-vertical-svg","core-icons-lock-svg","core-icons-chevron-down-svg","core-icons-arrow-right-svg","core-icons-arrow-up-right-svg","core-icons-alert-circle-svg","routes-Changelog","Post","routes-Discuss","List","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","core-icons-webhook-svg","CustomPage","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx"]}</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="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="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.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-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.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/6722.e485c5aa155bd0f0ccf8.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-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/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="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="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="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="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="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-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="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="List" src="https://cdn.readme.io/public/hub/web/2637.a5df1d5e240762d7981f.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-star-svg" src="https://cdn.readme.io/public/hub/web/core-icons-star-svg.b834e1612cb2af1e174e.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> <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-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.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-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></div><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"M2JhYjljZGY4Nzg2ZTQwMjQ5ODgzZmU3NDM4MWUzYWQ0M2Y5YzE4NDk1ZWYzNDMzM2IwMjIyNDcyYzU3MDRlMXRhZ0ZpbHRlcnM9KHByb2plY3Q6NjMyYzVlZjRlMmVlYTQwOTZkOTdlNjg3KSwodmVyc2lvbjpub25lLHZlcnNpb246NjMyYzVlZjRlMmVlYTQwOTZkOTdlNjhjKSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlKQ==","filters":"tagFilters=(project:632c5ef4e2eea4096d97e687),(version:none,version:632c5ef4e2eea4096d97e68c),(hidden:none,hidden:false),(index:CustomPage,index:Page)","metaData":[{"modules":{"landing":true,"docs":true,"examples":false,"reference":true,"graphql":false,"changelog":false,"discuss":false,"suggested_edits":true,"logs":false,"custompages":false,"tutorials":false},"id":"632c5ef4e2eea4096d97e687","name":"Influence.io","subdomain":"influenceio","subpath":"","nav_names":{"docs":"","reference":"","changelog":"","discuss":"","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json" data-json=""/""></script></body></html>