CINXE.COM
ActiveCampaign
<!DOCTYPE html><html lang="en" style="" data-color-mode="light" class=" useReactApp "><head><script src="https://cdn.readme.io/public/js/force-firefox-anchor-jump.js?1732290089794"></script><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="readme-deploy" content="5.235.0"><meta name="readme-subdomain" content="activecampaign"><meta name="readme-version" content="3"><title>ActiveCampaign</title><meta name="description" content="Documentation for ActiveCampaign's APIs and native CX apps built with App Studio"><meta property="og:title" content=""><meta property="og:description" content="Documentation for ActiveCampaign's APIs and native CX apps built with App Studio"><meta property="og:site_name" content="ActiveCampaign"><meta name="twitter:title" content=""><meta name="twitter:description" content="Documentation for ActiveCampaign's APIs and native CX apps built with App Studio"><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/4bca7fa-small-ac_logo-blue-trans.png"><meta name="twitter:image" content="https://files.readme.io/4bca7fa-small-ac_logo-blue-trans.png"><link id="favicon" rel="shortcut icon" href="https://files.readme.io/7779a2b-small-ac_mark-white-bluebg.png" type="image/png"><link rel="canonical" href="https://developers.activecampaign.com//"><script src="https://cdn.readme.io/public/js/cash-dom.min.js?1732290089794"></script><link data-chunk="New" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="Page" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Discuss" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="routes-SuperHub-Routes" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="List" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.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="CustomPage" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.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="routes-Doc" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="Editor" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.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-Reference" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="Header" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="main" rel="preload" as="style" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"> <link data-chunk="routes-SuperHub" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"> <link data-chunk="Header" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"> <link data-chunk="core-icons-chevron-up-down-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"> <link data-chunk="routes-Reference" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"> <link data-chunk="Footer" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"> <link data-chunk="routes-PageNotFound" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"> <link data-chunk="Editor" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.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="routes-Doc" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"> <link data-chunk="routes-Landing" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"> <link data-chunk="core-icons-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="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-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="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="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-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="routes-Discuss" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"> <link data-chunk="Page" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.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="routes-Tutorials" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.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-webhook-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"> <link data-chunk="New" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"> <link data-chunk="core-icons-eye-off-svg" rel="preload" as="script" href="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/ui-styles.a5d24742a3656724b61d.css"> <link data-chunk="main" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/main.2415ba38e8e5c2ba190e.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/2395.593cd7b6ba0bdb6787a8.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/8263.75e3fc491ee8103c63a3.css"> <link data-chunk="routes-SuperHub" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub.db8b3beb03eead84c21e.css"> <link data-chunk="Header" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Header.1c46140f4fda4e981a8d.css"> <link data-chunk="routes-Reference" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Reference.087102afd3bca3215f45.css"> <link data-chunk="routes-PageNotFound" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-PageNotFound.d8afd1171cf7a455eed7.css"> <link data-chunk="Editor" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Editor.c9adabeec62cc7e2bd7a.css"> <link data-chunk="routes-Doc" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Doc.921b58c17b447c4e783e.css"> <link data-chunk="routes-Landing" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Landing.c5ea43d2f4b3b926ff1f.css"> <link data-chunk="CustomPage" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/CustomPage.38a39d6ce8b0e2afad5a.css"> <link data-chunk="routes-Changelog" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Changelog.28957affcff81e852361.css"> <link data-chunk="List" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/List.8b6b887d01c2343868e8.css"> <link data-chunk="routes-SuperHub-Routes" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.394c4b2f8910cf363781.css"> <link data-chunk="routes-Discuss" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Discuss.8f79ff8c1099c5933136.css"> <link data-chunk="Page" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/Page.f8e4e9e20d429e588f3c.css"> <link data-chunk="routes-Tutorials" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/routes-Tutorials.1d38d1ab2f3572f1dd24.css"> <link data-chunk="New" rel="stylesheet" href="https://cdn.readme.io/public/hub/web/New.f8e4e9e20d429e588f3c.css"><!-- CUSTOM CSS--><style title="rm-custom-css">:root{--project-color-primary:#356ae6;--project-color-inverse:#fff;--recipe-button-color:#356ae6;--recipe-button-color-hover:#143ea1;--recipe-button-color-active:#0e2d74;--recipe-button-color-focus:rgba(53, 106, 230, 0.25);--recipe-button-color-disabled:#ebf0fc}[id=enterprise] .ReadMeUI[is=AlgoliaSearch]{--project-color-primary:#356ae6;--project-color-inverse:#fff}a{color:var(--color-link-primary,#356ae6)}a:hover{color:var(--color-link-primary-darken-5,#143ea1)}a.text-muted:hover{color:var(--color-link-primary,#356ae6)}.btn.btn-primary{background-color:#356ae6}.btn.btn-primary:hover{background-color:#143ea1}.theme-line #hub-landing-top h2{color:#356ae6}#hub-landing-top .btn:hover{color:#356ae6}.theme-line #hub-landing-top .btn:hover{color:#fff}.theme-solid header#hub-header #header-top{background-color:#356ae6}.theme-solid.header-gradient header#hub-header #header-top{background:linear-gradient(to bottom,#356ae6,#0741c7)}.theme-solid.header-custom header#hub-header #header-top{background-image:url(https://files.readme.io/8fdd9b9-010.jpg)}.theme-line header#hub-header #header-top{border-bottom-color:#356ae6}.theme-line header#hub-header #header-top .btn{background-color:#356ae6}header#hub-header #header-top #header-logo{width:260px;height:27px;margin-top:6px;background-image:url(https://files.readme.io/b425c4d-small-ac_logo-white-trans.png)}#hub-subheader-parent #hub-subheader .hub-subheader-breadcrumbs .dropdown-menu a:hover{background-color:#356ae6}#subheader-links a.active{color:#356ae6!important;box-shadow:inset 0 -2px 0 #356ae6}#subheader-links a:hover{color:#356ae6!important;box-shadow:inset 0 -2px 0 #356ae6;opacity:.7}.discussion .submit-vote.submit-vote-parent.voted a.submit-vote-button{background-color:#356ae6}section#hub-discuss .discussion a .discuss-body h4{color:#356ae6}section#hub-discuss .discussion a:hover .discuss-body h4{color:#143ea1}#hub-subheader-parent #hub-subheader.sticky-header.sticky{border-bottom-color:#356ae6}#hub-subheader-parent #hub-subheader.sticky-header.sticky .search-box{border-bottom-color:#356ae6}#hub-search-results h3 em{color:#356ae6}.main_background,.tag-item{background:#356ae6!important}.main_background:hover{background:#143ea1!important}.main_color{color:#356ae6!important}.border_bottom_main_color{border-bottom:2px solid #356ae6}.main_color_hover:hover{color:#356ae6!important}section#hub-discuss h1{color:#356ae6}#hub-reference .hub-api .api-definition .api-try-it-out.active{border-color:#356ae6;background-color:#356ae6}#hub-reference .hub-api .api-definition .api-try-it-out.active:hover{background-color:#143ea1;border-color:#143ea1}#hub-reference .hub-api .api-definition .api-try-it-out:hover{border-color:#356ae6;color:#356ae6}#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,#356ae6);border-color:var(--project-color-primary,#356ae6)}#hub-reference .hub-reference .logs .logs-empty .logs-login-button:hover,#hub-reference .hub-reference .logs .logs-login .logs-login-button:hover{background-color:#143ea1;border-color:#143ea1}#hub-reference .hub-reference .logs .logs-empty>svg>path,#hub-reference .hub-reference .logs .logs-login>svg>path{fill:#356ae6;fill:var(--project-color-primary,#356ae6)}#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:#356ae6}.main-color-accent{border-bottom:3px solid #356ae6;padding-bottom:8px}/*! BEGIN HUB_CUSTOM_STYLES */body{font-family:ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif!important}body,p{color:#1f2129}header#hub-header #header-top #header-logo{width:200px!important;height:33px!important}.ac_info-general{background:#f7f7f7;padding:14px;border:#c8c8c8 1px solid;border-radius:5px;-webkit-border-radius:5px;-moz-border-radius:5px;box-sizing:border-box;-webkit-box-sizing:border-box;-moz-box-sizing:border-box}.hub-landing-description p{color:#fff!important}.ac_container.ac_container-grayborder,.ac_container.greyborder{border:#cacaca 1px solid;position:relative;padding:0 20px 20px 20px;border-radius:6px!important;width:100%;-webkit-box-sizing:border-box;-moz-box-sizing:border-box;box-sizing:border-box}.mb40{margin-bottom:40px}.theme-solid header#hub-header #header-top #header-nav-left li,.theme-solid header#hub-header #header-top #header-nav-right li{padding-left:10px;padding-right:10px}.theme-solid header#hub-header #header-top #header-nav-left li a,.theme-solid header#hub-header #header-top #header-nav-right li a{color:#fff!important;padding:0!important;font-family:ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif;font-size:14px!important}.theme-solid header#hub-header #header-top #header-nav-left li a:hover,.theme-solid header#hub-header #header-top #header-nav-right li a:hover{border-bottom:2px solid;border-color:#fff;padding-bottom:7px!important}#header-bottom-nav .hub-subheader-breadcrumbs{display:none!important}#hub-subheader{background-color:#2a4c79!important}#hub-search input{background-color:#2a4c79!important;color:rgba(255,255,255,.78)!important}#hub-search input::placeholder{color:rgba(255,255,255,.78)!important}#hub-search .fa.fa-search{color:rgba(255,255,255,.78)!important}#content-head h1{text-align:left}.rm-Header *{--Header-border-width:0px!important}@media (max-width:600px){body .content-body .selector,body .content-body .selector.long,body .content-body .selector.long.half,body .content-body .selector.long:not(.half){float:none!important;clear:both!important;width:100%!important}}body{font-family:Ubuntu,'Helvetica Neue',Helvetica,Arial,sans-serif;font-size:15px}#content-head .excerpt{padding-top:1rem}.Dropdown a[href="/discuss"]{display:none}.grecaptcha-badge{display:none!important}.video-embed{position:relative;padding:0 0 56.25% 0;max-width:100%;height:auto;margin:0;background:#000;border:1px solid #5875eb;border-radius:4px;overflow:hidden;-webkit-box-shadow:0 5px 12px rgba(62,62,62,.2);-moz-box-shadown:0 5px 12px rgba(62,62,62,.2);box-shadow:0 5px 12px rgba(62,62,62,.2)}.video-embed iframe{position:absolute;top:0;left:0;height:100%;width:100%;display:block;border:none;outline:0}*{outline:0;-webkit-font-smoothing:subpixel-antialiased;-webkit-padding-start:0}.content-body .selector{position:relative;top:0;padding:25px 20px 35px 20px;border:solid 1px rgba(0,0,0,.1);display:block;float:left;text-decoration:none;width:calc((100%/3) - 20px);-webkit-border-radius:7px;-moz-border-radius:7px;border-radius:7px;text-align:center;color:#000;text-decoration:none!important;margin-right:20px;margin-bottom:20px;-webkit-transition:all .2s ease .01s;-moz-transition:all .2s ease .01s;-o-transition:all .2s ease .01s;transition:all .2s ease .01s;-webkit-box-shadow:0 4px 10px rgba(62,62,62,.03);-moz-box-shadown:0 4px 10px rgba(62,62,62,.03);box-shadow:0 4px 10px rgba(62,62,62,.03)}.content-body .selector.col-2{width:calc((100%/2) - 20px)}.content-body .selector:hover{border-color:#4968f1;top:-2px;border-color:#8297f9;-webkit-box-shadow:0 5px 8px rgba(81,111,247,.2);-moz-box-shadown:0 5px 8px rgba(81,111,247,.2);box-shadow:0 5px 8px rgba(81,111,247,.2)}.content-body .selector.long{padding-bottom:20px}.content-body .selector.long:not(.half){width:calc(100% - 30px)}.content-body .selector.long.half{width:calc(50% - 30px)}.content-body .selector.long .icon{float:left;height:50px}.content-body .selector.long .selector-info{float:right;width:calc(100% - 70px);text-align:left}.content-body .selector .icon{font-size:40px;height:40px;margin-bottom:20px}.content-body .selector .title{font-size:18px;font-weight:500}.content-body .selector .description{font-size:15px;line-height:20px;margin:8px 0 10px 0;color:rgba(0,0,0,.5)}.content-body .selector .description strong{display:block;margin-top:5px}.content-body .selector .est{font-size:15px;line-height:18px;color:#4968f1;font-style:italic}.content-body .clear{float:none;clear:both}.CodeTabs-toolbar button:only-child{display:none}.Header-searchtb6Foi0-D9Vx{position:relative!important;margin-left:auto!important;margin-bottom:5px}/*! END HUB_CUSTOM_STYLES */</style><meta name="loadedProject" content="activecampaign"><link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=Poppins:wght@700&display=swap" rel="stylesheet"> <script src="https://cdn.tailwindcss.com"></script> <script> tailwind.config = { content: [ ], theme: { screens: { sm: '480px', md: '768px', lg: '1020px', xl: '1440px' }, extend: { colors: { dusk: 'hsl(194, 100%, 13%)', darkDusk: 'hsla(195, 100%, 9%, 1)', acBlue: 'hsl(222, 100%, 50%)', mint: 'hsl(165, 95%, 70%)', coral: 'hsl(14, 100%, 79%)', acBlue200: 'hsl(206, 100%, 96%)', acBlueDark1: 'hsl(238, 100%, 33%)', acBlueDark2: 'hsl(230, 100%, 41%)', acBlueLight1: 'hsl(222, 100%, 66%)', acBlueLight2: 'hsl(222, 100%, 80%)', acBlueLight3: 'hsl(222, 100%, 90%)', acBlueLight4: ' hsl(223, 100%, 96%)', darkMint: ' hsl(166, 78%, 45%)', grayishBlue: 'hsl(201, 11%, 66%)', darkCoral1: 'hsl(11, 100%, 60%)', lightDusk3: 'hsl(194, 25%, 66%)', lightDusk4: 'hsl(194, 26%, 80%)', lightDusk5: 'hsl(192, 31%, 94%)', }, fontFamily: { poppins: ['Poppins', 'sans-serif'], ibm: ['IBM Plex Sans', 'sans-serif'] }, }, } } </script> <style> #ssr-main .rm-LandingPage { width: 100%; --LandingPage-gap: var(--gap, 0em); } .markdown-body .font-poppins { font-family: Poppins, sans-serif; } #ssr-main .markdown-body h1 { color: #000; } .markdown-body .lg\:text-6xl { font-size: 3.75rem; } </style> <!-- Google Tag Manager --> <script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start': new Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0], j=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src= 'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f); })(window,document,'script','dataLayer','GTM-NQ88L9R');</script> <!-- End Google Tag Manager --><script>var storedColorMode = `light` === 'system' ? window.localStorage.getItem('color-scheme') : `light` document.querySelector('[data-color-mode]').setAttribute('data-color-mode', storedColorMode)</script><script id="config" type="application/json" data-json="{"algoliaIndex":"readme_search_v2","amplitude":{"apiKey":"dc8065a65ef83d6ad23e37aaf014fc84","enabled":true},"asset_url":"https://cdn.readme.io","domain":"readme.io","domainFull":"https://dash.readme.com","encryptedLocalStorageKey":"ekfls-2024-05","fullstory":{"enabled":true,"orgId":"FSV9A"},"metrics":{"billingCronEnabled":"true","dashUrl":"https://m.readme.io","defaultUrl":"https://m.readme.io","exportMaxRetries":12,"wsUrl":"wss://m.readme.io"},"proxyUrl":"https://try.readme.io","readmeRecaptchaSiteKey":"6LesVBYpAAAAAESOCHOyo2kF9SZXPVb54Nwf3i2x","releaseVersion":"5.235.0","sentry":{"dsn":"https://3bbe57a973254129bcb93e47dc0cc46f@o343074.ingest.sentry.io/2052166","enabled":true,"tracesSampleRate":0},"shMigration":{"promoVideo":"","forceWaitlist":false},"sslBaseDomain":"readmessl.com","sslGenerationService":"ssl.readmessl.com","stripePk":"pk_live_5103PML2qXbDukVh7GDAkQoR4NSuLqy8idd5xtdm9407XdPR6o3bo663C1ruEGhXJjpnb2YCpj8EU1UvQYanuCjtr00t1DRCf2a","superHub":{"newProjectsEnabled":true},"wootric":{"accountToken":"NPS-122b75a4","enabled":true}}"></script></head><body class="body-none theme-solid header-gradient header-bg-size-auto header-bg-pos-tl header-overlay-circuits reference-layout-row lumosity-normal no-sidebar"><div id="ssr-top"></div><div id="ssr-main"><div class="App ThemeContext ThemeContext_dark " style="--color-primary:#356ae6;--color-primary-inverse:#fff;--color-primary-alt:#0741c7;--color-primary-darken-10:#1a50ce;--color-primary-darken-20:#143ea1;--color-primary-alpha-25:rgba(53, 106, 230, 0.25);--color-link-primary:#356ae6;--color-link-primary-darken-5:#1e59e3;--color-link-primary-darken-10:#1a50ce;--color-link-primary-darken-20:#143ea1;--color-link-primary-alpha-50:rgba(53, 106, 230, 0.5);--color-link-primary-alpha-25:rgba(53, 106, 230, 0.25);--color-link-background:rgba(53, 106, 230, 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 rm-Header_gradient"><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="https://www.activecampaign.com/" target="_self"><img alt="ActiveCampaign" class="rm-Logo-img Header-logo-img3YvV4lcGKkeb" src="https://files.readme.io/b425c4d-small-ac_logo-white-trans.png"/></a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/" target="_self">Home</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/page/developer-sandbox-accounts" target="_self">Sandbox Accounts</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/reference" target="_self">API Documentation</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/docs" target="_self" to="/docs">App Studio</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="/page/webhooks" target="_self">Webhooks</a><a class="Button Button_md rm-Header-link rm-Header-top-link Button_slate_text Header-link2tXYTgXq85zW" href="https://community.activecampaign.com/c/developers/16" target="_self" to="https://community.activecampaign.com/c/developers/16">Community</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 class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/docs" target="_self"><i class="icon-guides NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Guides</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/recipes" target="_self"><i class="icon-recipes NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Recipes</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 Documentation</span></a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- " href="/changelog" target="_self"><i class="icon-changelog NavItem-badge1qOxpfTiALoz"></i><span class="NavItem-textSlZuuL489uiw">Latest Updates</span></a><hr class="MobileFlyout-divider10xf7R2X1MeW"/><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/" target="_self">Home</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/page/developer-sandbox-accounts" target="_self">Sandbox Accounts</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/reference" target="_self">API Documentation</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/docs" target="_self" to="/docs">App Studio</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="/page/webhooks" target="_self">Webhooks</a><a class="rm-MobileFlyout-item NavItem-item1gDDTqaXGhm1 NavItem-item_mobile1qG3gd-Mkck- NavItem_dropdown-muted1xJVuczwGc74" href="https://community.activecampaign.com/c/developers/16" rel="noopener" target="_blank" to="https://community.activecampaign.com/c/developers/16">Community</a><a class="MobileFlyout-logo3Lq1eTlk1K76 Header-logo1Xy41PtkzbdG rm-Logo" href="https://www.activecampaign.com/" target="_self"><img alt="ActiveCampaign" class="Header-logo-img3YvV4lcGKkeb rm-Logo-img" src="https://files.readme.io/b425c4d-small-ac_logo-white-trans.png"/></a></div></div></div></div><div class="Header-left-nav2xWPWMNHOGf_"><i class="undefined Header-left-nav-icon10glJKFwewOv"></i></div></div><div class="rm-Header-right Header-right21PC2XTT6aMg"><span class="Header-right_desktop14ja01RUQ7HE"></span><div class="Header-searchtb6Foi0-D9Vx"><button aria-label="Search" class="rm-SearchToggle" data-symbol="⌘"><div class="rm-SearchToggle-icon icon-search1"></div></button></div></div></div></div><div class="Header-bottom2eLKOFXMEmh5 rm-Header-bottom "><div class="rm-Container rm-Container_flex"><nav class="Header-leftADQdGVqx1wqU"><div class="Dropdown Dropdown_closed"><div class="Dropdown-toggle" aria-haspopup="dialog"><button class="rm-Header-link rm-Header-bottom-link undefined Button Button_slate_text Button_md" type="button"><span></span><i class="undefined icon-chevron-down"></i></button></div></div></nav><div class="rm-Header-search Header-searchtb6Foi0-D9Vx "><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><div class="PageNotFound3u7_0vlmK5-A rm-Container"><img alt="" class="PageNotFound-logoJythb8vq2xAB" src="https://files.readme.io/4bca7fa-small-ac_logo-blue-trans.png"/><h2 class="PageNotFound-titlevy1rat2lG86f">Page Not Found</h2></div><footer aria-label="Status banner" class="AppFooter rm-Banners"></footer><footer><!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) --> <script src="https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js" async></script></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":"5d8b7ac425e74f031c7f1e5c","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":false,"createdAt":"2019-09-25T14:33:40.184Z","order":1,"slug":"testing","title":"App Studio","__v":0,"pages":[{"_id":"5d93709d85a9c8003168b7b5","createdAt":"2019-10-01T15:28:29.338Z","category":"5d8b7ac425e74f031c7f1e5c","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":0,"slug":"getting-started-and-guides","type":"basic","title":"Getting Started and Guides","parentDoc":null,"previousSlug":"getting-started","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"5ea9dd0dc9b8b6003ade1cb0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Overview","type":"basic","slug":"overview-v2","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-29T19:34:46.784Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5d93709d85a9c8003168b7b5","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5eaad91364b9870251dd55d6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Configuration Walkthrough","type":"basic","slug":"configuration-walkthrough-1","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T09:32:15.713Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5d93709d85a9c8003168b7b5","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61d67c23f67cdf000f752cc3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"CX App Submission Guidelines","type":"basic","slug":"cx-app-submission-guidelines","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-01-06T05:20:35.272Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5d93709d85a9c8003168b7b5","icon":"","isBodyEmpty":false,"children":[]},{"_id":"62a7738c40034e0086af05db","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Public vs Private Apps","type":"basic","slug":"public-vs-private-apps","order":3,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-06-13T17:27:40.033Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5d93709d85a9c8003168b7b5","isBodyEmpty":false,"children":[]},{"_id":"63a0995c20f4fd004be0289c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"CX App Go Live Guide","icon":"","type":"basic","slug":"cx-app-go-live-guide","order":4,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5d8b7ac425e74f031c7f1e5c","createdAt":"2022-12-19T17:03:24.737Z","parentDoc":"5d93709d85a9c8003168b7b5","isBodyEmpty":false,"children":[]},{"_id":"62c85bd7081a1103eeebd571","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Updating and Releasing A New CX App Version","type":"basic","slug":"updating-and-releasing-a-new-cx-app-version","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"updating-and-releasing-new-cx-app-versions","createdAt":"2022-07-08T16:31:19.568Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5d93709d85a9c8003168b7b5","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"5eaad818ec7e24004c0274e8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Configuration Examples","type":"basic","slug":"example-configuration-v2","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T08:58:19.515Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":null,"previousSlug":"","isBodyEmpty":false,"children":[{"_id":"6125576b4a2f1203c6886360","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"PayPal Inbound Example","type":"basic","slug":"paypal-inbound-example","order":0,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-24T20:32:43.349Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"618e8f6a6af859002a791ccf","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Typeform Inbound Example","type":"basic","slug":"typeform-inbound-example","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-11-12T15:59:38.320Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","isBodyEmpty":false,"children":[]},{"_id":"6125588300e7a9007eeadce6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Slack Outbound Example","type":"basic","slug":"slack-outbound-example","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-24T20:37:23.189Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"612559488029670016b24d0f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Zendesk Sell Outbound and Inbound Example","type":"basic","slug":"zendesk-sell-outbound-and-inbound-example","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-24T20:40:40.240Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"610038fb2de6d00071851b0a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Zendesk Support Custom Objects Example","type":"basic","slug":"zendesk-support-with-objects","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"zendesk-support-with-objects-fdd4e3e53d7","createdAt":"2021-07-27T16:48:59.727Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6182c15354dc5a00562255ef","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Historical Sync Inbound Example","type":"basic","slug":"historical-sync-inbound-example","order":5,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-11-03T17:05:23.042Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","isBodyEmpty":false,"children":[]},{"_id":"620d494e073ad8007af5d4fe","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Calendly Custom Objects Example","type":"basic","slug":"calendly-custom-objects-example","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-16T18:58:22.245Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","isBodyEmpty":false,"children":[]},{"_id":"6387b00a58fff504961fa7d9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Twillio SMS Outbound Example","icon":"","type":"basic","slug":"twillio-sms-outbound-example","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-11-30T19:33:30.931Z","parentDoc":"5eaad818ec7e24004c0274e8","category":"5d8b7ac425e74f031c7f1e5c","isBodyEmpty":false,"children":[]}]},{"_id":"5eab218698ac2e005d926e05","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Reference","type":"basic","slug":"configuration-specification-v2","order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T01:36:38.354Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"6406522b01f193000ae372fc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"What is a CX App?","icon":"","type":"basic","slug":"what-is-a-cx-app","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5d8b7ac425e74f031c7f1e5c","createdAt":"2023-03-06T20:50:51.428Z","parentDoc":"5eab218698ac2e005d926e05","isBodyEmpty":false,"children":[]},{"_id":"5db83e3e1e83780030825932","createdAt":"2019-10-29T13:27:26.494Z","category":"5d8b7ac425e74f031c7f1e5c","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":1,"slug":"glossary","type":"basic","title":"Glossary","parentDoc":"5eab218698ac2e005d926e05","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d9203143b45aa001e2f9c25","createdAt":"2019-09-30T13:28:52.860Z","category":"5d8b7ac425e74f031c7f1e5c","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":false,"order":2,"slug":"cx-app-lifecycle","type":"basic","title":"App Lifecycle","parentDoc":"5eab218698ac2e005d926e05","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5eab21b038aa0400185242d3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"auth Object","type":"basic","slug":"auth","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T18:40:11.519Z","parentDoc":"5eab218698ac2e005d926e05","category":"5d8b7ac425e74f031c7f1e5c","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5eab21c07cdb5701aba044fc","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"api Object","type":"basic","slug":"api","order":5,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T12:17:11.710Z","parentDoc":"5eab218698ac2e005d926e05","category":"5d8b7ac425e74f031c7f1e5c","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5eab21d95bc4260018e82d62","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"data_intake Array","type":"basic","slug":"data_intake","order":6,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T18:26:10.133Z","parentDoc":"5eab218698ac2e005d926e05","category":"5d8b7ac425e74f031c7f1e5c","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5eab21f0c8f6eb00610a5ad6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"workflows Array","type":"basic","slug":"workflows","order":7,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T01:36:10.580Z","parentDoc":"5eab218698ac2e005d926e05","category":"5d8b7ac425e74f031c7f1e5c","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"6129854806fca10044781b4d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"objects Array","type":"basic","slug":"custom-objects","order":8,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"objects-array","createdAt":"2021-08-28T00:37:28.445Z","parentDoc":"5eab218698ac2e005d926e05","category":"5d8b7ac425e74f031c7f1e5c","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5eab363e6e8352002a83117c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Commands, Variables, Properties","type":"basic","slug":"commands-1","order":9,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"createdAt":"2020-04-30T20:06:44.677Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"5eab218698ac2e005d926e05","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"612cee9b2e68e0004852ff95","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Latest Updates","type":"link","slug":"latest-updates","order":3,"isReference":false,"hidden":false,"sync_unique":"","link_url":"https://developers.activecampaign.com/changelog","link_external":false,"previousSlug":"","createdAt":"2021-08-30T14:43:39.828Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":null,"isBodyEmpty":true,"children":[]},{"_id":"612cf02c07ef3e00104d53a6","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Requests and Feedback","type":"basic","slug":"app-studio-feedback","order":4,"isReference":false,"hidden":false,"sync_unique":"","link_url":"https://ideas.activecampaign.com/","link_external":false,"previousSlug":"feedback","createdAt":"2021-08-30T14:50:20.742Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61fd901d71504000553b94f8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Quick Views","type":"basic","slug":"quick-views","order":6,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-04T20:44:13.931Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"61fd98c240c9c8005733139a","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 Quick Views","type":"basic","slug":"getting-started-with-quick-views","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-04T21:21:06.727Z","parentDoc":"61fd901d71504000553b94f8","category":"5d8b7ac425e74f031c7f1e5c","isBodyEmpty":false,"children":[]},{"_id":"62130e5e039b1f001c12d1d8","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Quick View Messaging System","type":"basic","slug":"quick-view-messaging-system","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-21T04:00:30.371Z","parentDoc":"61fd901d71504000553b94f8","category":"5d8b7ac425e74f031c7f1e5c","icon":"","isBodyEmpty":false,"children":[]},{"_id":"62167d090bc6de002ea5bd1f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Quick View Example","type":"basic","slug":"quick-view-example","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-23T18:29:29.389Z","parentDoc":"61fd901d71504000553b94f8","category":"5d8b7ac425e74f031c7f1e5c","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"6449786826f68400e9aacfa6","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Tutorials","icon":"","type":"basic","slug":"tutorials","order":7,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"5d8b7ac425e74f031c7f1e5c","createdAt":"2023-04-26T19:15:52.675Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"616ed4f85535ce03a12b8c7f","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Node.js: Create and Test Your First App using Pipedream","type":"basic","slug":"node-create-and-test-app-using-pipedream","order":0,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-and-test-app-using-pipedream","createdAt":"2021-10-19T14:23:52.672Z","category":"5d8b7ac425e74f031c7f1e5c","parentDoc":"6449786826f68400e9aacfa6","icon":"","isBodyEmpty":false,"children":[]},{"_id":"64482cd5f1cac80065b28bd2","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Create Your First App using Pipedream and Python: Part 1","icon":"","type":"basic","slug":"python-create-and-test-your-first-app-using-pipedream","order":1,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"nodejs-create-and-test-your-first-app-using-pipedream-copy","parentDoc":"6449786826f68400e9aacfa6","category":"5d8b7ac425e74f031c7f1e5c","createdAt":"2023-04-25T19:41:09.941Z","isBodyEmpty":false,"children":[]},{"_id":"64497d94bdbdda00e1b3cedd","api":{"method":"get","url":"","auth":"required","params":[],"examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]}},"title":"Create Your First App- Part 2: Custom Objects","icon":"","type":"basic","slug":"using-custom-objects-in-your-cx-app","order":2,"isReference":false,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6449786826f68400e9aacfa6","category":"5d8b7ac425e74f031c7f1e5c","createdAt":"2023-04-26T19:37:56.300Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"60d0a822312198006373ede4","title":"API","slug":"api-guides","order":3,"reference":false,"isAPI":false,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2021-06-21T14:54:26.767Z","__v":0,"pages":[{"_id":"613a762f780479001c49fa08","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"What are Custom Objects?","type":"basic","slug":"custom-objects-explained","order":1,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-objects-api","createdAt":"2021-09-09T21:01:35.033Z","category":"60d0a822312198006373ede4","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]}],"refs":[{"_id":"58b49200d373740f008f6037","project":"57b6f40e480bae1900ce4e21","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2017-02-27T20:54:24.181Z","order":1,"slug":"introduction","version":"57b6f40e480bae1900ce4e24","from_sync":false,"title":"Getting Started","__v":0,"pages":[{"_id":"591f0b5a6daf422700a7846e","createdAt":"2017-05-19T15:12:26.326Z","parentDoc":null,"category":"58b49200d373740f008f6037","link_external":false,"slug":"overview","hidden":false,"title":"Overview","type":"basic","api":{"url":"","method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[]},"isReference":true,"link_url":"","order":0,"sync_unique":"","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58b49350553f8b0f008b6092","category":"58b49200d373740f008f6037","slug":"authentication","type":"basic","parentDoc":null,"title":"Authentication","api":{"settings":"","url":"","auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"examples":{"codes":[]}},"hidden":false,"link_external":false,"order":1,"isReference":true,"sync_unique":"","createdAt":"2017-02-27T21:00:00.374Z","link_url":"","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58b5ef0ae31a610f003a59d1","slug":"url","isReference":true,"link_url":"","parentDoc":null,"sync_unique":"","category":"58b49200d373740f008f6037","hidden":false,"order":2,"type":"basic","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get","examples":{"codes":[]}},"createdAt":"2017-02-28T21:43:38.053Z","link_external":false,"title":"Base URL","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"6129910bc5c8d900785fca96","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Change Log","type":"link","slug":"change-log","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"https://developers.activecampaign.com/changelog","link_external":false,"previousSlug":"","createdAt":"2021-08-28T01:27:39.787Z","category":"58b49200d373740f008f6037","parentDoc":null,"isBodyEmpty":true,"children":[]},{"_id":"58b49369553f8b0f008b609a","order":4,"title":"Errors","category":"58b49200d373740f008f6037","link_url":"","api":{"apiSetting":null,"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get"},"hidden":false,"isReference":true,"link_external":false,"parentDoc":null,"slug":"errors","createdAt":"2017-02-27T21:00:25.990Z","sync_unique":"","type":"basic","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"591f12cea4747419000f7e7a","link_url":"","api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"category":"58b49200d373740f008f6037","createdAt":"2017-05-19T15:44:14.885Z","link_external":false,"order":5,"slug":"http-methods","title":"HTTP Methods","type":"basic","isReference":true,"parentDoc":null,"sync_unique":"","hidden":false,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b4935cc0cb030f0067f831","slug":"pagination","hidden":false,"parentDoc":null,"category":"58b49200d373740f008f6037","link_external":false,"link_url":"","sync_unique":"","createdAt":"2017-02-27T21:00:12.583Z","order":6,"title":"Pagination, Ordering, and Filtering","type":"basic","api":{"method":"get","params":[],"results":{"codes":[{"code":"{}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","examples":{"codes":[]}},"isReference":true,"deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5c37be075e700841aaa3192e","category":"58b49200d373740f008f6037","createdAt":"2019-01-10T21:49:59.125Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":7,"slug":"rate-limits","type":"basic","title":"Rate Limits","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"58b4937ec0cb030f0067f832","category":"58b49200d373740f008f6037","order":8,"sync_unique":"","title":"Schema","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"type":"basic","hidden":false,"link_url":"","parentDoc":null,"isReference":true,"createdAt":"2017-02-27T21:00:46.678Z","link_external":false,"slug":"schema","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"620fe9fada51130230b39343","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Side Loading","type":"basic","slug":"sideloading","order":9,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-02-18T18:48:26.170Z","category":"58b49200d373740f008f6037","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"618ec0c99da17b01477d5539","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Tips","type":"basic","slug":"tips","order":10,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"guidance","createdAt":"2021-11-12T19:30:17.991Z","category":"58b49200d373740f008f6037","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"612cf3c81cc422003e957db7","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Requests and Feedback","type":"link","slug":"requests-and-feedback","order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"https://developers.activecampaign.com/docs/app-studio-feedback","link_external":false,"previousSlug":"","createdAt":"2021-08-30T15:05:44.645Z","category":"58b49200d373740f008f6037","parentDoc":null,"isBodyEmpty":true,"children":[]}]},{"_id":"63f53fee77575500513a73e4","title":"API Guides","slug":"guides","order":2,"reference":true,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2023-02-21T22:04:30.626Z","__v":0,"pages":[{"_id":"63efb73209a35c00ef9cc54c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Contact Custom Objects API Guide","icon":"","type":"basic","slug":"custom-objects-with-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-objects-api-guide-1","category":"63f53fee77575500513a73e4","createdAt":"2023-02-17T17:19:46.297Z","parentDoc":null,"isBodyEmpty":false,"children":[]},{"_id":"62aa04aa1dc77b086caef5a3","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Contact Custom Fields API Guide","type":"basic","slug":"contact-custom-fields-api-guide","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-field-api-guide","createdAt":"2022-06-15T16:11:22.689Z","category":"63f53fee77575500513a73e4","parentDoc":null,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"63f540bdb841aa001eb24fbe","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Contact Event Tracking API Guide","icon":"","type":"basic","slug":"contact-event-tracking-api-guide","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"contact-events-api-guide","category":"63f53fee77575500513a73e4","createdAt":"2023-02-21T22:07:57.009Z","parentDoc":null,"isBodyEmpty":false,"children":[]}]},{"_id":"5cdc690b0c875a00398c2f28","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2019-05-15T19:31:23.219Z","order":3,"slug":"accoutns","title":"Accounts","__v":0,"pages":[{"_id":"5cdc693d2900c4001ea48513","createdAt":"2019-05-15T19:32:13.351Z","category":"5cdc690b0c875a00398c2f28","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"accounts","type":"basic","title":"Accounts","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5f3c96921f2da100609710a4","api":{"method":"post","url":"/accounts","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","results":{"codes":[{"language":"json","status":201,"name":"","code":"{\n \"account\": {\n \"name\": \"Example Account\",\n \"accountUrl\": \"https://www.example.com\",\n \"createdTimestamp\": \"2019-06-12T16:52:16-05:00\",\n \"updatedTimestamp\": \"2019-06-12T16:52:16-05:00\",\n \"links\": [],\n \"fields\": [\n {\n \"customFieldId\": 9,\n \"fieldValue\": \"501 - 1000\",\n \"accountId\": \"1\"\n },\n {\n \"customFieldId\": 20,\n \"fieldValue\": 1234,\n \t\t\t\t\"fieldCurrency\": \"GBP\",\n \"accountId\": \"1\"\n }\n ],\n \"id\": \"1\"\n }\n}"},{"name":"Missing Data","code":"{\n \"errors\": [\n {\n \"title\": \"The account name was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"source\": {\n \"pointer\": \"/data/attributes/name\"\n }\n }\n ]\n}","language":"json","status":422},{"name":"Alredy Existing","status":422,"language":"text","code":"{\n \"errors\": [\n {\n \"title\": \"An account named \\\"Example Account\\\" already exists. Please choose a new name.\",\n \"detail\": \"\",\n \"code\": \"duplicate\",\n \"source\": {\n \"pointer\": \"/data/attributes/name\"\n }\n }\n ]\n}"}]},"examples":{"codes":[{"code":"{\n \"account\": {\n \"name\": \"Example Account\",\n \"accountUrl\": \"https://www.example.com\",\n \"owner\": 1, \n \"fields\": [\n {\n \"customFieldId\": 9,\n \"fieldValue\": \"500-1000\"\n },\n {\n \"customFieldId\": 20,\n \"fieldValue\": 1234,\n \"fieldCurrency\": \"GBP\"\n }\n ]\n }\n}","language":"json"}]},"params":[{"name":"account.name","type":"string","enumValues":"","default":"","desc":"Account's name","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"account.accountUrl","type":"string","enumValues":"","default":"","desc":"Account's website","required":false,"in":"body","ref":"","_id":"5ba324146048990003fb6ef9"},{"name":"account.owner","type":"int","enumValues":"","default":"1","desc":"The userId of the account owner.","required":false,"in":"body","ref":"","_id":"624de572d64b1300755c01e6"},{"name":"account.fields","type":"array_object","enumValues":"","default":"","desc":"Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`","required":false,"in":"body","ref":"CustomFieldData","_id":"5f3c97b7cbd250022a2e5e2c"}]},"title":"Create an account","type":"endpoint","slug":"create-an-account-new","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5cdc693d2900c4001ea48513","createdAt":"2020-08-19T03:03:46.536Z","category":"5cdc690b0c875a00398c2f28","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5f3c9bc124a5520422058c5a","api":{"method":"put","url":"/accounts/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","results":{"codes":[{"status":200,"language":"json","code":"{\n \"account\": {\n \"name\": \"Exmaple Account\",\n \"accountUrl\": \"https://www.example.com\",\n \"createdTimestamp\": \"2019-04-03T13:57:31-05:00\",\n \"updatedTimestamp\": \"2019-06-12T16:55:32-05:00\",\n \"links\": [],\n \"fields\": [\n {\n \"customFieldId\": 9,\n \"fieldValue\": \"501 - 1000\",\n \"accountId\": \"1\"\n },\n {\n \"customFieldId\": 20,\n \"fieldValue\": 1234,\n \t\"fieldCurrency\": \"GBP\",\n \"accountId\": \"1\"\n }\n ],\n \"id\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[{"code":"{\n \"account\": {\n \"name\": \"Exmaple Account\",\n \"accountUrl\": \"https://www.example.com\",\n \"fields\": [\n {\n \"customFieldId\": 9,\n \"fieldValue\": \"500-1000\"\n },\n {\n \"customFieldId\": 20,\n \"fieldValue\": 1234,\n \"fieldCurrency\": \"GBP\"\n }\n ]\n }\n}","language":"json"}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Account's id","required":false,"in":"path","ref":"","_id":"58b603b300eb000f000cad7f"},{"name":"account.name","type":"string","enumValues":"","default":"","desc":"Account's name","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9d"},{"name":"account.accountUrl","type":"string","enumValues":"","default":"","desc":"Account's website","required":false,"in":"body","ref":"","_id":"5ba323b56048990003fb6ef7"},{"name":"account.fields","type":"array_object","enumValues":"","default":"","desc":"Account's custom field values `{customFieldId: int, fieldValue: string, fieldCurrency?:string}[]`","required":false,"in":"body","ref":"CustomFieldData","_id":"5f3c9bc124a5520422058c5b"},{"name":"account.owner","type":"int","enumValues":"","default":"1","desc":"The userId of the Account owner.","required":false,"in":"body","ref":"","_id":"624de5e8065b6c003d5d0e78"}]},"title":"Update an account","type":"endpoint","slug":"update-an-account-new","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5cdc693d2900c4001ea48513","createdAt":"2020-08-19T03:25:53.473Z","category":"5cdc690b0c875a00398c2f28","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5cdc6a1d8921de00139e83a6","createdAt":"2019-05-15T19:35:57.454Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"language":"json","code":"{\n \"account\": {\n \"name\": \"Example Account\",\n \"accountUrl\": \"https://www.example.com\",\n \"createdTimestamp\": \"2019-05-15T15:58:16-05:00\",\n \"updatedTimestamp\": \"2019-05-15T15:58:16-05:00\",\n \"links\": [],\n \"id\": \"1\"\n }\n}","name":"","status":200}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Account's ID","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/accounts/:id","method":"get"},"isReference":true,"order":2,"slug":"retrieve-an-account","type":"endpoint","title":"Retrieve an account","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6ae6e775a0004b2d61dd","createdAt":"2019-05-15T19:39:18.527Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"code":"{}","name":"","status":400,"language":"json"}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"58b603ca3c785d0f00b74ec3","ref":"","in":"path","required":false,"desc":"Account's id","default":"","type":"int","name":"id"}],"url":"/accounts/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-an-account","type":"endpoint","title":"Delete an account","isBodyEmpty":true,"children":[]},{"_id":"5cdc6a03fcc551001970250e","createdAt":"2019-05-15T19:35:31.341Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"accounts\": [\n {\n \"name\": \"First Example Account\",\n \"accountUrl\": null,\n \"createdTimestamp\": \"2019-04-29T07:51:31-05:00\",\n \"updatedTimestamp\": \"2019-04-29T07:51:31-05:00\",\n \"contactCount\": \"1\",\n \"dealCount\": \"3\",\n \"links\": [\n \"notes\": \"https://:account.api-us1.com/api/:version/accounts/1/notes\",\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accounts/1/accountCustomFieldData\",\n \"accountContacts\": \"https://:account.api-us1.com/api/:version/accounts/1/accountContacts\"],\n \"id\": \"1\"\n },\n {\n \"name\": \"Second Example Account\",\n \"accountUrl\": null,\n \"createdTimestamp\": \"2019-04-29T07:51:32-05:00\",\n \"updatedTimestamp\": \"2019-04-29T07:51:32-05:00\",\n \"contactCount\": \"2\",\n \"dealCount\": \"5\",\n \"links\": [\n \"notes\": \"https://:account.api-us1.com/api/:version/accounts/2/notes\",\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accounts/2/accountCustomFieldData\",\n \"accountContacts\": \"https://:account.api-us1.com/api/:version/accounts/2/accountContacts\"],\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"search","type":"string","enumValues":"","default":"","desc":"Search by name","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f60"},{"name":"count_deals","type":"boolean","enumValues":"","default":"","desc":"Whether to compute the contactCount and dealCount counts for the number of contacts/deals associated with each account. Set it to true to include the right counts. If set to false or omitted from the call, then contactCount and dealCount will not be counted and be simply displayed as 0.","required":false,"in":"query","ref":"","_id":"5ef64a0f200733005ab8fb40"}],"url":"/accounts","method":"get"},"isReference":true,"order":4,"slug":"list-all-accounts","type":"endpoint","title":"List all accounts","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5ce80675ada92300516d89b9","createdAt":"2019-05-24T14:57:57.417Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n \"note\": {\n \"note\": \"Note for the account\"\n }\n}","language":"json"}]},"results":{"codes":[{"code":"{\n \"accounts\": [\n {\n \"name\": \"Museuem of Science and Industry\",\n \"accountUrl\": \"www.msi.com\",\n \"createdTimestamp\": \"2019-04-03T13:29:35-05:00\",\n \"updatedTimestamp\": \"2019-06-12T16:59:54-05:00\",\n \"id\": \"1\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-05-31T09:54:30-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-05-31T09:54:30-05:00\",\n \"note\": \"Note for the account\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"account\"\n },\n \"relid\": \"1\",\n \"reltype\": \"CustomerAccount\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}","name":"","status":201,"language":"json"}]},"auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"Account note's content","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Account's id to assign new note to","required":false,"in":"path","ref":"","_id":"592ed91e05a05e0027ce9645"}],"url":"/accounts/:id/notes","method":"post"},"isReference":true,"order":5,"slug":"create-an-account-note","type":"endpoint","title":"Create an account note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5ce82e7754f4e30014957364","createdAt":"2019-05-24T17:48:39.021Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n \"accounts\": [\n {\n \"name\": \"Example Account\",\n \"accountUrl\": \"https://www.example.url\",\n \"createdTimestamp\": \"2019-04-03T13:29:35-05:00\",\n \"updatedTimestamp\": \"2019-06-12T16:59:54-05:00\",\n \"links\": {\n \"notes\": \"https://hosted.localdev/api/3/accounts/1/notes\"\n },\n \"id\": \"1\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-06-01T13:42:13-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-06-01T13:42:13-05:00\",\n \"note\": \"Update with more info\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"account\"\n },\n \"relid\": \"1\",\n \"reltype\": \"CustomerAccount\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}\n"}]},"examples":{"codes":[{"language":"json","code":"{\n \"note\": {\n \"note\": \"Update with more info\"\n }\n}"}]},"auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"Account note's content","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Account's id to assign new note to","required":false,"in":"path","ref":"","_id":"592ed91e05a05e0027ce9645"},{"name":"noteid","type":"string","enumValues":"","default":"","desc":"Account note's id to update","required":false,"in":"path","ref":"","_id":"592eda8c1cd2c400257eeddd"}],"url":"/accounts/:id/notes/:noteid","method":"put"},"isReference":true,"order":6,"slug":"update-a-account-note","type":"endpoint","title":"Update an account note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d014007833b1d004269015d","createdAt":"2019-06-12T18:10:15.812Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc693d2900c4001ea48513","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"code":"{\n \"meta\": {\n \"success\": true\n }\n}","language":"json","status":200,"name":""},{"language":"json","status":400,"name":"","code":"{}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"[]ids","type":"int","enumValues":"","default":"","desc":"An integer id of the account to be deleted","required":false,"in":"query","ref":"","_id":"645562d3cd43ab1d79d5c5d8"}],"url":"/accounts/bulk_delete","method":"delete"},"isReference":true,"order":7,"slug":"bulk-delete-accounts","type":"endpoint","title":"Bulk delete accounts","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5d13914f1f45930039aa27e0","createdAt":"2019-06-26T15:37:51.221Z","category":"5cdc690b0c875a00398c2f28","parentDoc":null,"link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":1,"slug":"account-contacts","type":"basic","title":"Account Contact Association","isBodyEmpty":true,"children":[{"_id":"5d1393590b5d8b006dae14a9","createdAt":"2019-06-26T15:46:33.359Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5d13914f1f45930039aa27e0","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"accountContact\": {\n\t\t\"contact\": 2,\n\t\t\"account\": 1,\n\t\t\"jobTitle\": \"Product Manager\"\n\t}\n}\n"}]},"results":{"codes":[{"language":"json","status":201,"name":"","code":"{\n \"accountContact\": {\n \"account\": 2,\n \"contact\": 1,\n \"jobTitle\": \"Product Manager\",\n \"createdTimestamp\": \"2019-06-26T10:49:10-05:00\",\n \"updatedTimestamp\": \"2019-06-26T10:49:10-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/2/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/1/contact\"\n },\n \"id\": \"1\"\n }\n}"},{"name":"Missing Data","code":"{\n \"errors\": [\n {\n \"title\": \"The account attribute was not provided\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"source\": {\n \"pointer\": \"/data/attributes/account\"\n }\n }\n ]\n}","language":"json","status":422},{"name":"Alredy Existing","status":422,"language":"text","code":"{\n \"errors\": [\n {\n \"title\": \"This contact is already associated with an account. We currently do not support contacts on multiple accounts.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"source\": {\n \"pointer\": \"/data/attributes/account,contact\"\n }\n }\n ]\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"accountContact.account","type":"int","enumValues":"","default":"","desc":"Account ID","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"accountContact.contact","type":"int","enumValues":"","default":"","desc":"Contact ID","required":true,"in":"body","ref":"","_id":"5ba324146048990003fb6ef9"},{"name":"accountContact.jobTitle","type":"string","enumValues":"","default":"","desc":"Job Title of the contact at the account","required":false,"in":"body","ref":"","_id":"5d1393edd8a86a03e55d3939"}],"url":"/accountContacts","method":"post"},"isReference":true,"order":0,"slug":"create-an-account-1","type":"endpoint","title":"Create an association","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d139525d89cd000182b0d53","createdAt":"2019-06-26T15:54:13.099Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5d13914f1f45930039aa27e0","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","code":"{\n \"accountContact\": {\n \"account\": \"2\",\n \"contact\": \"1\",\n \"jobTitle\": \"Product Manager\",\n \"createdTimestamp\": \"2019-06-26T11:26:09-05:00\",\n \"updatedTimestamp\": \"2019-06-26T11:26:09-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/18/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/18/contact\"\n },\n \"id\": \"18\"\n },\n \"meta\": {\n \"queryLog\": {\n \"queries\": [\n {\n \"stmt\": \"SELECT * FROM em_customer_account_subscriber t WHERE 1 AND id = '18' LIMIT 0, 1\",\n \"time\": 0.31304359436035\n }\n ],\n \"by_time\": [\n {\n \"stmt\": \"SELECT * FROM em_customer_account_subscriber t WHERE 1 AND id = '18' LIMIT 0, 1\",\n \"time\": 0.31304359436035\n }\n ],\n \"total\": 0.31304359436035,\n \"mode\": \"read/write\"\n }\n }\n}","name":"","status":200},{"status":404,"language":"text","code":"{\n \"message\": \"No Result found for CustomerAccountSubscriber with id 100\"\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Association's ID","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/accountContacts/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-an-association","type":"endpoint","title":"Retrieve an association","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d139541f5900c0370e7db3a","createdAt":"2019-06-26T15:54:41.455Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5d13914f1f45930039aa27e0","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n\t\"accountContact\": {\n\t\t\"jobTitle\": \"Product Manager\"\n\t}\n}\n"}]},"results":{"codes":[{"name":"","code":"{\n \"accountContact\": {\n \"account\": \"3\",\n \"contact\": \"2\",\n \"jobTitle\": \"CEO\",\n \"createdTimestamp\": \"2019-06-26T11:26:15-05:00\",\n \"updatedTimestamp\": \"2019-06-26T11:29:57-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/19/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/19/contact\"\n },\n \"id\": \"19\"\n }\n}","language":"json","status":200}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Association's ID","required":false,"in":"path","ref":"","_id":"58b603b300eb000f000cad7f"},{"name":"accountContact.account","type":"int","enumValues":"","default":"","desc":"Account ID","required":true,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9d"},{"name":"accountContact.contact","type":"int","enumValues":"","default":"","desc":"Contact ID","required":true,"in":"body","ref":"","_id":"5ba323b56048990003fb6ef7"},{"name":"accountContact.jobTitle","type":"string","enumValues":"","default":"","desc":"Job Title of the contact at the account","required":false,"in":"body","ref":"","_id":"5d139d4fd89cd000182b0e22"}],"url":"/accountContacts/:id","method":"put"},"isReference":true,"order":2,"slug":"update-an-association-1","type":"endpoint","title":"Update an association","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d1395561f45930039aa283b","createdAt":"2019-06-26T15:55:02.258Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5d13914f1f45930039aa27e0","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"code":"{}","language":"json","status":200,"name":""},{"language":"json","status":404,"name":"","code":"{\n \"message\": \"No Result found for CustomerAccountSubscriber with id 100\"\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"_id":"58b603ca3c785d0f00b74ec3","ref":"","in":"path","required":false,"desc":"Association's ID","default":"","type":"int","name":"id"}],"url":"/accountContacts/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-an-association-1","type":"endpoint","title":"Delete an association","isBodyEmpty":true,"children":[]},{"_id":"5d13956b42e9ee0014cc5875","createdAt":"2019-06-26T15:55:23.875Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5d13914f1f45930039aa27e0","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"accountContacts\": [\n {\n \"account\": \"2\",\n \"contact\": \"3\",\n \"jobTitle\": \"Product Manager\",\n \"createdTimestamp\": \"2019-06-26T10:49:10-05:00\",\n \"updatedTimestamp\": \"2019-06-26T10:49:10-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/17/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/17/contact\"\n },\n \"id\": \"17\"\n },\n {\n \"account\": \"2\",\n \"contact\": \"1\",\n \"jobTitle\": \"Product Manager\",\n \"createdTimestamp\": \"2019-06-26T11:26:09-05:00\",\n \"updatedTimestamp\": \"2019-06-26T11:26:09-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/18/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/18/contact\"\n },\n \"id\": \"18\"\n },\n {\n \"account\": \"3\",\n \"contact\": \"2\",\n \"jobTitle\": \"Product Manager\",\n \"createdTimestamp\": \"2019-06-26T11:26:15-05:00\",\n \"updatedTimestamp\": \"2019-06-26T11:26:15-05:00\",\n \"links\": {\n \"account\": \"http://hosted.localdev/api/3/accountContacts/19/account\",\n \"contact\": \"http://hosted.localdev/api/3/accountContacts/19/contact\"\n },\n \"id\": \"19\"\n }\n ],\n \"meta\": {\n \"total\": \"3\",\n \"queryLog\": {\n \"queries\": [\n {\n \"stmt\": \"SELECT COUNT(DISTINCT t.id) AS `__count` FROM em_customer_account_subscriber t WHERE 1\",\n \"time\": 0.3669261932373\n },\n {\n \"stmt\": \"SELECT t.* FROM em_customer_account_subscriber t WHERE 1 LIMIT 0, 20\",\n \"time\": 0.17809867858887\n }\n ],\n \"by_time\": [\n {\n \"stmt\": \"SELECT COUNT(DISTINCT t.id) AS `__count` FROM em_customer_account_subscriber t WHERE 1\",\n \"time\": 0.3669261932373\n },\n {\n \"stmt\": \"SELECT t.* FROM em_customer_account_subscriber t WHERE 1 LIMIT 0, 20\",\n \"time\": 0.17809867858887\n }\n ],\n \"total\": 0.54502487182617,\n \"mode\": \"read/write\"\n }\n }\n}","language":"json","status":200}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"filters[contact]","type":"int","enumValues":"","default":"","desc":"Filter by Contact ID","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f60"},{"name":"filters[account]","type":"int","enumValues":"","default":"","desc":"Filter by Account ID","required":false,"in":"query","ref":"","_id":"5d139c85beacbc004dbfb373"}],"url":"/accountContacts","method":"get"},"isReference":true,"order":4,"slug":"list-all-associations-1","type":"endpoint","title":"List all associations","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"5cdc694dd065af006214017f","createdAt":"2019-05-15T19:32:29.394Z","category":"5cdc690b0c875a00398c2f28","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":2,"slug":"custom-account-fields-1","type":"basic","title":"Custom Account Fields","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5cdc7088d065af0062140323","createdAt":"2019-05-15T20:03:20.218Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc694dd065af006214017f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"name":"text","code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample text field2\",\n\t\t\"fieldType\": \"text\",\n\t\t\"fieldDefault\": \"Default Text\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 1\n\t}\n}","language":"json"},{"name":"textarea","language":"json","code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample textarea field\",\n\t\t\"fieldType\": \"textarea\",\n\t\t\"fieldDefault\": \"Default Text in Text Area\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 2\n\t}\n}"},{"name":"date (ISO ONLY)","language":"json","code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample date field\",\n\t\t\"fieldType\": \"date\",\n\t\t\"fieldDefault\": \"2018-12-31 00:00:00\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 3\n\t}\n}"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample dropdown field\",\n\t\t\"fieldType\": \"dropdown\",\n\t\t\"fieldDefault\": \"option 2\",\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 4\n\t}\n}","language":"json","name":"dropdown"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample multiselect field\",\n\t\t\"fieldType\": \"multiselect\",\n\t\t\"fieldDefault\": [\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 5\n\t}\n}","language":"json","name":"multiselect"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample radio field\",\n\t\t\"fieldType\": \"radio\",\n\t\t\"fieldDefault\": \"option 2\",\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 6\n\t}\n}","language":"json","name":"radio"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample checkbox field\",\n\t\t\"fieldType\": \"checkbox\",\n\t\t\"fieldDefault\": [\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 7\n\t}\n}","language":"json","name":"checkbox"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample hidden field\",\n\t\t\"fieldType\": \"hidden\",\n\t\t\"fieldDefault\": \"Default Text in Hidden Field\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 8\n\t}\n}","language":"json","name":"hidden"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample number field\",\n\t\t\"fieldType\": \"number\",\n\t\t\"fieldDefault\": \"100.99\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 9\n\t}\n}","language":"json","name":"number"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample money field\",\n\t\t\"fieldType\": \"currency\",\n\t\t\"fieldDefault\": \"10099\",\n\t\t\"fieldDefaultCurrency\": \"aud\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 10\n\t}\n}","language":"json","name":"currency"},{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample datetime field\",\n\t\t\"fieldType\": \"datetime\",\n\t\t\"fieldDefault\": \"2020-05-16T03:15:00-05:00\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 3\n\t}\n}","language":"json","name":"datetime"}]},"results":{"codes":[{"code":"{\n \"accountCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 19:57:37\",\n \"links\": {\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/3/accountCustomFieldMeta/1/accountCustomFieldData\"\n }\n }\n}","language":"json","status":200},{"code":"{\n\t\"errors\": [\n \t\"title\": \"The field type field is required.\",\n \"detail\": \"\",\n \"code\": 422\n ]\n}","language":"json","status":422}]},"auth":"required","params":[{"name":"accountCustomFieldMetum.fieldLabel","type":"string","enumValues":"","default":"","desc":"Name of the field","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"accountCustomFieldMetum.fieldType","type":"string","enumValues":"","default":"","desc":"Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`.","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ec"},{"name":"accountCustomFieldMetum.fieldOptions","type":"array_string","enumValues":"","default":"","desc":"Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`.","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"accountCustomFieldMetum.fieldDefault","type":"string","enumValues":"","default":"","desc":"Default value of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ea"},{"name":"accountCustomFieldMetum.fieldDefaultCurrency","type":"string","enumValues":"","default":"","desc":"The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`.","required":false,"in":"body","ref":"","_id":"5c8004ef2e306c020a0486d7"},{"name":"accountCustomFieldMetum.isFormVisible","type":"boolean","enumValues":"","default":"","desc":"Whether or not the field is visible on forms","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e9"},{"name":"accountCustomFieldMetum.displayOrder","type":"int","enumValues":"","default":"","desc":"Order for displaying the field on Manage Fields page and deal profiles","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e7"}],"url":"/accountCustomFieldMeta","method":"post"},"isReference":true,"order":0,"slug":"create-a-customfieldmeta","type":"endpoint","title":"Create a custom field","previousSlug":"create-a-custom-field","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6b99b34d4a00245eb6da","createdAt":"2019-05-15T19:42:17.090Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc694dd065af006214017f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"},{"status":200,"language":"json","code":"{\n \"accountCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData\"\n }\n }\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field to retrieve","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/accountCustomFieldMeta/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-custom-field-meta","type":"endpoint","title":"Retrieve a custom field","deprecated":false,"previousSlug":"retrieve-a-custom-field","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6ba988f1aa001e36521d","createdAt":"2019-05-15T19:42:33.662Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc694dd065af006214017f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"accountCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData\"\n }\n }\n}"},{"code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}","language":"json","status":404}]},"examples":{"codes":[{"code":"{\t\n\t\"accountCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"New Title\",\n\t\t\"fieldDefault\": \"Default Text\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 1\n\t}\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the custom field to update","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"},{"name":"accountCustomFieldMetum.fieldLabel","type":"string","enumValues":"","default":"","desc":"Name of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"accountCustomFieldMetum.fieldOptions","type":"array_string","enumValues":"","default":"","desc":"Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox.","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"accountCustomFieldMetum.fieldDefault","type":"string","enumValues":"","default":"","desc":"Default value of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ea"},{"name":"accountCustomFieldMetum.isFormVisible","type":"boolean","enumValues":"","default":"","desc":"Whether or not the field is visible on forms","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e9"},{"name":"accountCustomFieldMetum.displayOrder","type":"int","enumValues":"","default":"","desc":"Order for displaying the field on Manage Fields page and deal profiles","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e7"}],"url":"/accountCustomFieldMeta/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-custom-field","type":"endpoint","title":"Update a custom field","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5cdc6bb98921de00139e8402","createdAt":"2019-05-15T19:42:49.234Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc694dd065af006214017f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"AccountCustomFieldMeta deleted.\"\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"auth":"required","params":[{"_id":"58b5f08ce31a610f003a5a17","ref":"","in":"path","required":false,"desc":"ID of the field to delete","default":"","type":"int","name":"id"}],"url":"/accountCustomFieldMeta/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-custom-field","type":"endpoint","title":"Delete a custom field","isBodyEmpty":false,"children":[]},{"_id":"5cdc6bc9e607e5000ebdfa1a","createdAt":"2019-05-15T19:43:05.782Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc694dd065af006214017f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n \"accountCustomFieldMeta\": [\n {\n \"id\": \"1\",\n \"fieldLabel\": \"Text Example\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData\"\n }\n },\n {\n \"id\": \"2\",\n \"fieldLabel\": \"Multiple Choice Example\",\n \"fieldType\": \"multiselect\",\n \"fieldOptions\": [\n \t\"Option 1\",\n \t\"Option 2\",\n \t\"Option 3\"\n ],\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 2,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"accountCustomFieldData\": \"https://:account.api-us1.com/api/:version/accountCustomFieldMeta/1/accountCustomFieldData\"\n }\n }\n ]\n}","language":"json","status":200}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"limit","type":"int","enumValues":"","default":"100","desc":"The number of fields returned per request.","required":false,"in":"query","ref":"","_id":"5fdc03c5ebffa80026d721be"}],"url":"/accountCustomFieldMeta","method":"get"},"isReference":true,"order":4,"slug":"list-all-custom-fields-meta","type":"endpoint","title":"List all custom fields","previousSlug":"list-all-custom-fields","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"5cdc696723748800eb581373","createdAt":"2019-05-15T19:32:55.601Z","category":"5cdc690b0c875a00398c2f28","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":3,"slug":"custom-account-field-values","type":"basic","title":"Custom Account Field Values","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5cdc6bddebc91100f245acf9","createdAt":"2019-05-15T19:43:25.132Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"code":"{\n \"accountCustomFieldDatum\": {\n \"id\": \"5\",\n \"accountCustomFieldMetumId\": 1,\n \"accountId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/5/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/5/accountCustomFieldMetum\"\n }\n }\n}","language":"json","status":200}]},"examples":{"codes":[{"name":"text/textarea/hidden","language":"json","code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"accountId\": \"2\",\n\t\t\"customFieldId\": \"1\",\n\t\t\"fieldValue\": \"test title\"\n\t}\n}\n"},{"name":"dropdown/radio","language":"json","code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"2\",\n\t\t\"customFieldId\": \"2\",\n\t\t\"fieldValue\": \"||option 1||option 2||option 3||\"\n\t}\n}"},{"name":"mutliple multiselects/checkboxes","language":"json","code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"2\",\n\t\t\"customFieldId\": \"3\",\n\t\t\"fieldValue\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 3\",\n\t\t\t\"option 4\"\n\t\t]\n\t}\n}"},{"name":"currency","language":"json","code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"1\",\n\t\t\"customFieldId\": \"4\",\n\t\t\"fieldValue\": 9999,\n\t\t\"fieldCurrency\": \"cad\"\n\t}\n}"},{"code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"1\",\n\t\t\"customFieldId\": \"5\",\n\t\t\"fieldValue\": \"100.99\"\n\t}\n}","language":"json","name":"number"},{"name":"date","language":"json","code":"// Allowed date formats are: YYYY-MM-DD, YYYY/MM/DD, or MM/DD/YYYY\n{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"1\",\n\t\t\"customFieldId\": \"6\",\n\t\t\"fieldValue\": \"2018-12-31\"\n\t}\n}"},{"code":"// Allowed datetime format is ISO only\n{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"1\",\n\t\t\"customFieldId\": \"14\",\n\t\t\"fieldValue\": \"2020-05-19T02:45:00-05:00\"\n\t}\n}\n","language":"json","name":"datetime"},{"code":"{\n\t\"accountCustomFieldDatum\": {\n\t\t\"customerAccountId\": \"2\",\n\t\t\"customFieldId\": \"3\",\n\t\t\"fieldValue\": [\n\t\t\t\"option 1\",\n \"option 2\",\n \"option 3\"\n\t\t]\n\t}\n}","language":"json","name":"single multiselect/checkbox"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"accountCustomFieldDatum.customerAccountId","type":"int","enumValues":"","default":"","desc":"The ID of the account this field value relates to","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"accountCustomFieldDatum.customFieldId","type":"int","enumValues":"","default":"","desc":"The ID of the custom field metum this field value relates to","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ec"},{"name":"accountCustomFieldDatum.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"accountCustomFieldDatum.fieldCurrency","type":"string","enumValues":"","default":"Default Currency for Field","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5c80244e3b18a4005789e164"}],"url":"/accountCustomFieldData","method":"post"},"isReference":true,"order":0,"slug":"create-a-custom-field-value","type":"endpoint","title":"Create a custom field value","deprecated":false,"previousSlug":"create-a-custom-field-value-1","isBodyEmpty":false,"children":[]},{"_id":"5cdc6bedeaa3ef002a2f78c1","createdAt":"2019-05-15T19:43:41.434Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"[\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"1\",\n \"fieldValue\": \"test title\"\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"2\",\n \"fieldValue\": \"test title\"\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"3\",\n \"fieldValue\": [\n \"option 1\",\n \"option 3\",\n \"option 4\"\n ]\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"4\",\n \"fieldValue\": 9999,\n \"fieldCurrency\": \"cad\"\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"5\",\n \"fieldValue\": \"100.99\"\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"6\",\n \"fieldValue\": \"2018-12-31\"\n },\n {\n \"accountId\": \"1\",\n \"customFieldId\": \"7\",\n \"fieldValue\": \"2020-05-19T02:45:00-05:00\" //ISO format\n }\n]\n","language":"json","name":null}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"the bulk insert was successful\"\n}"}]},"auth":"required","params":[{"name":"array","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42d"},{"name":"array.customerAccountId","type":"int","enumValues":"","default":"","desc":"The ID of the account this field value relates to","required":true,"in":"body","ref":"","_id":"5cdc54a56780d700452ffa4d"},{"name":"array.customFieldId","type":"int","enumValues":"","default":"","desc":"The ID of the custom field metum this field value relates to","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42c"},{"name":"array.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42b"},{"name":"array.fieldCurrency","type":"string","enumValues":"","default":"","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42a"}],"url":"/accountCustomFieldData/bulkCreate","method":"post"},"isReference":true,"order":1,"slug":"bulk-create-a-custom-account-field-value","type":"endpoint","title":"Bulk create a custom account field value","deprecated":false,"previousSlug":"bulk-create-a-custom-field-value-1","isBodyEmpty":false,"children":[]},{"_id":"5cdc6c48ebc91100f245ad44","createdAt":"2019-05-15T19:45:12.676Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"accountCustomFieldDatum\": {\n \"id\": \"1\",\n \"accountId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum\"\n }\n }\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the dealCustomFieldData to retrieve","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/accountCustomFieldData/:id","method":"get"},"isReference":true,"order":2,"slug":"retrieve-a-custom-field-value","type":"endpoint","title":"Retrieve a custom field value","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6c5ae775a0004b2d622b","createdAt":"2019-05-15T19:45:30.126Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"name":"text/textarea/hidden","language":"json","code":"{\n \"accountCustomFieldDatum\": {\n\t\t\"fieldValue\": \"New title\"\n }\n}"},{"name":"dropdown/radio","language":"json","code":"{\n \"accountCustomFieldDatum\" {\n\t\t\"fieldValue\": \"option 1\"\n }\n}"},{"name":"multiselect/checkbox single","language":"json","code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": [\n \t\t\"option 1\"\n \t]\n }\n}"},{"name":"currency","language":"json","code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": 9999,\n \t\"fieldCurrency\": \"cad\"\n }\n}"},{"name":"number","language":"json","code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": \"100.99\"\n }\n}"},{"name":"date","language":"json","code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": \"2018-12-31 00:00:00\"\n }\n}"},{"code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": \"2020-05-19T02:45:00-05:00\"\n }\n}","language":"json","name":"datetime"},{"code":"{\n \"accountCustomFieldDatum\" {\n \t\"fieldValue\": [\n \t\"option 1\",\n \t\"option 3\",\n \t\"option 4\"\n \t]\n }\n}","language":"json","name":"multiselect/checkbox multiple"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"accountCustomFieldDatum\": {\n \"id\": \"1\",\n \"accountId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum\"\n }\n }\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the custom fields value to update","required":false,"in":"path","ref":"","_id":"5bcde79d4a06de00550e66cb"},{"name":"accountCustomFieldDatum.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for text","required":false,"in":"body","ref":"","_id":"5be1006949b055001dcf68aa"},{"name":"accountCustomFieldDatum.fieldCurrency","type":"string","enumValues":"","default":"Default Currency for Field","desc":"Currency code for the `currency` value","required":false,"in":"body","ref":"","_id":"5c8045a67c748500622c75d0"}],"url":"/accountCustomFieldData/:id","method":"put"},"isReference":true,"order":3,"slug":"update-a-custom-field-value","type":"endpoint","title":"Update a custom field value","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6c645c024f004b31b6dc","createdAt":"2019-05-15T19:45:40.820Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"AccountCustomFieldData deleted.\"\n}"},{"status":404,"language":"text","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"_id":"58b5f08ce31a610f003a5a17","ref":"","in":"path","required":false,"desc":"ID of the dealCustomFieldData to retrieve","default":"","type":"int","name":"id"}],"url":"/accountCustomFieldData/:id","method":"delete"},"isReference":true,"order":4,"slug":"delete-a-custom-field-value","type":"endpoint","title":"Delete a custom field value","isBodyEmpty":false,"children":[]},{"_id":"5cdc6c8557ac38001288c937","createdAt":"2019-05-15T19:46:13.165Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"accountCustomFieldData\": [\n {\n \"id\": \"3\",\n \"accountCustomFieldMetumId\": 1,\n \"accountId\": 1,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:07\",\n \"updatedTimestamp\": \"2018-11-06 02:26:07\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/3/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/3/accountCustomFieldMetum\"\n }\n },\n {\n \"id\": \"4\",\n \"accountCustomFieldMetumId\": 1,\n \"accountId\": 3,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:51\",\n \"updatedTimestamp\": \"2018-11-06 02:26:51\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/4/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/4/accountCustomFieldMetum\"\n }\n },\n {\n \"id\": \"5\",\n \"accountCustomFieldMetumId\": 1,\n \"accountId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/5/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/5/accountCustomFieldMetum\"\n }\n },\n {\n \"id\": \"1\",\n \"accountCustomFieldMetumId\": 5,\n \"accountId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/account\",\n \"accountCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/accountCustomFieldData/1/accountCustomFieldMetum\"\n }\n }\n ]\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"filters[customerAccountId]","type":"string","enumValues":"","default":"","desc":"Filter results by a specific account (note that Id uses a capital I)","required":false,"in":"query","ref":"","_id":"5c057138c1c413018cb2376e"}],"url":"/accountCustomFieldData","method":"get"},"isReference":true,"order":5,"slug":"list-all-custom-field-values-2","type":"endpoint","title":"List all custom field values","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc6c91e607e5000ebdfa3a","createdAt":"2019-05-15T19:46:25.627Z","category":"5cdc690b0c875a00398c2f28","parentDoc":"5cdc696723748800eb581373","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"AccountCustomFieldDatas with ID(s): 1, 2, 3, 4, 5 successfully bulk updated.\"\n}"}]},"examples":{"codes":[{"name":null,"language":"json","code":"[\n {\n \"id\": \"1\",\n \"fieldValue\": \"test title\"\n },\n {\n \"id\": \"2\",\n \"fieldValue\": [\n \"option 1\",\n \"option 3\",\n \"option 4\"\n ]\n },\n {\n \"id\": \"3\",\n \"fieldValue\": 9999,\n \"fieldCurrency\": \"cad\"\n },\n {\n \"id\": \"4\",\n \"fieldValue\": \"100.99\"\n },\n {\n \"id\": \"5\",\n \"fieldValue\": \"2018-12-31\"\n },\n {\n \"id\": \"6\",\n \"fieldValue\": \"2020-05-19T02:45:00-05:00\" //ISO format\n }\n]"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"array","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42d"},{"name":"array.id","type":"int","enumValues":"","default":"","desc":"ID of the dealCustomFieldData to update","required":true,"in":"body","ref":"","_id":"5cdc54a56780d700452ffa4d"},{"name":"array.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42b"},{"name":"array.fieldCurrency","type":"string","enumValues":"","default":"","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42a"}],"url":"/accountCustomFieldData/bulkUpdate","method":"patch"},"isReference":true,"order":6,"slug":"bulk-update-a-custom-account-field-value","type":"endpoint","title":"Bulk update a custom field value","deprecated":false,"previousSlug":"bulk-update-a-custom-field-value-1","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b969043eea09300037d6e13","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-10T15:39:47.182Z","from_sync":false,"order":4,"slug":"address","title":"Addresses","__v":0,"pages":[{"_id":"5b96cc1a712bd700036cb77b","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T19:55:06.624Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"address","type":"basic","title":"Addresses","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b969e7ceea09300037d6f19","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T16:40:28.298Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"address\": {\n\t\t\"company_name\": \"TEST NAME\",\n\t\t\"address_1\": \"TEST ADDRESS\",\n\t\t\"country\": \"US\"\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"address\": {\n \"companyName\": \"TEST NAME\",\n \"address1\": \"TEST ADDRESS\",\n \"country\": 3,\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/3/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/3/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/3/forms\"\n },\n \"id\": \"3\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"address.groupid","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f25"},{"name":"address.global","type":"mixed","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f24"},{"name":"address.company_name","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f23"},{"name":"address.address_1","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f22"},{"name":"address.address_2","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f21"},{"name":"address.city","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f20"},{"name":"address.state","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1f"},{"name":"address.zip","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1e"},{"name":"address.district","type":"string","enumValues":"","default":"","desc":"(Optional for countries that use it)","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1d"},{"name":"address.country","type":"string","enumValues":"","default":"","desc":"Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1c"},{"name":"address.allgroup","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1b"},{"name":"address.is_default","type":"boolean","enumValues":"","default":"","desc":"Indicates default address","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1a"}],"url":"/addresses","method":"post"},"isReference":true,"order":0,"slug":"create-an-address","type":"endpoint","title":"Create an address","parentDoc":"5b96cc1a712bd700036cb77b","deprecated":false,"previousSlug":"testinput","isBodyEmpty":false,"children":[]},{"_id":"5b96a5b5eea09300037d6f6f","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T17:11:17.185Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"address\": {\n \"companyName\": \"Test Company Name\",\n \"address1\": \"Test Address\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the Address to retrieve","required":false,"in":"path","ref":"","_id":"5b96a5b5eea09300037d6f70"}],"url":"/addresses/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-an-address","type":"endpoint","title":"Retrieve an address","parentDoc":"5b96cc1a712bd700036cb77b","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9a844dc15fdb0003af9379","category":"5b969043eea09300037d6e13","parentDoc":"5b96cc1a712bd700036cb77b","createdAt":"2018-09-13T15:37:49.500Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"address\": {\n \"companyName\": \"New Test Company Name\",\n \"address1\": \"111 New Test Address\",\n \"address2\": \"\",\n \"city\": \"New Test City\",\n \"state\": \"Florida\",\n \"district\": \"\",\n \"zip\": \"12345\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Address with id 3\"\n}","name":""}]},"examples":{"codes":[{"code":"{\n\t\"address\": {\n \"companyName\": \"New Test Company Name\",\n \"address1\": \"111 New Test Address\",\n \"address2\": \"\",\n \"city\": \"New Test City\",\n \"state\": \"Florida\",\n \"zip\": \"12345\",\n \t\t\"country\": \"US\"\n\t} \n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"address.groupid","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f25"},{"name":"address.global","type":"mixed","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f24"},{"name":"address.company_name","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f23"},{"name":"address.address_1","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f22"},{"name":"address.address_2","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f21"},{"name":"address.city","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f20"},{"name":"address.state","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1f"},{"name":"address.zip","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1e"},{"name":"address.district","type":"string","enumValues":"","default":"","desc":"(Optional for countries that use it)","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1d"},{"name":"address.country","type":"string","enumValues":"","default":"","desc":"Accepts a (2) two character string - country code (eg 'US', 'CA', 'MX')","required":true,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1c"},{"name":"address.allgroup","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1b"},{"name":"address.is_default","type":"boolean","enumValues":"","default":"","desc":"Indicates default address","required":false,"in":"body","ref":"","_id":"5b969e7ceea09300037d6f1a"},{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the Address being changed","required":false,"in":"path","ref":"","_id":"5b9a844dc15fdb0003af937a"}],"url":"/addresses/:id","method":"put"},"isReference":true,"order":2,"slug":"update-an-address","type":"endpoint","title":"Update an address","deprecated":false,"previousSlug":"update-an-address-2","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b96a018b17e910003c91eaa","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T16:47:20.190Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Address with id 3\"\n}","name":""}]},"auth":"required","params":[{"_id":"5b96a018b17e910003c91eab","ref":"","in":"path","required":false,"desc":"ID of the Address to delete","default":"","type":"int","name":"id"}],"url":"/addresses/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-an-address","type":"endpoint","title":"Delete an address","parentDoc":"5b96cc1a712bd700036cb77b","isBodyEmpty":true,"children":[]},{"_id":"5b96a2dcc43dac000371a5c1","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T16:59:08.126Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for AddressGroup with id 19\"\n}","name":""}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"_id":"5b96a018b17e910003c91eab","ref":"","in":"path","required":false,"desc":"ID of the AddressGroup to delete","default":"","type":"int","name":"id"}],"url":"/addressGroups/:id","method":"delete"},"isReference":true,"order":4,"slug":"delete-an-addressgroup","type":"endpoint","title":"Delete address associated with a specific user group","parentDoc":"5b96cc1a712bd700036cb77b","isBodyEmpty":true,"children":[]},{"_id":"5b96a30540d30c0003f222a7","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T16:59:49.465Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for AddressList with id 6\"\n}","language":"json","status":404}]},"auth":"required","params":[{"_id":"5b96a018b17e910003c91eab","ref":"","in":"path","required":false,"desc":"ID of the AddressList to delete","default":"","type":"int","name":"id"}],"url":"/addressLists/:id","method":"delete"},"isReference":true,"order":5,"slug":"delete-an-addresslist","type":"endpoint","title":"Delete address associated with a specific list","parentDoc":"5b96cc1a712bd700036cb77b","isBodyEmpty":true,"children":[]},{"_id":"5b96a4de4ab6050003d69a2e","category":"5b969043eea09300037d6e13","createdAt":"2018-09-10T17:07:42.158Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"GET /addresses (Example RESPONSE)","code":"{\n \"addresses\": [\n {\n \"companyName\": \"Test Company Name\",\n \"address1\": \"Test Address\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"1\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/1/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/1/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/1/forms\"\n },\n \"id\": \"1\"\n },\n {\n \"companyName\": \"TEST NAME\",\n \"address1\": \"TEST ADDRESS\",\n \"address2\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"district\": \"\",\n \"zip\": \"\",\n \"country\": \"US\",\n \"allgroup\": \"0\",\n \"isDefault\": \"0\",\n \"links\": {\n \"addressGroup\": \"https://:account.api-us1.com/api/3/addresses/2/addressGroup\",\n \"addressList\": \"https://:account.api-us1.com/api/3/addresses/2/addressList\",\n \"forms\": \"https://:account.api-us1.com/api/3/addresses/2/forms\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[],"url":"/addresses","method":"get"},"isReference":true,"order":6,"slug":"list-all-addresses","type":"endpoint","title":"List all addresses","parentDoc":"5b96cc1a712bd700036cb77b","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b96af094ab6050003d69d34","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-10T17:51:05.234Z","from_sync":false,"order":5,"slug":"automation","title":"Automations","__v":0,"pages":[{"_id":"5b99f1a443d76f000384cbed","category":"5b96af094ab6050003d69d34","createdAt":"2018-09-13T05:12:04.474Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"automation","type":"basic","title":"Automations","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b96b79ceea09300037d714b","category":"5b96af094ab6050003d69d34","createdAt":"2018-09-10T18:27:40.955Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"automations\": [\n {\n \"name\": \"Email Subscription\",\n \"cdate\": \"2018-08-06T16:28:43-05:00\",\n \"mdate\": \"2018-08-06T16:33:10-05:00\",\n \"userid\": \"1\",\n \"status\": \"2\",\n \"entered\": \"0\",\n \"exited\": \"0\",\n \"hidden\": \"0\",\n \"defaultscreenshot\": \"http://img-us1.com/default-series.gif\",\n \"screenshot\": \"https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png\",\n \"links\": {\n \"campaigns\": \"https://:account.api-us1.com/api/3/automations/1/campaigns\",\n \"contactGoals\": \"https://:account.api-us1.com/api/3/automations/1/contactGoals\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/3/automations/1/contactAutomations\",\n \"blocks\": \"https://:account.api-us1.com/api/3/automations/1/blocks\",\n \"goals\": \"https://:account.api-us1.com/api/3/automations/1/goals\",\n \"sms\": \"https://:account.api-us1.com/api/3/automations/1/sms\",\n \"sitemessages\": \"https://:account.api-us1.com/api/3/automations/1/sitemessages\"\n },\n \"id\": \"1\"\n },\n {\n \"name\": \"Test SMS Send\",\n \"cdate\": \"2018-09-18T10:46:32-05:00\",\n \"mdate\": \"2018-09-18T10:54:30-05:00\",\n \"userid\": \"1\",\n \"status\": \"1\",\n \"entered\": \"2\",\n \"exited\": \"2\",\n \"hidden\": \"0\",\n \"defaultscreenshot\": \"http://img-us1.com/default-series.gif\",\n \"screenshot\": \"https://d226aj4ao1t61q.cloudfront.net/k0x4h0lr_default-automation.png\",\n \"links\": {\n \"campaigns\": \"https://:account.api-us1.com/api/3/automations/2/campaigns\",\n \"contactGoals\": \"https://:account.api-us1.com/api/3/automations/2/contactGoals\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/3/automations/2/contactAutomations\",\n \"blocks\": \"https://:account.api-us1.com/api/3/automations/2/blocks\",\n \"goals\": \"https://:account.api-us1.com/api/3/automations/2/goals\",\n \"sms\": \"https://:account.api-us1.com/api/3/automations/2/sms\",\n \"sitemessages\": \"https://:account.api-us1.com/api/3/automations/2/sitemessages\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\",\n \"starts\": [\n {\n \"id\": \"2\",\n \"series\": \"1\",\n \"type\": \"subscribe\"\n },\n {\n \"id\": \"4\",\n \"series\": \"2\",\n \"type\": \"subscribe\"\n }\n ],\n \"filtered\": false,\n \"smsLogs\": []\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"/automations","method":"get"},"isReference":true,"order":0,"slug":"list-all-automations","type":"endpoint","title":"List all automations","parentDoc":"5b99f1a443d76f000384cbed","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5898e1b8ec49fb0f004c25fa","from_sync":false,"slug":"branding","__v":0,"project":"57b6f40e480bae1900ce4e21","reference":true,"order":6,"title":"Branding","version":"57b6f40e480bae1900ce4e24","sync":{"url":"","isSync":false},"createdAt":"2017-02-06T20:51:04.247Z","pages":[{"_id":"5924a2b258d2d40f0030f797","category":"5898e1b8ec49fb0f004c25fa","isReference":true,"title":"Branding","type":"basic","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"createdAt":"2017-05-23T20:59:30.404Z","link_external":false,"link_url":"","slug":"branding","sync_unique":"","hidden":false,"order":0,"parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5898e556c9430c1b0089a22d","slug":"get-branding","type":"endpoint","api":{"settings":"","url":"/brandings/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"ID","desc":"","required":false,"in":"path","ref":"","_id":"5898f2a02f65061b002c8739"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"branding\": {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n\t}\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"parentDoc":"5924a2b258d2d40f0030f797","createdAt":"2017-02-06T21:06:30.433Z","link_external":false,"order":0,"isReference":true,"sync_unique":"","title":"Retrieve a branding","category":"5898e1b8ec49fb0f004c25fa","link_url":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5898f2bcec49fb0f004c263c","link_external":false,"link_url":"","sync_unique":"","title":"Update a branding","category":"5898e1b8ec49fb0f004c25fa","isReference":true,"slug":"update-branding","api":{"auth":"required","examples":{"codes":[]},"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"1","desc":"Branding ID","required":false,"in":"path","ref":"","_id":"589cb8a26c40350f00fccf11"},{"name":"branding.groupid","type":"int","enumValues":"","default":"3","desc":"The group ID. This value will always be 3.","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf10"},{"name":"branding.siteName","type":"string","enumValues":"","default":"","desc":"Title of software. Example: 'ActiveCampaign Email Marketing'","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf0f"},{"name":"branding.siteLogo","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf0e"},{"name":"branding.siteLogoSmall","type":"string","enumValues":"","default":"","desc":"URL of small logo. Small logos appear in the header of the admin panel.","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf0d"},{"name":"branding.headerTextValue","type":"string","enumValues":"","default":"","desc":"Content of non-removable header. Example: text header content","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf0b"},{"name":"branding.headerHtmlValue","type":"string","enumValues":"","default":"","desc":"Content of non-removable header. Example: <p>header content here</p>","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf09"},{"name":"branding.footerTextValue","type":"string","enumValues":"","default":"","desc":"Content of non-removeable footer. Example: text footer content","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf07"},{"name":"branding.footerHtmlValue","type":"string","enumValues":"","default":"","desc":"Content of non-removeable footer. Example: <p>footer content here</p>","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf05"},{"name":"branding.copyright","type":"boolean","enumValues":"","default":"","desc":"unknown","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf04"},{"name":"branding.version","type":"boolean","enumValues":"","default":"","desc":"unknown","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf03"},{"name":"branding.license","type":"boolean","enumValues":"","default":"","desc":"unknown","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf02"},{"name":"branding.links","type":"boolean","enumValues":"","default":"","desc":"External links. To enable (which is the default) exclude this parameter entirely. To disable (remove our branding), just pass this parameter with any value.","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccf01"},{"name":"branding.help","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fcceff"},{"name":"branding.adminTemplateHtm","type":"string","enumValues":"","default":"","desc":"The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccefe"},{"name":"branding.adminTemplateCss","type":"string","enumValues":"","default":"","desc":"The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccefd"},{"name":"branding.publicTemplateHtm","type":"string","enumValues":"","default":"","desc":"The actual HTML template (ONLY AVAILABLE FOR CERTAIN PLANS)","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccefc"},{"name":"branding.publicTemplateCss","type":"string","enumValues":"","default":"","desc":"The actual CSS. Example: test color: green; (ONLY AVAILABLE FOR CERTAIN PLANS)","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccefb"},{"name":"branding.favicon","type":"string","enumValues":"","default":"","desc":"URL of the favicon.","required":false,"in":"body","ref":"","_id":"589cb8a26c40350f00fccefa"}],"results":{"codes":[{"code":"{\n\t\"branding\": {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n\t}\n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/brandings/:id","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-02-06T22:03:40.806Z","order":1,"hidden":false,"parentDoc":"5924a2b258d2d40f0030f797","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5898e2e0372db21b008cb102","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"api_key","type":"string","enumValues":"","default":"","desc":"ActiveCampaign API key","required":false,"in":"query","ref":"","_id":"5898e52d2f65061b002c8702"}],"results":{"codes":[{"name":"","code":"{\n \"brandings\": [\n {\n\t\t\"groupid\": \"3\",\n\t\t\"siteName\": \"ActiveCampaign Email Marketing\",\n\t\t\"siteLogo\": \"http:\\/\\/mysite.com\\/logo.jpg\",\n\t\t\"siteLogoSmall\": \"http:\\/\\/mysite.com\\/logo_small.jpg\",\n\t\t\"headerTextValue\": \"my custom text header\",\n\t\t\"headerHtmlValue\": \"<p>my custom HTML header<\\/p>\",\n\t\t\"footerTextValue\": \"my custom text footer\",\n\t\t\"footerHtmlValue\": \"<p>my custom HTML footer<\\/p>\",\n\t\t\"copyright\": \"1\",\n\t\t\"version\": \"1\",\n\t\t\"license\": \"1\",\n\t\t\"links\": \"1\",\n\t\t\"help\": \"1\",\n\t\t\"adminTemplateHtm\": \"\",\n\t\t\"adminTemplateCss\": \"\",\n\t\t\"publicTemplateHtm\": \"\",\n\t\t\"publicTemplateCss\": \"\",\n\t\t\"favicon\": null,\n\t\t\"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","url":"/brandings","apiSetting":"58b53c301065f9c438aa1f77"},"order":2,"category":"5898e1b8ec49fb0f004c25fa","hidden":false,"link_url":"","parentDoc":"5924a2b258d2d40f0030f797","slug":"brandings","sync_unique":"","title":"List all brandings","isReference":true,"link_external":false,"type":"endpoint","createdAt":"2017-02-06T20:56:00.693Z","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5bee4153e47f490026b87250","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-11-16T04:02:27.603Z","order":7,"slug":"calendar-feeds","title":"Calendar Feeds","__v":0,"pages":[{"_id":"5bee4177978c7d0013c435b5","category":"5bee4153e47f490026b87250","createdAt":"2018-11-16T04:03:03.537Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"calendar-feeds","type":"basic","title":"Calendar Feeds","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5bee481d02b7e6044719e6e3","category":"5bee4153e47f490026b87250","parentDoc":"5bee4177978c7d0013c435b5","createdAt":"2018-11-16T04:31:25.685Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"calendar\": {\n\t\t\"title\": \"Calendar Title\",\n\t\t\"type\": \"All\",\n\t\t\"notification\": 1\n\t}\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"calendar\": {\n \"title\": \"Calendar Title\",\n \"type\": \"All\",\n \"userid\": \"1\",\n \"notification\": 1,\n \"cdate\": \"2018-11-15T22:26:35-06:00\",\n \"mdate\": \"2018-11-15T22:26:35-06:00\",\n \"token\": \"5540950ac4ed4f11591db934b701aff8\",\n \"links\": {\n \"calendarRels\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarRels\",\n \"calendarUsers\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarUsers\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200}]},"auth":"required","params":[{"name":"calendar.title","type":"string","enumValues":"","default":"","desc":"Title of the calendar feed","required":true,"in":"body","ref":"","_id":"5bee47643a8c260031725ad6"},{"name":"calendar.type","type":"string","enumValues":"","default":"","desc":"Possible Values: 'All', 'Deals', or 'Contacts'","required":true,"in":"body","ref":"","_id":"5bee47643a8c260031725ad5"},{"name":"calendar.notification","type":"boolean","enumValues":"","default":"","desc":"Whether or not this calendar has notifications","required":false,"in":"body","ref":"","_id":"5bee47643a8c260031725ad4"}],"url":"/calendars","method":"post"},"isReference":true,"order":0,"slug":"create-a-calendar-feed","type":"endpoint","title":"Create a calendar feed","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bee4347e47f490026b87259","category":"5bee4153e47f490026b87250","parentDoc":"5bee4177978c7d0013c435b5","createdAt":"2018-11-16T04:10:47.602Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"calendar\": {\n \"userid\": \"1\",\n \"title\": \"Calendar Title\",\n \"type\": \"All\",\n \"token\": \"5540950ac4ed4f11591db934b701aff8\",\n \"notification\": \"1\",\n \"cdate\": \"2018-11-15T22:26:35-06:00\",\n \"mdate\": \"2018-11-15T22:26:35-06:00\",\n \"links\": {\n \"calendarRels\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarRels\",\n \"calendarUsers\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarUsers\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"code":"{\n \"message\": \"No Result found for Calendar with id 1\"\n}","language":"text","status":404}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the calendar feed to retrieve","required":false,"in":"path","ref":"","_id":"5bee4347e47f490026b8725a"}],"url":"/calendars/:id","method":"get"},"isReference":true,"order":1,"slug":"list-all-calendar-feeds-1","type":"endpoint","title":"Retrieve a calendar feed","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bee49029ee4b1005ca66047","category":"5bee4153e47f490026b87250","parentDoc":"5bee4177978c7d0013c435b5","createdAt":"2018-11-16T04:35:14.127Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"calendar\": {\n \"userid\": \"1\",\n \"title\": \"Calendar Title\",\n \"type\": \"Deals\",\n \"token\": \"5540950ac4ed4f11591db934b701aff8\",\n \"notification\": 0,\n \"cdate\": \"2018-11-15T22:26:35-06:00\",\n \"mdate\": \"2018-11-16T02:11:40-06:00\",\n \"links\": {\n \"calendarRels\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarRels\",\n \"calendarUsers\": \"https://:account.api-us1.com/api/:version/calendars/1/calendarUsers\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200}]},"examples":{"codes":[{"code":"{\n\t\"calendar\": {\n\t\t\"title\": \"Calendar Title\",\n\t\t\"type\": \"Deals\",\n\t\t\"notification\": 0\n\t}\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the calendar feed to update","required":false,"in":"path","ref":"","_id":"5bee4347e47f490026b8725a"},{"name":"calendar.title","type":"string","enumValues":"","default":"","desc":"Title of the calendar feed","required":false,"in":"body","ref":"","_id":"5bee47643a8c260031725ad6"},{"name":"calendar.type","type":"string","enumValues":"","default":"","desc":"Possible Values: 'All', 'Deals', or 'Contacts'","required":false,"in":"body","ref":"","_id":"5bee47643a8c260031725ad5"},{"name":"calendar.notification","type":"boolean","enumValues":"","default":"","desc":"Whether or not this calendar has notifications","required":false,"in":"body","ref":"","_id":"5bee47643a8c260031725ad4"}],"url":"/calendars/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-calendar-feed","type":"endpoint","title":"Update a calendar feed","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bee7b886001ac004447af84","category":"5bee4153e47f490026b87250","parentDoc":"5bee4177978c7d0013c435b5","createdAt":"2018-11-16T08:10:48.938Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the calendar feed to delete","required":false,"in":"path","ref":"","_id":"5bee4347e47f490026b8725a"}],"url":"/calendars/:id","method":"delete"},"isReference":true,"order":3,"slug":"remove-a-calendar-feed","type":"endpoint","title":"Delete a calendar feed","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5bee42dd19e20e001f43b770","category":"5bee4153e47f490026b87250","parentDoc":"5bee4177978c7d0013c435b5","createdAt":"2018-11-16T04:09:01.517Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"calendars\": [\n {\n \"userid\": \"1\",\n \"title\": \"Calendar Title\",\n \"type\": \"All\",\n \"token\": \"4d9af6b9d5056ef1ca4a31c12c0e105c\",\n \"notification\": \"0\",\n \"cdate\": \"2018-11-15T22:36:05-06:00\",\n \"mdate\": \"2018-11-15T22:36:05-06:00\",\n \"links\": {\n \"calendarRels\": \"https://:account.api-us1.com/api/:version/calendars/2/calendarRels\",\n \"calendarUsers\": \"https://:account.api-us1.com/api/:version/calendars/2/calendarUsers\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","name":""}]},"auth":"required","params":[],"url":"/calendars","method":"get"},"isReference":true,"order":4,"slug":"list-all-calendar-feeds","type":"endpoint","title":"List all calendar feeds","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b96c453ff009a0003fd13cd","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-10T19:21:55.996Z","from_sync":false,"order":8,"slug":"campaign","title":"Campaigns","__v":0,"pages":[{"_id":"5b99f15ed617ad0003f26f06","category":"5b96c453ff009a0003fd13cd","createdAt":"2018-09-13T05:10:54.472Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"campaign","type":"basic","title":"Campaigns","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"test-1","isBodyEmpty":false,"children":[{"_id":"64cab3d64752570068ee7a14","api":{"method":"get","url":"/template/share","auth":"required","apiSetting":"64cab60c5659c2000a4e8e00","examples":{"codes":[]},"results":{"codes":[{"name":"Success","code":"{\n \"url\": \"http://tplshare.com/gXKi4s2$\",\n \"success\": 1,\n \"message\": \"Template shared successfully\",\n \"result_code\": 1,\n \"result_message\": \"Template shared successfully\",\n \"result_output\": \"json\"\n}","language":"json","status":200},{"name":"Invalid Template ID","code":"{\n \"success\": 0,\n \"message\": \"Invalid template\",\n \"result_code\": 0,\n \"result_message\": \"Invalid template\",\n \"result_output\": \"json\"\n}","language":"json","status":200}]},"params":[{"name":"api_key","type":"string","enumValues":"","default":"","desc":"ActiveCampaign Account API Key","required":false,"in":"query","ref":"","_id":"64cabc66dc4714000ca66fb7"},{"name":"id","type":"int","enumValues":"","default":"","desc":"The id of the campaign template to be shared","required":false,"in":"query","ref":"","_id":"64caba33d39aaa0043a822ec"}]},"title":"Create Shareable Campaign Template Link","icon":"","type":"endpoint","slug":"create-shareable-campaign-template-link","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-message-copy","parentDoc":"5b99f15ed617ad0003f26f06","category":"5b96c453ff009a0003fd13cd","createdAt":"2023-08-02T19:51:50.160Z","isBodyEmpty":false,"children":[]},{"_id":"5b96c49d50de2000039597ee","category":"5b96c453ff009a0003fd13cd","createdAt":"2018-09-10T19:23:09.045Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"campaigns\": [\n {\n \"type\": \"single\",\n \"userid\": \"1\",\n \"segmentid\": \"0\",\n \"bounceid\": \"-1\",\n \"realcid\": \"0\",\n \"sendid\": \"0\",\n \"threadid\": \"0\",\n \"seriesid\": \"0\",\n \"formid\": \"1\",\n \"basetemplateid\": \"90a1d1ab6ad33e95708caf6472dc1724f698c694\",\n \"basemessageid\": \"0\",\n \"addressid\": \"0\",\n \"source\": \"web\",\n \"name\": \"Opt In Email\",\n \"cdate\": \"2018-08-17T13:47:31-05:00\",\n \"mdate\": \"2018-08-17T13:47:31-05:00\",\n \"sdate\": null,\n \"ldate\": null,\n \"send_amt\": \"0\",\n \"total_amt\": \"0\",\n \"opens\": \"0\",\n \"uniqueopens\": \"0\",\n \"linkclicks\": \"0\",\n \"uniquelinkclicks\": \"0\",\n \"subscriberclicks\": \"0\",\n \"forwards\": \"0\",\n \"uniqueforwards\": \"0\",\n \"hardbounces\": \"0\",\n \"softbounces\": \"0\",\n \"unsubscribes\": \"0\",\n \"unsubreasons\": \"0\",\n \"updates\": \"0\",\n \"socialshares\": \"0\",\n \"replies\": \"0\",\n \"uniquereplies\": \"0\",\n \"status\": \"0\",\n \"public\": \"1\",\n \"mail_transfer\": \"0\",\n \"mail_send\": \"0\",\n \"mail_cleanup\": \"0\",\n \"mailer_log_file\": \"0\",\n \"tracklinks\": \"all\",\n \"tracklinksanalytics\": \"0\",\n \"trackreads\": \"1\",\n \"trackreadsanalytics\": \"1\",\n \"analytics_campaign_name\": \"\",\n \"tweet\": \"0\",\n \"facebook\": \"0\",\n \"survey\": \"\",\n \"embed_images\": \"0\",\n \"htmlunsub\": \"0\",\n \"textunsub\": \"0\",\n \"htmlunsubdata\": null,\n \"textunsubdata\": null,\n \"recurring\": \"day1\",\n \"willrecur\": \"0\",\n \"split_type\": \"even\",\n \"split_content\": \"0\",\n \"split_offset\": \"2\",\n \"split_offset_type\": \"day\",\n \"split_winner_messageid\": \"0\",\n \"split_winner_awaiting\": \"0\",\n \"responder_offset\": \"0\",\n \"responder_type\": \"subscribe\",\n \"responder_existing\": \"0\",\n \"reminder_field\": \"sdate\",\n \"reminder_format\": null,\n \"reminder_type\": \"month_day\",\n \"reminder_offset\": \"0\",\n \"reminder_offset_type\": \"day\",\n \"reminder_offset_sign\": \"+\",\n \"reminder_last_cron_run\": null,\n \"activerss_interval\": \"day1\",\n \"activerss_url\": null,\n \"activerss_items\": \"10\",\n \"ip4\": \"643992596\",\n \"laststep\": \"designer\",\n \"managetext\": \"0\",\n \"schedule\": \"0\",\n \"scheduleddate\": null,\n \"waitpreview\": \"0\",\n \"deletestamp\": null,\n \"replysys\": \"0\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/campaigns/1/user\",\n \"automation\": \"https://:account.api-us1.com/api/3/campaigns/1/automation\",\n \"campaignMessage\": \"https://:account.api-us1.com/api/3/campaigns/1/campaignMessage\",\n \"campaignMessages\": \"https://:account.api-us1.com/api/3/campaigns/1/campaignMessages\",\n \"links\": \"https://:account.api-us1.com/api/3/campaigns/1/links\",\n \"campaignLists\": \"https://:account.api-us1.com/api/3/campaigns/1/campaignLists\"\n },\n \"id\": \"1\",\n \"user\": \"1\",\n \"automation\": null\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"orders[sdate]","type":"string","enumValues":"","default":"ASC","desc":"Order campaigns by send date","required":false,"in":"query","ref":"","_id":"5de7f269fd524800392382b1"},{"name":"orders[ldate]","type":"string","enumValues":"","default":"","desc":"Order campaigns by last send date","required":false,"in":"query","ref":"","_id":"624db9f27b5a44001410954f"},{"name":"filters[seriesid]","type":"int","enumValues":"","default":"","desc":"Filter to return the campaigns from the targeted automationId/seriesIds","required":false,"in":"query","ref":"","_id":"624db9f27b5a44001410954e"}],"url":"/campaigns","method":"get"},"isReference":true,"order":1,"slug":"list-all-campaigns","type":"endpoint","title":"List all campaigns","parentDoc":"5b99f15ed617ad0003f26f06","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b96c58a50de20000395980a","category":"5b96c453ff009a0003fd13cd","createdAt":"2018-09-10T19:27:06.215Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"links\": [\n {\n \"campaignid\": \"1\",\n \"messageid\": \"3\",\n \"link\": \"open\",\n \"name\": \"Read Tracker\",\n \"ref\": \"\",\n \"tracked\": \"1\",\n \"links\": {\n \"campaign\": \"https://:account.api-us1.com/api/3/links/1/campaign\",\n \"message\": \"https://:account.api-us1.com/api/3/links/1/message\"\n },\n \"id\": \"1\",\n \"campaign\": \"1\",\n \"message\": \"3\"\n },\n {\n \"campaignid\": \"1\",\n \"messageid\": \"0\",\n \"link\": \"open\",\n \"name\": \"Read Tracker\",\n \"ref\": \"\",\n \"tracked\": \"1\",\n \"links\": {\n \"campaign\": \"https://:account.api-us1.com/api/3/links/2/campaign\",\n \"message\": \"https://:account.api-us1.com/api/3/links/2/message\"\n },\n \"id\": \"2\",\n \"campaign\": \"1\",\n \"message\": null\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Campaign with id 2\"\n}{\n \"links\": []\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of campaign to retrieve Links for","required":false,"in":"path","ref":"","_id":"5b96c58a50de20000395980b"}],"url":"/campaigns/:id/links","method":"get"},"isReference":true,"order":2,"slug":"retrieve-links-associated-campaign","type":"endpoint","title":"Retrieve links associated to campaign","parentDoc":"5b99f15ed617ad0003f26f06","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bef79b9b5f29d01240e2a2a","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b99f15ed617ad0003f26f06","createdAt":"2018-11-17T02:15:21.822Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"campaign\": {\n \"type\": \"single\",\n \"userid\": \"1\",\n \"segmentid\": \"0\",\n \"bounceid\": \"-1\",\n \"realcid\": \"0\",\n \"sendid\": \"0\",\n \"threadid\": \"0\",\n \"seriesid\": \"0\",\n \"formid\": \"0\",\n \"basetemplateid\": \"13b1432dc41b75dda9ff86d84a8593d2b2b9419f\",\n \"basemessageid\": \"0\",\n \"addressid\": \"0\",\n \"source\": \"web\",\n \"name\": \"Matt Litmus test\",\n \"cdate\": \"2018-10-10T11:59:43-05:00\",\n \"mdate\": \"2018-10-10T12:00:23-05:00\",\n \"sdate\": null,\n \"ldate\": null,\n \"send_amt\": \"0\",\n \"total_amt\": \"0\",\n \"opens\": \"0\",\n \"uniqueopens\": \"0\",\n \"linkclicks\": \"0\",\n \"uniquelinkclicks\": \"0\",\n \"subscriberclicks\": \"0\",\n \"forwards\": \"0\",\n \"uniqueforwards\": \"0\",\n \"hardbounces\": \"0\",\n \"softbounces\": \"0\",\n \"unsubscribes\": \"0\",\n \"unsubreasons\": \"0\",\n \"updates\": \"0\",\n \"socialshares\": \"0\",\n \"replies\": \"0\",\n \"uniquereplies\": \"0\",\n \"status\": \"0\",\n \"public\": \"1\",\n \"mail_transfer\": \"0\",\n \"mail_send\": \"0\",\n \"mail_cleanup\": \"0\",\n \"mailer_log_file\": \"0\",\n \"tracklinks\": \"all\",\n \"tracklinksanalytics\": \"0\",\n \"trackreads\": \"1\",\n \"trackreadsanalytics\": \"1\",\n \"analytics_campaign_name\": \"\",\n \"tweet\": \"0\",\n \"facebook\": \"0\",\n \"survey\": \"\",\n \"embed_images\": \"0\",\n \"htmlunsub\": \"0\",\n \"textunsub\": \"0\",\n \"htmlunsubdata\": null,\n \"textunsubdata\": null,\n \"recurring\": \"day1\",\n \"willrecur\": \"0\",\n \"split_type\": \"even\",\n \"split_content\": \"0\",\n \"split_offset\": \"2\",\n \"split_offset_type\": \"day\",\n \"split_winner_messageid\": \"0\",\n \"split_winner_awaiting\": \"0\",\n \"responder_offset\": \"0\",\n \"responder_type\": \"subscribe\",\n \"responder_existing\": \"0\",\n \"reminder_field\": \"sdate\",\n \"reminder_format\": null,\n \"reminder_type\": \"month_day\",\n \"reminder_offset\": \"0\",\n \"reminder_offset_type\": \"day\",\n \"reminder_offset_sign\": \"+\",\n \"reminder_last_cron_run\": null,\n \"activerss_interval\": \"day1\",\n \"activerss_url\": null,\n \"activerss_items\": \"10\",\n \"ip4\": \"643992596\",\n \"laststep\": \"designer\",\n \"managetext\": \"0\",\n \"schedule\": \"0\",\n \"scheduleddate\": null,\n \"waitpreview\": \"0\",\n \"deletestamp\": null,\n \"replysys\": \"0\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/:version/campaigns/1/user\",\n \"automation\": \"https://:account.api-us1.com/api/:version/campaigns/1/automation\",\n \"campaignMessage\": \"https://:account.api-us1.com/api/:version/campaigns/1/campaignMessage\",\n \"links\": \"https://:account.api-us1.com/api/:version/campaigns/1/links\",\n \"aggregateRevenues\": \"https://:account.api-us1.com/api/:version/campaigns/1/aggregateRevenues\"\n },\n \"id\": \"1\",\n \"user\": \"1\",\n \"automation\": null\n }\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of campaign to retrieve","required":false,"in":"path","ref":"","_id":"5b96c58a50de20000395980b"}],"url":"/campaigns/:id","method":"get"},"isReference":true,"order":3,"slug":"retrieve-a-campaign","type":"endpoint","title":"Retrieve a campaign","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"66f3b8d84959cf0010b6489e","api":{"method":"put","url":"/campaigns/{id}/edit","auth":"required","results":{"codes":[{"code":"","language":"text"}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"66f3b8d84959cf0010b648b9"},{"name":"name","type":"string","enumValues":"","default":"","desc":"Campaign name","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b8"},{"name":"type","type":"string","enumValues":"","default":"","desc":"Campaign type","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b7"},{"name":"segmentId","type":"int","enumValues":"","default":"","desc":"Id of selected segment","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b6"},{"name":"addressId","type":"int","enumValues":"","default":"","desc":"Id of selected address","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b5"},{"name":"listIds","type":"array_int","enumValues":"","default":"","desc":"Array of selected lists ids","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b4"},{"name":"replyTrackingEnabled","type":"boolean","enumValues":"","default":"","desc":"Turn on/off reply tracking","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b3"},{"name":"linkTrackingEnabled","type":"boolean","enumValues":"","default":"","desc":"Turn on/off link tracking","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b2"},{"name":"googleAnalyticsLinkTrackingEnabled","type":"boolean","enumValues":"","default":"","desc":"Turn on/off google analytics link tracking","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b1"},{"name":"googleAnalyticsCampaignName","type":"string","enumValues":"","default":"","desc":"Name of campaign in google analytics","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648b0"},{"name":"readTrackingEnabled","type":"boolean","enumValues":"","default":"","desc":"Turn on/off read tracking","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648af"},{"name":"sendToExistingSubscribers","type":"boolean","enumValues":"","default":"","desc":"Should send only to existing customers","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648ae"},{"name":"canSplitContent","type":"boolean","enumValues":"","default":"","desc":"Campaign can contains split content","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648ad"},{"name":"recurring","type":"boolean","enumValues":"","default":"","desc":"Is campaign recurring","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648ac"},{"name":"responderDaysOffset","type":"int","enumValues":"","default":"","desc":"Determine value of responder offset in days","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648ab"},{"name":"responderHoursOffset","type":"int","enumValues":"","default":"","desc":"Determine value of responder offset in hours","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648aa"},{"name":"scheduledDate","type":"string","enumValues":"","default":"","desc":"Date of sending","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a9"},{"name":"reminderField","type":"string","enumValues":"","default":"","desc":"Field basic on witch reminder will be triggered","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a8"},{"name":"reminderOffset","type":"int","enumValues":"","default":"","desc":"Value of reminder offset","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a7"},{"name":"reminderOffsetType","type":"string","enumValues":"","default":"","desc":"Type of reminder offset","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a6"},{"name":"reminderType","type":"string","enumValues":"","default":"","desc":"Format of reminder date","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a5"},{"name":"rssInterval","type":"int","enumValues":"","default":"","desc":"Interval for RSS","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a4"},{"name":"splitType","type":"string","enumValues":"","default":"","desc":"Type of split campaign","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a3"},{"name":"splitWinnerWaitPeriod","type":"int","enumValues":"","default":"","desc":"Period wait time","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a2"},{"name":"splitWinnerWaitPeriodType","type":"string","enumValues":"","default":"","desc":"Determine period type","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b648a1"},{"name":"publicCampaignArchive","type":"boolean","enumValues":"","default":"","desc":"Is campaign public","required":false,"in":"body","ref":"","_id":"66f3b8d84959cf0010b6489f"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Edit campaign","icon":"","type":"endpoint","slug":"edit-campaign","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5b99f15ed617ad0003f26f06","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-09-25T07:16:40.682Z","isBodyEmpty":false,"children":[]},{"_id":"66f42d07ac9a96000f3a0791","api":{"method":"post","url":"/campaign","auth":"required","results":{"codes":[{"name":"","code":"{\n \"id\": 149,\n \"name\": \"New campaign\",\n \"type\": \"single\",\n \"canSplitContent\": false\n}","language":"json","status":200},{"name":"","code":"{\n \"errors\": [\n \"Field name is required\",\n \"Field type must be of type string\"\n ]\n}","language":"json","status":400}]},"params":[{"name":"name","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"66f42d07ac9a96000f3a0794"},{"name":"type","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"66f42d07ac9a96000f3a0793"},{"name":"canSplitContent","type":"boolean","enumValues":"","default":"false","desc":"","required":false,"in":"body","ref":"","_id":"66f42d07ac9a96000f3a0792"}],"examples":{"codes":[{"code":"{\n \"name\": \"New campaign\",\n \"type\": \"single\"\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create Campaign","icon":"","type":"endpoint","slug":"create-campaign","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5b99f15ed617ad0003f26f06","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-09-25T15:32:23.680Z","isBodyEmpty":true,"children":[]},{"_id":"66f45b1b9862c40010eda8a3","api":{"method":"post","url":"/campaigns/{id}/copy","auth":"required","results":{"codes":[{"name":"","code":"{\n\t\"succeeded\":1,\n \"message\":\"Campaign draft copied.\",\n \"newCampaignId\":217\n}","language":"json","status":200},{"name":"","code":"'Bad request. The id parameter is either missing or does not reference a valid campaign.'","language":"json","status":400},{"code":"'Bad request. You are not allowed to copy this campaign.'","language":"json","status":400}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"id of the source campaign","required":false,"in":"path","ref":"","_id":"66f45b1b9862c40010eda8a4"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Duplicate Campaign","icon":"","type":"endpoint","slug":"duplicate-campaign","order":999,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"5b99f15ed617ad0003f26f06","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-09-25T18:48:59.003Z","isBodyEmpty":true,"children":[]}]},{"_id":"5b9acb7bbe532f00037e705b","category":"5b96c453ff009a0003fd13cd","createdAt":"2018-09-13T20:41:31.060Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":1,"slug":"messages","type":"basic","title":"Messages","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b9acc1d3acc1d0003c40132","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b9acb7bbe532f00037e705b","createdAt":"2018-09-13T20:44:13.578Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"message\": {\n\t\t\"fromname\": \"AC Admin\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\"\n\t}\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"message\": {\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\",\n \"text\": \"hello\",\n \"html\": \"<div>hello</div>\",\n \"links\": {\n \"user\": \"https://yourAccountName.api-us1.com/api/3/messages/28/user\",\n \"hyperlinks\": \"https://yourAccountName.api-us1.com/api/3/messages/28/hyperlinks\"\n },\n \"id\": \"28\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"message.fromname","type":"string","enumValues":"","default":"","desc":"Name of sender","required":true,"in":"body","ref":"","_id":"5baed86c0f9e060003541703"},{"name":"message.email","type":"string","enumValues":"","default":"","desc":"Email of sender","required":true,"in":"body","ref":"","_id":"5baed86c0f9e060003541702"},{"name":"message.reply2","type":"string","enumValues":"","default":"","desc":"Reply email for the recipient to reply to","required":true,"in":"body","ref":"","_id":"5baed86c0f9e060003541701"},{"name":"message.subject","type":"string","enumValues":"","default":"","desc":"Subject of message","required":false,"in":"body","ref":"","_id":"5baee0078a2fbe0003a9129f"},{"name":"message.preheader_text","type":"string","enumValues":"","default":"","desc":"Preheader Text","required":false,"in":"body","ref":"","_id":"5baee0078a2fbe0003a9129e"}],"url":"/messages","method":"post"},"isReference":true,"order":0,"slug":"create-a-new-message","type":"endpoint","title":"Create a message","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b9afb1b177e140003c21d12","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b9acb7bbe532f00037e705b","createdAt":"2018-09-14T00:04:43.069Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"message\": {\n \"userid\": \"1\",\n \"ed_instanceid\": \"1\",\n \"ed_version\": \"2\",\n \"cdate\": \"2018-08-17T13:47:32-05:00\",\n \"mdate\": \"2018-08-17T13:47:32-05:00\",\n \"name\": \"Please confirm your subscription to %LISTNAME%\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"Please confirm your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\nThank you for subscribing to %LISTNAME%!\\n\\nYou or someone has subscribed to this list on %SUBDATE% using the\\naddress %EMAIL%.\\n\\nTo confirm that you wish to be subscribed, please click the link below:\\n\\nConfirm My Subscription <%CONFIRMLINK%> \\n\\nIf you believe that this is a mistake and you did not intend on\\nsubscribing to this list,\\nyou can ignore this message and nothing else will happen.\",\n \"html\": \"<!DOCTYPE html PUBLIC \\\"-//W3C//DTD XHTML 1.0 Transitional//EN\\\" \\\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\\\">\\n<html lang=\\\"en\\\" style=\\\"margin: 0; outline: none; padding: 0;\\\"><head><!--[if !mso]><meta http-equiv=\\\"X-UA-Compatible\\\" content=\\\"IE=edge\\\"><!--<![endif]--><meta http-equiv=\\\"Content-Type\\\" content=\\\"text/html; charset=utf-8\\\"><meta http-equiv=\\\"Content-Language\\\" content=\\\"locale_contentlang\\\"><meta name=\\\"format-detection\\\" content=\\\"telephone=no\\\"><meta name=\\\"format-detection\\\" content=\\\"date=no\\\"><meta name=\\\"format-detection\\\" content=\\\"address=no\\\"><meta name=\\\"format-detection\\\" content=\\\"email=no\\\"><title>Preview</title><style data-ac-keep=\\\"true\\\">\\n.ExternalClass {width:100%; background:inherit; background-color:inherit;}\\n.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }\\n.undoreset div p, .undoreset p { margin-bottom: 20px; }\\ndiv[class^=\\\"aolmail_divbody\\\"] { overflow: auto; }\\n[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }\\n</style><style data-ac-keep=\\\"true\\\">\\n@media only screen and (max-width: 600px) {\\t/*-------------------------------------------------------------------------*\\\\ Abandoned Cart widget \\\\*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ td[height=\\\"10\\\"]{height:10px!important;font-size:10px!important;line-height:10px!important;}\\ntd[height=\\\"13\\\"]{height:13px!important;font-size:13px!important;line-height:13px!important;}\\ntd[height=\\\"14\\\"]{height:14px!important;font-size:14px!important;line-height:14px!important;}\\ntd[height=\\\"12\\\"]{height:12px!important;font-size:12px!important;line-height:12px!important;} /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }\\n</style><style data-ac-keep=\\\"true\\\"> </style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\\\"ac-designer\\\" class=\\\"body\\\" style=\\\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #f5f5f5; width: 100%; text-align: center;\\\"><div class=\\\"divbody\\\" style=\\\"margin: 0px; outline: none; padding: 0px; color: #000000; font-family: arial; line-height: 1.1; width: 100%; background-color: #f5f5f5; background: #f5f5f5; text-align: center;\\\"><table class=\\\"template-table\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"100%\\\" align=\\\"left\\\" style=\\\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; background: #f5f5f5;\\\"><tr><td align=\\\"center\\\" valign=\\\"top\\\" width=\\\"100%\\\"><table class=\\\"template-table\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"650\\\" bgcolor=\\\"#f5f5f5\\\" style=\\\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; max-width: 650px;\\\"><tr><td id=\\\"layout_table_4c01fd59953b175598dbdb0163afc56680171ae4\\\" valign=\\\"top\\\" align=\\\"center\\\" width=\\\"650\\\" style=\\\"background-color: #f5f5f5;\\\"><table cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" border=\\\"0\\\" class=\\\"layout layout-table root-table\\\" width=\\\"650\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5;\\\"><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin2\\\" valign=\\\"top\\\" style=\\\"background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr id=\\\"layout-row2\\\" class=\\\"layout layout-row widget _widget_spacer \\\"><td id=\\\"layout-row-padding2\\\" valign=\\\"top\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td valign=\\\"top\\\" height=\\\"30\\\"><div class=\\\"spacer\\\" style=\\\"margin: 0; outline: none; padding: 0; height: 30px;\\\"><table cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" border=\\\"0\\\" width=\\\"100%\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tbody><tr><td class=\\\"spacer-body\\\" valign=\\\"top\\\" height=\\\"30\\\" width=\\\"650\\\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin1\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row1\\\" class=\\\"layout layout-row widget _widget_text style1\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding1\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 20px 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div1\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 10px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: #000000; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">Thank you for subscribing to %LISTNAME%!</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin3\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row3\\\" class=\\\"layout layout-row widget _widget_text style3\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding3\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 20px 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div3\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: inherit; font-size: 13px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin4\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 0 20px; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row4\\\" class=\\\"layout layout-row widget _widget_text style4\\\" style=\\\"margin: 0; padding: 0; background-color: #ffffff;\\\"><td id=\\\"layout-row-padding4\\\" valign=\\\"top\\\" style=\\\"background-color: #ffffff; padding: 30px 30px 20px 30px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div4\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span class=\\\"\\\" style=\\\"color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\">To confirm that you wish to be subscribed, please click the link below:</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin5\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 0 20px; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row5\\\" class=\\\"layout layout-row widget _widget_button style5\\\" style=\\\"background-color: #ffffff;\\\"><td id=\\\"layout-row-padding5\\\" valign=\\\"top\\\" style=\\\"background-color: #ffffff; padding: 0px 30px 30px 30px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td class=\\\"td_button td_block customizable\\\" valign=\\\"top\\\" align=\\\"left\\\" width=\\\"550\\\"> <div class=\\\"button-wrapper\\\" style=\\\"margin: 0; outline: none; padding: 0; text-align: center;\\\">\\n<!--[if mso]> <v:roundrect xmlns:v=\\\"urn:schemas-microsoft-com:vml\\\" xmlns:w=\\\"urn:schemas-microsoft-com:office:word\\\" href=\\\"%CONFIRMLINK%\\\" style=\\\"v-text-anchor:middle; width:202px; height:64px; \\\" arcsize=\\\"10%\\\" strokecolor=\\\"#4dcba9\\\" strokeweight=\\\"1pt\\\" fillcolor=\\\"#4dcba9\\\" o:button=\\\"true\\\" o:allowincell=\\\"true\\\" o:allowoverlap=\\\"false\\\" > <v:textbox inset=\\\"2px,2px,2px,2px\\\"> <center style=\\\"color:#ffffff;font-family:Arial; font-size:14px; line-height: 1.1;\\\">Confirm My Subscription</center> </v:textbox> </v:roundrect>\\n<![endif]--> <a href=\\\"%CONFIRMLINK%\\\" style=\\\"margin: 0; outline: none; padding: 14px; color: #ffffff; background-color: #4dcba9; border: 1px solid #4dcba9; border-radius: 4px; font-family: Arial; font-size: 14px; display: inline-block; line-height: 1.1; text-align: center; text-decoration: none; mso-hide: all;\\\"> <span style=\\\"color:#ffffff;font-family:Arial;font-size:14px;\\\"> Confirm My Subscription </span> </a> </div>\\n</td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin6\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row6\\\" class=\\\"layout layout-row widget _widget_text style6\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding6\\\" valign=\\\"top\\\" style=\\\"padding: 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div6\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">If you believe that this is a mistake and you did not intend on subscribing to this list,<br>you can ignore this message and nothing else will happen.</span></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></div></body></html>\\n\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": \"\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/3/user\"\n },\n \"id\": \"3\",\n \"user\": \"1\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for Message with id 10\"\n}","language":"json","status":404}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the message to retrieve","required":false,"in":"path","ref":"","_id":"5b9afb1b177e140003c21d13"}],"url":"/messages/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-message","type":"endpoint","title":"Retrieve a message","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9ace9e11e6a400036d2e54","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b9acb7bbe532f00037e705b","createdAt":"2018-09-13T20:54:54.642Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"message\": {\n\t\t\"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\"\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": {\n \"userid\": \"0\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2024-08-06T16:31:45-05:00\",\n \"mdate\": \"2024-08-06T16:33:23-05:00\",\n \"name\": \"\",\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"You are subscribing to %LISTNAME%\",\n \"preheader_text\": \"Pre-header Text\",\n \"text\": \"hello\",\n \"html\": \"<div>hello</div>\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"has_predictive_content\": \"0\",\n \"links\": {\n \"user\": \"https://accountName.api-us1.com/api/3/messages/56/user\",\n \"hyperlinks\": \"https://accountName.api-us1.com/api/3/messages/56/hyperlinks\"\n },\n \"id\": \"56\",\n \"user\": null\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Message with id 543\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the message to update","required":false,"in":"path","ref":"","_id":"5b9acde4be532f00037e70f0"},{"name":"message.fromname","type":"string","enumValues":"","default":"","desc":"Name of sender","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe06"},{"name":"message.fromemail","type":"string","enumValues":"","default":"","desc":"Email of sender","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe05"},{"name":"message.reply2","type":"string","enumValues":"","default":"","desc":"Reply email for the recipient to reply to","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe04"},{"name":"message.subject","type":"string","enumValues":"","default":"","desc":"Subject of message","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe03"},{"name":"message.preheader_text","type":"string","enumValues":"","default":"","desc":"Preheader Text","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe02"},{"name":"message.name","type":"string","enumValues":"","default":"","desc":"Name of the message","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe01"},{"name":"message.text","type":"string","enumValues":"","default":"","desc":"Text content","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffe00"},{"name":"message.html","type":"string","enumValues":"","default":"","desc":"HTML Content","required":false,"in":"body","ref":"","_id":"6723c282efa67b00103ffdff"}],"url":"/messages/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-message","type":"endpoint","title":"Update a message","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b9acde4be532f00037e70ef","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b9acb7bbe532f00037e705b","createdAt":"2018-09-13T20:51:48.096Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"_id":"5b9acde4be532f00037e70f0","ref":"","in":"path","required":false,"desc":"ID of the message to delete","default":"","type":"string","name":"id"}],"url":"/messages/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-message","type":"endpoint","title":"Delete a message","isBodyEmpty":true,"children":[]},{"_id":"5b9aced011e6a400036d2e56","category":"5b96c453ff009a0003fd13cd","parentDoc":"5b9acb7bbe532f00037e705b","createdAt":"2018-09-13T20:55:44.128Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"messages\": [\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2018-08-17T09:47:38-05:00\",\n \"mdate\": \"2018-08-17T09:47:38-05:00\",\n \"name\": \"\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"hello@example.com\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"quoted-printable\",\n \"format\": \"mime\",\n \"subject\": \"Update your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\n**Update your subscription details for %LISTNAME%** \\n\\n \\n\\nYou or someone entering your email has requested to update your\\nsubscription details for the address %EMAIL%.\\n\\n**To update your subscription details click the link below.**\\n\\nUpdate My Subscription <%LINK%> \\n\\n \\n\\n{\\\"If you believe that this is a mistake and you did not intend on\\nupdating your subscription to this list, you can ignore this message and\\nnothing else will happen.\\\"|alang\\n\\n \",\n \"html\": \"<!DOCTYPE html PUBLIC \\\"-//W3C//DTD XHTML 1.0 Transitional//EN\\\" \\\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\\\">\\n<html lang=\\\"en\\\" style=\\\"margin: 0; outline: none; padding: 0;\\\">\\n<head>\\n <!--[if !mso]><meta http-equiv=\\\"X-UA-Compatible\\\" content=\\\"IE=edge\\\"><!--<![endif]-->\\n <meta http-equiv=\\\"Content-Type\\\" content=\\\"text/html; charset=utf-8\\\">\\n <meta http-equiv=\\\"Content-Language\\\" content=\\\"en-us\\\">\\n <title>Preview</title>\\n <style>\\n .ExternalClass .ExternalClass p,\\n .ExternalClass ul,\\n .ExternalClass ol .undoreset div p,\\n .undoreset p </style>\\n <style>\\n @media only screen and (max-width: 600px),\\n only screen and (max-device-width: 600px) * table thead,\\n tbody,\\n tr th,\\n td,\\n p }\\n </style>\\n</head>\\n<body style=\\\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #F2F2F2; width: 100%; text-align: center;\\\">\\n <div class=\\\"divbody\\\" style=\\\"margin: 0px; outline: none; padding: 0px; font-family: arial; line-height: 1.1; width: 100%; background-color: #F2F2F2; background: #F2F2F2; text-align: center;\\\">\\n <table border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"100%\\\" style=\\\"font-size: 16px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" height=\\\"40\\\" align=\\\"center\\\">&nbsp;</td>\\n </tr>\\n <tr>\\n <td align=\\\"center\\\" valign=\\\"top\\\" width=\\\"100%\\\">\\n <table border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"100%\\\" bgcolor=\\\"#F2F2F2\\\" style=\\\"font-size: 16px; min-width: 650px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" align=\\\"center\\\">\\n <table cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" border=\\\"0\\\" width=\\\"100%\\\" style=\\\"font-size: 16px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" style=\\\"padding: 0;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr style=\\\"margin: 0; padding: 0;\\\">\\n <td valign=\\\"top\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" align=\\\"center\\\" style=\\\"Margin:0; padding:0; font-size:20px; font-family:Arial,Helvetica; line-height:26px; text-align:center!important;\\\"><strong style=\\\"font-weight:bold;\\\">Update your subscription details for %LISTNAME%</strong>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n <tr>\\n <td height=\\\"20\\\">&nbsp;</td>\\n </tr>\\n <tr>\\n <td valign=\\\"top\\\" style=\\\"padding: 0;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr style=\\\"margin: 0; padding: 0;\\\">\\n <td valign=\\\"top\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" align=\\\"center\\\" width=\\\"610\\\" style=\\\"color: inherit; font-size: inherit; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\">You or someone entering your email has requested to update your subscription details for the address %EMAIL%.</td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n <tr>\\n <td valign=\\\"top\\\" style=\\\"padding: 20px;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; border-collapse: initial !important;\\\">\\n <tr style=\\\"background-color: #ffffff;\\\">\\n <td valign=\\\"top\\\" style=\\\"border-color: #c2c2c2; border-style: solid; border-width: 1px;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" align=\\\"center\\\" style=\\\"padding:20px; font-size:16px; font-family:Arial,Helvetica; text-align:center;\\\"><strong style=\\\"font-weight:bold;\\\">To update your subscription details click the link below.</strong></td> </tr> <tr> <td valign=\\\"top\\\" align=\\\"center\\\"> <table border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px;\\\"> <tr> <td valign=\\\"top\\\" align=\\\"left\\\" width=\\\"558\\\">\\n <div class=\\\"button-wrapper\\\" style=\\\"margin: 0; outline: none; padding: 0; text-align: center;\\\">\\n <!--[if mso]> <v:roundrect xmlns:v=\\\"urn:schemas-microsoft-com:vml\\\" xmlns:w=\\\"urn:schemas-microsoft-com:office:word\\\" href=\\\"%LINK%\\\" style=\\\"v-text-anchor:middle; width: 558px; height: 50px;\\\" arcsize=\\\"10%\\\" strokecolor=\\\"#4DCBA9\\\" strokeweight=\\\"1pt\\\" fillcolor=\\\"#4DCBA9\\\" > <w:anchorlock/> <center style=\\\"color:#ffffff;font-family:'Arial'; font-size:16px;\\\">Update My Subscription</center> </v:roundrect> <![endif]-->\\n <a href=\\\"%LINK%\\\" style=\\\"margin: 0; outline: none; padding: 16px; background-color: #4DCBA9; border: 1px solid #4DCBA9; border-radius: 4px; color: #ffffff; font-family: Arial; font-size: 16px; display: inline-block; text-align: center; text-decoration: none; mso-hide: all;\\\"> <span style=\\\"color:#ffffff;\\\">Update My Subscription</span> </a>\\n </div>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n <tr>\\n <td height=\\\"20\\\">&nbsp;</td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n <tr>\\n <td valign=\\\"top\\\" style=\\\"padding: 0;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr style=\\\"margin: 0; padding: 0;\\\">\\n <td valign=\\\"top\\\" style=\\\"padding: 20px;\\\">\\n <table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 14px;\\\">\\n <tr>\\n <td valign=\\\"top\\\" height=\\\"25\\\" align=\\\"center\\\" style=\\\"Margin:0; padding:0; font-size:13px; line-height:13px; font-family:Arial,Helvetica; text-align:center!important; line-height:20px; text-align:center!important;\\\">{\\\"If you believe that this is a mistake and you did not intend on updating your subscription to this list, you can ignore this message and nothing else will happen.\\\"|alang</td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n </table>\\n </td>\\n </tr>\\n <tr>\\n <td valign=\\\"top\\\" height=\\\"40\\\" align=\\\"center\\\">&nbsp;</td>\\n </tr>\\n </table>\\n </div>\\n</body>\\n\\n</html>\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/2/user\"\n },\n \"id\": \"2\",\n \"user\": \"1\"\n },\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"1\",\n \"ed_version\": \"2\",\n \"cdate\": \"2018-08-17T13:47:32-05:00\",\n \"mdate\": \"2018-08-17T13:47:32-05:00\",\n \"name\": \"Please confirm your subscription to %LISTNAME%\",\n \"fromname\": \"AC Admin\",\n \"fromemail\": \"ac_test@activecampaign.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"Please confirm your subscription to %LISTNAME%\",\n \"preheader_text\": \"\",\n \"text\": \" \\n\\nThank you for subscribing to %LISTNAME%!\\n\\nYou or someone has subscribed to this list on %SUBDATE% using the\\naddress %EMAIL%.\\n\\nTo confirm that you wish to be subscribed, please click the link below:\\n\\nConfirm My Subscription <%CONFIRMLINK%> \\n\\nIf you believe that this is a mistake and you did not intend on\\nsubscribing to this list,\\nyou can ignore this message and nothing else will happen.\",\n \"html\": \"<!DOCTYPE html PUBLIC \\\"-//W3C//DTD XHTML 1.0 Transitional//EN\\\" \\\"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\\\">\\n<html lang=\\\"en\\\" style=\\\"margin: 0; outline: none; padding: 0;\\\"><head><!--[if !mso]><meta http-equiv=\\\"X-UA-Compatible\\\" content=\\\"IE=edge\\\"><!--<![endif]--><meta http-equiv=\\\"Content-Type\\\" content=\\\"text/html; charset=utf-8\\\"><meta http-equiv=\\\"Content-Language\\\" content=\\\"locale_contentlang\\\"><meta name=\\\"format-detection\\\" content=\\\"telephone=no\\\"><meta name=\\\"format-detection\\\" content=\\\"date=no\\\"><meta name=\\\"format-detection\\\" content=\\\"address=no\\\"><meta name=\\\"format-detection\\\" content=\\\"email=no\\\"><title>Preview</title><style data-ac-keep=\\\"true\\\">\\n.ExternalClass {width:100%; background:inherit; background-color:inherit;}\\n.ExternalClass p, .ExternalClass ul, .ExternalClass ol { Margin: 0; }\\n.undoreset div p, .undoreset p { margin-bottom: 20px; }\\ndiv[class^=\\\"aolmail_divbody\\\"] { overflow: auto; }\\n[owa] #ac-footer { padding: 20px 0px!important; background:inherit; background-color:inherit; }\\n</style><style data-ac-keep=\\\"true\\\">\\n@media only screen and (max-width: 600px) {\\t/*-------------------------------------------------------------------------*\\\\ Abandoned Cart widget \\\\*------------------------------------------------------------------------*/ .td_abandoned-cart img {display: block;padding-right: 0 !important;padding-bottom: 0 !important;width: 100% !important;max-width: 100% !important;height: auto !important;} body { padding: 0!important; font-size:1em!important; } * { -webkit-box-sizing: border-box; -moz-box-sizing: border-box; box-sizing: border-box; } *[class].divbody {-webkit-text-size-adjust:none !important; width:auto !important;} *[class].td_picture img {width:auto !important;} *[class].td_text { line-height: 110%; } *[class].td_button { width: auto; } /* Collapse all block elements */ :not(.body) table { display: block!important; float:none!important; border-collapse:collapse !important; width:100% !important; min-width:100% !important; clear:both!important; } :not(.body) thead, :not(.body) tbody, :not(.body) tr { display:block!important; float:none!important; width:100% !important; } :not(.body) th, :not(.body) td, :not(.body) p { display:block!important; float:none!important; width:100% !important; clear:both!important; } /* Remove browser default styling for elements */ ul, ol { margin-left: 20px; margin-bottom: 10px; margin-top: 10px; -webkit-margin-before: 0; -webkit-margin-after: 0; -webkit-padding-start: 0; } /* Set default height for spacer once collapse */ *[class].spacer { height: auto!important; } a[href^=date]{ color:inherit !important; text-decoration:none !important;} a[href^=telephone]{ color:inherit !important; text-decoration:none !important;} a[href^=address]{ color:inherit !important; text-decoration:none !important;} a[href^=email]{ color:inherit !important; text-decoration:none !important;} /* Default table cell height */ td[height=\\\"10\\\"]{height:10px!important;font-size:10px!important;line-height:10px!important;}\\ntd[height=\\\"13\\\"]{height:13px!important;font-size:13px!important;line-height:13px!important;}\\ntd[height=\\\"14\\\"]{height:14px!important;font-size:14px!important;line-height:14px!important;}\\ntd[height=\\\"12\\\"]{height:12px!important;font-size:12px!important;line-height:12px!important;} /* Default social icons */ *[class].ac-social-icon-16 {width:16px !important; height:16px !important;} *[class].ac-social-icon-24 {width:24px !important; height:24px !important;} *[class].ac-social-icon-28 {width:28px !important; height:28px !important;} *[class].__ac_social_icons { margin-right: 0px !important; } }\\n</style><style data-ac-keep=\\\"true\\\"> </style><!--[if !mso]><!-- webfonts --><!--<![endif]--><!--[if lt mso 12]> <![endif]--></head><body id=\\\"ac-designer\\\" class=\\\"body\\\" style=\\\"font-family: Arial; line-height: 1.1; margin: 0px; background-color: #f5f5f5; width: 100%; text-align: center;\\\"><div class=\\\"divbody\\\" style=\\\"margin: 0px; outline: none; padding: 0px; color: #000000; font-family: arial; line-height: 1.1; width: 100%; background-color: #f5f5f5; background: #f5f5f5; text-align: center;\\\"><table class=\\\"template-table\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"100%\\\" align=\\\"left\\\" style=\\\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5; background: #f5f5f5;\\\"><tr><td align=\\\"center\\\" valign=\\\"top\\\" width=\\\"100%\\\"><table class=\\\"template-table\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" width=\\\"650\\\" bgcolor=\\\"#f5f5f5\\\" style=\\\"font-size: 13px; min-width: auto; mso-table-lspace: 0pt; mso-table-rspace: 0pt; max-width: 650px;\\\"><tr><td id=\\\"layout_table_4c01fd59953b175598dbdb0163afc56680171ae4\\\" valign=\\\"top\\\" align=\\\"center\\\" width=\\\"650\\\" style=\\\"background-color: #f5f5f5;\\\"><table cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" border=\\\"0\\\" class=\\\"layout layout-table root-table\\\" width=\\\"650\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; background-color: #f5f5f5;\\\"><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin2\\\" valign=\\\"top\\\" style=\\\"background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr id=\\\"layout-row2\\\" class=\\\"layout layout-row widget _widget_spacer \\\"><td id=\\\"layout-row-padding2\\\" valign=\\\"top\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td valign=\\\"top\\\" height=\\\"30\\\"><div class=\\\"spacer\\\" style=\\\"margin: 0; outline: none; padding: 0; height: 30px;\\\"><table cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" border=\\\"0\\\" width=\\\"100%\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tbody><tr><td class=\\\"spacer-body\\\" valign=\\\"top\\\" height=\\\"30\\\" width=\\\"650\\\"> </td></tr></tbody></table></div></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin1\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row1\\\" class=\\\"layout layout-row widget _widget_text style1\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding1\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 20px 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div1\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 10px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: #000000; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">Thank you for subscribing to %LISTNAME%!</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin3\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row3\\\" class=\\\"layout layout-row widget _widget_text style3\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding3\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 20px 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div3\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: inherit; font-size: 13px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">You or someone has subscribed to this list on %SUBDATE% using the address %EMAIL%.</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin4\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 0 20px; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row4\\\" class=\\\"layout layout-row widget _widget_text style4\\\" style=\\\"margin: 0; padding: 0; background-color: #ffffff;\\\"><td id=\\\"layout-row-padding4\\\" valign=\\\"top\\\" style=\\\"background-color: #ffffff; padding: 30px 30px 20px 30px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div4\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span class=\\\"\\\" style=\\\"color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\">To confirm that you wish to be subscribed, please click the link below:</span></p></td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin5\\\" valign=\\\"top\\\" style=\\\"padding: 0 20px 0 20px; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row5\\\" class=\\\"layout layout-row widget _widget_button style5\\\" style=\\\"background-color: #ffffff;\\\"><td id=\\\"layout-row-padding5\\\" valign=\\\"top\\\" style=\\\"background-color: #ffffff; padding: 0px 30px 30px 30px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td class=\\\"td_button td_block customizable\\\" valign=\\\"top\\\" align=\\\"left\\\" width=\\\"550\\\"> <div class=\\\"button-wrapper\\\" style=\\\"margin: 0; outline: none; padding: 0; text-align: center;\\\">\\n<!--[if mso]> <v:roundrect xmlns:v=\\\"urn:schemas-microsoft-com:vml\\\" xmlns:w=\\\"urn:schemas-microsoft-com:office:word\\\" href=\\\"%CONFIRMLINK%\\\" style=\\\"v-text-anchor:middle; width:202px; height:64px; \\\" arcsize=\\\"10%\\\" strokecolor=\\\"#4dcba9\\\" strokeweight=\\\"1pt\\\" fillcolor=\\\"#4dcba9\\\" o:button=\\\"true\\\" o:allowincell=\\\"true\\\" o:allowoverlap=\\\"false\\\" > <v:textbox inset=\\\"2px,2px,2px,2px\\\"> <center style=\\\"color:#ffffff;font-family:Arial; font-size:14px; line-height: 1.1;\\\">Confirm My Subscription</center> </v:textbox> </v:roundrect>\\n<![endif]--> <a href=\\\"%CONFIRMLINK%\\\" style=\\\"margin: 0; outline: none; padding: 14px; color: #ffffff; background-color: #4dcba9; border: 1px solid #4dcba9; border-radius: 4px; font-family: Arial; font-size: 14px; display: inline-block; line-height: 1.1; text-align: center; text-decoration: none; mso-hide: all;\\\"> <span style=\\\"color:#ffffff;font-family:Arial;font-size:14px;\\\"> Confirm My Subscription </span> </a> </div>\\n</td></tr></table></td></tr></table></td></tr><tr style=\\\"background-color: #f5f5f5;\\\"><td id=\\\"layout-row-margin6\\\" valign=\\\"top\\\" style=\\\"padding: 0; background-color: #f5f5f5;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt; border-collapse: initial !important;\\\"><tr id=\\\"layout-row6\\\" class=\\\"layout layout-row widget _widget_text style6\\\" style=\\\"margin: 0; padding: 0;\\\"><td id=\\\"layout-row-padding6\\\" valign=\\\"top\\\" style=\\\"padding: 20px;\\\"><table width=\\\"100%\\\" border=\\\"0\\\" cellpadding=\\\"0\\\" cellspacing=\\\"0\\\" style=\\\"font-size: 13px; min-width: 100%; mso-table-lspace: 0pt; mso-table-rspace: 0pt;\\\"><tr><td id=\\\"text_div6\\\" class=\\\"td_text td_block\\\" valign=\\\"top\\\" align=\\\"left\\\" style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: 1; text-decoration: inherit; font-family: Arial;\\\"> <span class=\\\"\\\" style=\\\"color: inherit; font-size: 16px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\"> </span><p style=\\\"margin: 0; outline: none; padding: 0; color: inherit; font-size: inherit; font-weight: inherit; line-height: inherit; text-decoration: inherit; text-align: center;\\\"><span style=\\\"color: inherit; font-size: 12px; font-weight: inherit; line-height: inherit; text-decoration: inherit;\\\" class=\\\"\\\">If you believe that this is a mistake and you did not intend on subscribing to this list,<br>you can ignore this message and nothing else will happen.</span></p></td></tr></table></td></tr></table></td></tr></table></td></tr></table></td></tr></table></div></body></html>\\n\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": \"\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/3/user\"\n },\n \"id\": \"3\",\n \"user\": \"1\"\n },\n {\n \"userid\": \"1\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"1\",\n \"cdate\": \"2018-08-17T13:48:45-05:00\",\n \"mdate\": \"2018-08-17T13:48:45-05:00\",\n \"name\": \"testing\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"noreply@example.com\",\n \"reply2\": \"\",\n \"priority\": \"3\",\n \"charset\": \"utf-8\",\n \"encoding\": \"8bit\",\n \"format\": \"mime\",\n \"subject\": \"testing\",\n \"preheader_text\": \"\",\n \"text\": \"testing testing testing\",\n \"html\": \"<br>\\ntesting testing testing\",\n \"htmlfetch\": \"now\",\n \"textfetch\": \"now\",\n \"hidden\": \"0\",\n \"preview_mime\": \"\",\n \"preview_data\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/3/messages/4/user\"\n },\n \"id\": \"4\",\n \"user\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"3\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[],"url":"/messages","method":"get"},"isReference":true,"order":4,"slug":"list-all-messages","type":"endpoint","title":"List all messages","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"66bccbe3356fa0003cd166d9","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Variables","icon":"","type":"basic","slug":"variables","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"personalizations","parentDoc":null,"category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T15:23:15.994Z","isBodyEmpty":false,"children":[{"_id":"66bcd2a57e861500195a7514","api":{"method":"get","url":"/personalizations","auth":"required","results":{"codes":[{"name":"","code":"{\n \"personalizations\": [\n {\n \"name\": \"address\",\n \"tag\": \"awesometag\",\n \"format\": \"html\",\n \"content\": \"this is the first content\",\n \"listIds\": \"1,2,3\",\n \"listNames\": \"List1,List2,List3\",\n \"links\": [\n \n ],\n \"id\": \"1\"\n },\n {\n \"name\": \"phone\",\n \"tag\": \"greattag\",\n \"format\": \"html\",\n \"content\": \"this is the second one\",\n \"listIds\": \"3,4\",\n \"listNames\": \"List3,List4\",\n \"links\": [\n \n ],\n \"id\": \"2\"\n },\n {\n \"name\": \"nice\\n\",\n \"tag\": \"hellotag\",\n \"format\": \"text\",\n \"content\": \"this is the third one\",\n \"listIds\": \"1,3\",\n \"listNames\": \"List1,List3\",\n \"links\": [\n \n ],\n \"id\": \"3\"\n },\n {\n \"name\": \"hahah\",\n \"tag\": \"goodtag\",\n \"format\": \"html\",\n \"content\": \"fourth\",\n \"listIds\": \"1,4\",\n \"listNames\": \"List1,List4\",\n \"links\": [\n \n ],\n \"id\": \"4\"\n },\n {\n \"name\": \"hello world\",\n \"tag\": \"nicetag\",\n \"format\": \"text\",\n \"content\": \"fifth\",\n \"listIds\": \"2,3,4\",\n \"listNames\": \"List2,List3,List4\",\n \"links\": [\n \n ],\n \"id\": \"5\"\n }\n ],\n \"meta\": {\n \"total\": \"5\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"orders[format]","type":"string","enumValues":"","default":"","desc":"Order variables by format (ASC/DESC)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eb0"},{"name":"orders[tag]","type":"string","enumValues":"","default":"","desc":"Order variables by tag (ASC/DESC)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eaf"},{"name":"orders[name]","type":"string","enumValues":"","default":"","desc":"Order variables by name (ASC/DESC)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eae"},{"name":"orders[content]","type":"string","enumValues":"","default":"","desc":"Order variables by content (ASC/DESC)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29ead"},{"name":"filter[name]","type":"string","enumValues":"","default":"","desc":"Filter by variable name","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eac"},{"name":"filter[tag]","type":"string","enumValues":"","default":"","desc":"Filter by variable tag","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eab"},{"name":"filter[listName]","type":"string","enumValues":"","default":"","desc":"Filter by name of list","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29eaa"},{"name":"filter[content]","type":"string","enumValues":"","default":"","desc":"Contents of variable","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29ea9"},{"name":"filter[format]","type":"string","enumValues":"","default":"","desc":"Filter by tag format (html, text)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29ea8"},{"name":"limit","type":"int","enumValues":"","default":"20","desc":"Result limit (Default: 20)","required":false,"in":"query","ref":"","_id":"66bce8def7499f002bb29ea7"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List Variables","icon":"","type":"endpoint","slug":"list-variables","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-personalizations","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T15:52:05.820Z","isBodyEmpty":false,"children":[]},{"_id":"66bce93a5b5c150067f63f19","api":{"method":"get","url":"/personalizations/{variableID}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"personalization\": {\n \"name\": \"brand new name\",\n \"tag\": \"brand-new-tag\",\n \"format\": \"text\",\n \"content\": \"Hello World!\",\n \"listIds\": \"2,3,5,4\",\n \"listNames\": \"Another List,League Players,real,Test Segmentation\",\n \"listsCount\": \"4\",\n \"links\": [],\n \"id\": \"8\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for Personalization with id 22\"\n}","language":"json","status":404}]},"params":[{"name":"variableID","type":"int","enumValues":"","default":"","desc":"ID (int) of variable","required":false,"in":"path","ref":"","_id":"66bce9bbb76e170015a11e90"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Retrieve a Variable","icon":"","type":"endpoint","slug":"retrieve-variable","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-personalization","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T17:28:26.252Z","isBodyEmpty":false,"children":[]},{"_id":"66bceac816f850000f01f8f2","api":{"method":"post","url":"/personalizations","auth":"required","results":{"codes":[{"name":"","code":"{\n \"personalization\": {\n \"tag\": \"brand-new-tag\",\n \"name\": \"brand new name\",\n \"format\": \"text\",\n \"content\": \"Hello World!\",\n \"listids\": \"2,3,4,5\",\n \"userid\": \"1\",\n \"links\": [],\n \"id\": \"8\"\n }\n}","language":"json","status":200}]},"params":[{"name":"personalization.tag","type":"string","enumValues":"","default":"","desc":"tag name","required":false,"in":"body","ref":"","_id":"66bcec1891789e002a202211"},{"name":"personalization.name","type":"string","enumValues":"","default":"","desc":"Tag name","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf3"},{"name":"personalization.format","type":"string","enumValues":"","default":"","desc":"\"html\" or \"text\"","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf2"},{"name":"personalization.content","type":"string","enumValues":"","default":"","desc":"Personalization/Variable contents","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf1"},{"name":"personalization.listids","type":"string","enumValues":"","default":"","desc":"Comma-separated list of list ids (string), ie: \"2,3,4,5\"","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf0"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a Variable","icon":"","type":"endpoint","slug":"create-variable","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-personalization","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T17:35:04.254Z","isBodyEmpty":false,"children":[]},{"_id":"66bced92bbdc790068c9432e","api":{"method":"put","url":"/personalizations/{variableID}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"personalization\": {\n \"userid\": \"1\",\n \"tag\": \"brand-new-tag\",\n \"name\": \"changed name\",\n \"content\": \"Hello World!\",\n \"format\": \"text\",\n \"created_timestamp\": \"2024-08-14 12:31:35\",\n \"updated_timestamp\": \"2024-08-14 12:31:35\",\n \"created_by\": null,\n \"updated_by\": null,\n \"listids\": \"2,3,4,5\",\n \"links\": [],\n \"id\": \"8\"\n }\n}","language":"json","status":200},{"code":"{\n \"message\": \"No Result found for ActiveCampaign\\\\Hosted\\\\Personalization\\\\Personalization with id 22\"\n}","language":"json","status":404}]},"params":[{"name":"personalization.tag","type":"string","enumValues":"","default":"","desc":"tag name","required":false,"in":"body","ref":"","_id":"66bcec1891789e002a202211"},{"name":"personalization.name","type":"string","enumValues":"","default":"","desc":"Tag name","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf3"},{"name":"personalization.format","type":"string","enumValues":"","default":"","desc":"\"html\" or \"text\"","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf2"},{"name":"personalization.content","type":"string","enumValues":"","default":"","desc":"Personalization/Variable contents","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf1"},{"name":"personalization.listids","type":"string","enumValues":"","default":"","desc":"Comma-separated list of list ids (string), ie: \"2,3,4,5\"","required":false,"in":"body","ref":"","_id":"66bced86b143f7002baafdf0"},{"name":"variableID","type":"int","enumValues":"","default":"","desc":"ID (int) of personalization/variable","required":false,"in":"path","ref":"","_id":"66bceea1b76e170015a12667"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Edit a Variable","icon":"","type":"endpoint","slug":"edit-variable","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"edit-personalization","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T17:46:58.288Z","isBodyEmpty":false,"children":[]},{"_id":"66bcef289ef74c00147c8d6e","api":{"method":"delete","url":"/personalizations/{variableID}","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"code":"{\n \"message\": \"No Result found for Personalization with id 22\"\n}","language":"json","status":400}]},"params":[{"name":"variableID","type":"int","enumValues":"","default":"","desc":"ID (int) of personalization/variable","required":false,"in":"path","ref":"","_id":"66bceea1b76e170015a12667"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a Variable","icon":"","type":"endpoint","slug":"delete-variable","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-personalization","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T17:53:44.448Z","isBodyEmpty":false,"children":[]},{"_id":"66bcefb3bbdc790068c9510e","api":{"method":"delete","url":"/personalizations/bulkdelete","auth":"required","results":{"codes":[{"name":"","code":"Delete successful","language":"text","status":200}]},"params":[{"name":"ids","type":"mixed","enumValues":"","default":"","desc":"List of variables to be deleted, ie: 1,2,3","required":false,"in":"query","ref":"","_id":"66bcf02a194b6000109bd694"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Bulk Delete Variables","icon":"","type":"endpoint","slug":"bulk-delete-variables","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"bulk-delete-personalizations","parentDoc":"66bccbe3356fa0003cd166d9","category":"5b96c453ff009a0003fd13cd","createdAt":"2024-08-14T17:56:03.064Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"58c02f80b094740f005116e3","isAPI":false,"reference":true,"createdAt":"2017-03-08T16:21:20.333Z","from_sync":false,"title":"Contacts","project":"57b6f40e480bae1900ce4e21","order":9,"slug":"contact","__v":0,"version":"57b6f40e480bae1900ce4e24","pages":[{"_id":"58c02fb2ab93d80f0027119f","hidden":false,"link_external":false,"order":0,"slug":"contact","sync_unique":"","link_url":"","title":"Contacts","createdAt":"2017-03-08T16:22:10.450Z","type":"basic","isReference":true,"parentDoc":null,"api":{"results":{"codes":[{"language":"json","code":"{}","name":"","status":200},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[{"_id":"5f3ca7ca3939b40023472262","api":{"method":"post","url":"/contacts","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"contact\": {\n\t\t\"email\": \"johndoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\",\n\t\t\"phone\": \"7223224241\",\n \"fieldValues\":[\n {\n \"field\":\"1\",\n \"value\":\"The Value for First Field\"\n },\n {\n \"field\":\"6\",\n \"value\":\"2008-01-20\"\n }\n ]\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"fieldValues\": [\n {\n \"contact\": \"113\",\n \"field\": \"1\",\n \"value\": \"The Value for First Field\",\n \"cdate\": \"2020-08-01T10:54:59-05:00\",\n \"udate\": \"2020-08-01T14:13:34-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/11797/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/11797/field\"\n },\n \"id\": \"11797\",\n \"owner\": \"113\"\n },\n {\n \"contact\": \"113\",\n \"field\": \"6\",\n \"value\": \"2008-01-20\",\n \"cdate\": \"2020-08-01T10:54:59-05:00\",\n \"udate\": \"2020-08-01T14:13:34-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/11798/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/11798/field\"\n },\n \"id\": \"11798\",\n \"owner\": \"113\"\n }\n ],\n \"contact\": {\n \"email\": \"johndoe@example.com\",\n \"cdate\": \"2018-09-28T13:50:41-05:00\",\n \"udate\": \"2018-09-28T13:50:41-05:00\",\n \"orgid\": \"\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/113/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/113/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/113/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/113/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/113/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/113/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/113/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/113/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/113/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/113/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/113/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/113/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/113/scoreValues\"\n },\n \"id\": \"113\",\n \"organization\": \"\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\":\"No Result found for Subscriber with id 1\"\n}","name":""},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"Email address already exists in the system\",\n \"detail\": \"\",\n \"code\": \"duplicate\",\n \"source\": {\n \"pointer\": \"/data/attributes/email\"\n }\n }\n ]\n}"}]},"params":[{"name":"contact.email","type":"string","enumValues":"","default":"","desc":"Email address of the new contact. Example: 'test@example.com'","required":true,"in":"body","ref":"","_id":"5b96c8d4246f0d0003a6e9b6"},{"name":"contact.firstName","type":"string","enumValues":"","default":"","desc":"First name of the new contact.","required":false,"in":"body","ref":"","_id":"5b96c8d4246f0d0003a6e9b5"},{"name":"contact.lastName","type":"string","enumValues":"","default":"","desc":"Last name of the new contact.","required":false,"in":"body","ref":"","_id":"5b96c8d4246f0d0003a6e9b4"},{"name":"contact.phone","type":"string","enumValues":"","default":"","desc":"Phone number of the contact.","required":false,"in":"body","ref":"","_id":"5baeae1a8d23fa00036459d2"},{"name":"contact.fieldValues","type":"array_object","enumValues":"","default":"","desc":"Contact's custom field values [{field id, value}]","required":false,"in":"body","ref":"","_id":"5f3d997be9fc450b13a34611"},{"name":"contact.orgid","type":"int","enumValues":"","default":"","desc":"(Deprecated) Please use Account-Contact end points","required":false,"in":"body","ref":"","_id":"5baeadf7b331870003a6efa7"}]},"title":"Create a contact","type":"endpoint","slug":"create-a-new-contact","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-contact-new","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2020-08-19T04:17:14.211Z","category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5f3d9abc9f9d5c0c753020d2","api":{"method":"post","url":"/contact/sync","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"contact\": {\n\t\t\"email\": \"jondoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\",\n\t\t\"phone\": \"7223224241\",\n \"fieldValues\":[\n {\n \"field\":\"1\",\n \"value\":\"The Value for First Field\"\n },\n {\n \"field\":\"6\",\n \"value\":\"2008-01-20\"\n }\n ]\n\t}\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"fieldValues\": [\n {\n \"contact\": \"10\",\n \"field\": \"2\",\n \"value\": \"Albany\",\n \"cdate\": \"2022-04-14T10:03:23-05:00\",\n \"udate\": \"2022-04-14T10:03:23-05:00\",\n \"created_by\": null,\n \"updated_by\": null,\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/14/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/14/field\"\n },\n \"id\": \"14\",\n \"owner\": \"10\"\n },\n {\n \"contact\": \"10\",\n \"field\": \"3\",\n \"value\": \"Georgia\",\n \"cdate\": \"2022-04-14T10:03:23-05:00\",\n \"udate\": \"2022-04-14T10:03:23-05:00\",\n \"created_by\": null,\n \"updated_by\": null,\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/15/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/15/field\"\n },\n \"id\": \"15\",\n \"owner\": \"10\"\n }\n ],\n \"contact\": {\n \"email\": \"johndoe@example.com\",\n \"phone\": \"7223224241\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email_empty\": false,\n \"cdate\": \"2022-04-14T10:03:23-05:00\",\n \"udate\": \"2022-04-14T10:03:23-05:00\",\n \"orgid\": \"\",\n \"orgname\": \"\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/3/contacts/10/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/3/contacts/10/contactAutomations?limit=1000&orders%5Blastdate%5D=DESC\",\n \"contactData\": \"https://:account.api-us1.com/api/3/contacts/10/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/3/contacts/10/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/3/contacts/10/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/3/contacts/10/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/3/contacts/10/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/3/contacts/10/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/3/contacts/10/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/3/contacts/10/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/3/contacts/10/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/3/contacts/10/notes\",\n \"organization\": \"https://:account.api-us1.com/api/3/contacts/10/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/3/contacts/10/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/3/contacts/10/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/3/contacts/10/scoreValues\",\n \"accountContacts\": \"https://:account.api-us1.com/api/3/contacts/10/accountContacts\",\n \"automationEntryCounts\": \"https://:account.api-us1.com/api/3/contacts/10/automationEntryCounts\"\n },\n \"hash\": \"75b8163f768dff1f0f7b5f69476b986a\",\n \"fieldValues\": [\n \"14\",\n \"15\"\n ],\n \"id\": \"10\",\n \"organization\": \"\"\n }\n}","language":"json","status":201},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"contact.email","type":"string","enumValues":"","default":"","desc":"Email address of the contact to sync","required":true,"in":"body","ref":"","_id":"5ba1223eb882f80003ccc494"},{"name":"contact.firstName","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5baeab5d85f2960003bd0946"},{"name":"contact.lastName","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5baeab5d85f2960003bd0945"},{"name":"contact.phone","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5baeab5d85f2960003bd0944"},{"name":"contact.fieldValues","type":"array_object","enumValues":"","default":"","desc":"Contact's custom field values [{field, value}]","required":false,"in":"body","ref":"","_id":"5f3d9abc9f9d5c0c753020d3"},{"name":"contact.orgid","type":"int","enumValues":"","default":"","desc":"(Deprecated) Please use Account-Contact end points","required":false,"in":"body","ref":"","_id":"5baeada2b9539e00039de45e"},{"name":"contact.deleted","type":"boolean","enumValues":"","default":"","desc":"(Deprecated) Please use the DELETE endpoint","required":false,"in":"body","ref":"","_id":"5baeadde8d23fa00036459cc"}]},"title":"Sync a contact's data","type":"endpoint","slug":"sync-a-contacts-data","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-or-update-contact","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2020-08-19T21:33:48.013Z","category":"58c02f80b094740f005116e3","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5951601fc471ab001b3088bb","category":"58c02f80b094740f005116e3","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2017-06-26T19:27:27.102Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactAutomations\": [\n {\n \"contact\": \"1\",\n \"seriesid\": \"1\",\n \"startid\": \"0\",\n \"status\": \"0\",\n \"adddate\": \"1976-10-16T23:23:09-05:00\",\n \"remdate\": null,\n \"timespan\": null,\n \"lastblock\": \"0\",\n \"lastdate\": \"1984-08-15T08:13:44-05:00\",\n \"completedElements\": \"0\",\n \"totalElements\": \"0\",\n \"completed\": 0,\n \"completeValue\": 100,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/automation\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/contact\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/contactGoals\"\n },\n \"id\": \"1\",\n \"automation\": \"1\"\n }\n ],\n \"contactLists\": [\n {\n \"contact\": \"1\",\n \"list\": \"1\",\n \"form\": null,\n \"seriesid\": \"0\",\n \"sdate\": null,\n \"udate\": null,\n \"status\": \"1\",\n \"responder\": \"1\",\n \"sync\": \"0\",\n \"unsubreason\": null,\n \"campaign\": null,\n \"message\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"ip4Sub\": \"0\",\n \"sourceid\": \"0\",\n \"autosyncLog\": null,\n \"ip4_last\": \"0\",\n \"ip4Unsub\": \"0\",\n \"unsubscribeAutomation\": null,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactLists/1/automation\",\n \"list\": \"https://:account.api-us1.com/api/:version/contactLists/1/list\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactLists/1/contact\",\n \"form\": \"https://:account.api-us1.com/api/:version/contactLists/1/form\",\n \"autosyncLog\": \"https://:account.api-us1.com/api/:version/contactLists/1/autosyncLog\",\n \"campaign\": \"https://:account.api-us1.com/api/:version/contactLists/1/campaign\",\n \"unsubscribeAutomation\": \"https://:account.api-us1.com/api/:version/contactLists/1/unsubscribeAutomation\",\n \"message\": \"https://:account.api-us1.com/api/:version/contactLists/1/message\"\n },\n \"id\": \"1\",\n \"automation\": null\n }\n ],\n \"deals\": [\n {\n \"owner\": \"1\",\n \"contact\": \"1\",\n \"organization\": null,\n \"group\": null,\n \"title\": \"Consectetur omnis quo inventore molestiae ratione amet.\",\n \"nexttaskid\": \"0\",\n \"currency\": \"USD\",\n \"status\": \"0\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/:version/deals/1/activities\",\n \"contact\": \"https://:account.api-us1.com/api/:version/deals/1/contact\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/deals/1/contactDeals\",\n \"group\": \"https://:account.api-us1.com/api/:version/deals/1/group\",\n \"nextTask\": \"https://:account.api-us1.com/api/:version/deals/1/nextTask\",\n \"notes\": \"https://:account.api-us1.com/api/:version/deals/1/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/deals/1/organization\",\n \"owner\": \"https://:account.api-us1.com/api/:version/deals/1/owner\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/deals/1/scoreValues\",\n \"stage\": \"https://:account.api-us1.com/api/:version/deals/1/stage\",\n \"tasks\": \"https://:account.api-us1.com/api/:version/deals/1/tasks\"\n },\n \"id\": \"1\",\n \"nextTask\": null\n }\n ],\n \"fieldValues\": [\n {\n \"contact\": \"1\",\n \"field\": \"1\",\n \"value\": null,\n \"cdate\": \"1981-05-16T19:02:29-05:00\",\n \"udate\": \"1975-11-08T10:31:45-06:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/:version/fieldValues/1/owner\",\n \"field\": \"https://:account.api-us1.com/api/:version/fieldValues/1/field\"\n },\n \"id\": \"1\",\n \"owner\": \"1\"\n }\n ],\n \"geoAddresses\": [\n {\n \"ip4\": \"823\",\n \"country2\": \"AS\",\n \"country\": \"Suriname\",\n \"state\": \"KY\",\n \"city\": \"North Arnoldomouth\",\n \"zip\": \"38704-6592\",\n \"area\": \"0\",\n \"lat\": \"-70.160407\",\n \"lon\": \"-102.229406\",\n \"tz\": \"Europe/Chisinau\",\n \"tstamp\": \"1972-03-16T07:26:58-06:00\",\n \"links\": [\n \n ],\n \"id\": \"1\"\n }\n ],\n \"geoIps\": [\n {\n \"contact\": \"1\",\n \"campaignid\": \"1\",\n \"messageid\": \"1\",\n \"geoaddrid\": \"1\",\n \"ip4\": \"0\",\n \"tstamp\": \"1988-08-05T11:50:51-05:00\",\n \"geoAddress\": \"1\",\n \"links\": {\n \"geoAddress\": \"https://:account.api-us1.com/api/:version/geoIps/1/geoAddress\"\n },\n \"id\": \"1\"\n }\n ],\n \"contact\": {\n \"cdate\": \"2007-05-05T12:49:09-05:00\",\n \"email\": \"selmer.koss@example.com\",\n \"phone\": \"\",\n \"firstName\": \"Charles\",\n \"lastName\": \"Reynolds\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"0\",\n \"ua\": null,\n \"hash\": \"\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"adate\": null,\n \"udate\": null,\n \"edate\": null,\n \"contactAutomations\": [\n \"1\"\n ],\n \"contactLists\": [\n \"1\"\n ],\n \"fieldValues\": [\n \"1\"\n ],\n \"geoIps\": [\n \"1\"\n ],\n \"deals\": [\n \"1\"\n ],\n \"accountContacts\": [\n \"1\"\n ],\n \"links\": {\n \"bounceLogs\": \"/1/bounceLogs\",\n \"contactAutomations\": \"/1/contactAutomations\",\n \"contactData\": \"/1/contactData\",\n \"contactGoals\": \"/1/contactGoals\",\n \"contactLists\": \"/1/contactLists\",\n \"contactLogs\": \"/1/contactLogs\",\n \"contactTags\": \"/1/contactTags\",\n \"contactDeals\": \"/1/contactDeals\",\n \"deals\": \"/1/deals\",\n \"fieldValues\": \"/1/fieldValues\",\n \"geoIps\": \"/1/geoIps\",\n \"notes\": \"/1/notes\",\n \"organization\": \"/1/organization\",\n \"plusAppend\": \"/1/plusAppend\",\n \"trackingLogs\": \"/1/trackingLogs\",\n \"scoreValues\": \"/1/scoreValues\"\n },\n \"id\": \"1\",\n \"organization\": null\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\":\"No Result found for Subscriber with id 1\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"595160b96aff60001ba5967e"}],"url":"/contacts/:id","method":"get","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":2,"slug":"get-contact","type":"endpoint","title":"Retrieve a contact","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bc633283bd9f800432c3d9d","category":"58c02f80b094740f005116e3","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2018-10-16T18:51:20.295Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2017-07-24T12:09:52-05:00\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"1234567890\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"1\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2018-10-16T13:52:32-05:00\",\n \"udate\": \"2018-10-16T13:50:18-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"created_utc_timestamp\": \"2018-10-01 08:40:10\",\n \"updated_utc_timestamp\": \"2018-10-16 13:50:18\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/1/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/1/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/1/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/1/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/1/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/1/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/1/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/1/contactDeals\",\n \"deals\": \"https://staging-tjahn.api-us1.com/api/3/contacts/1/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/1/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/1/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/1/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/1/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/1/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/1/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/1/scoreValues\"\n },\n \"id\": \"1\",\n \"organization\": null\n }\n ],\n \"contactList\": {\n \"contact\": \"1\",\n \"list\": \"2\",\n \"form\": null,\n \"seriesid\": \"0\",\n \"sdate\": \"2018-10-16T13:52:35-05:00\",\n \"status\": 1,\n \"responder\": \"1\",\n \"sync\": \"0\",\n \"unsubreason\": \"\",\n \"campaign\": null,\n \"message\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"ip4Sub\": \"0\",\n \"sourceid\": \"3\",\n \"autosyncLog\": null,\n \"ip4_last\": \"0\",\n \"ip4Unsub\": \"0\",\n \"unsubscribeAutomation\": null,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactLists/2/automation\",\n \"list\": \"https://:account.api-us1.com/api/:version/contactLists/2/list\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactLists/2/contact\",\n \"form\": \"https://:account.api-us1.com/api/:version/contactLists/2/form\",\n \"autosyncLog\": \"https://:account.api-us1.com/api/:version/contactLists/2/autosyncLog\",\n \"campaign\": \"https://:account.api-us1.com/api/:version/contactLists/2/campaign\",\n \"unsubscribeAutomation\": \"https://:account.api-us1.com/api/:version/contactLists/2/unsubscribeAutomation\",\n \"message\": \"https://:account.api-us1.com/api/:version/contactLists/2/message\"\n },\n \"id\": \"2\",\n \"automation\": null\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"contactList.list","type":"string","enumValues":"","default":"","desc":"ID of the list to subscribe the contact to","required":true,"in":"body","ref":"","_id":"5bc633fb8f349e00126863e9"},{"name":"contactList.contact","type":"string","enumValues":"","default":"","desc":"ID of the contact to subscribe to the list","required":true,"in":"body","ref":"","_id":"5bc633fb8f349e00126863e8"},{"name":"contactList.status","type":"string","enumValues":"","default":"","desc":"Set to \"1\" to subscribe the contact to the list. Set to \"2\" to unsubscribe the contact from the list. WARNING: If you change a status from unsubscribed to active, you can re-subscribe a contact to a list from which they had manually unsubscribed.","required":true,"in":"body","ref":"","_id":"5bc633fb8f349e00126863e7"},{"name":"contactList.sourceid","type":"int","enumValues":"","default":"0","desc":"Set to \"4\" when re-subscribing a contact to a list","required":false,"in":"body","ref":"","_id":"5d484ad922308801ad85c58e"}],"url":"/contactLists","method":"post","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n \"contactList\": {\n \"list\": 2,\n \"contact\": 1,\n \"status\": 1\n }\n}"}]}},"isReference":true,"order":3,"slug":"update-list-status-for-contact","type":"endpoint","title":"Update list status for a contact","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5f3d9c0e096e9b0d18fe8f8f","api":{"method":"put","url":"/contacts/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"contact\": {\n\t\t\"email\": \"johndoe@example.com\",\n\t\t\"firstName\": \"John\",\n\t\t\"lastName\": \"Doe\",\n \"fieldValues\":[\n {\n \"field\":\"1\",\n \"value\":\"The Value for First Field\"\n },\n {\n \"field\":\"6\",\n \"value\":\"2008-01-20\"\n }\n ]\n\t}\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"fieldValues\": [\n {\n \"contact\": \"113\",\n \"field\": \"1\",\n \"value\": \"The Value for First Field\",\n \"cdate\": \"2020-08-01T10:54:59-05:00\",\n \"udate\": \"2020-08-01T14:13:34-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/11797/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/11797/field\"\n },\n \"id\": \"11797\",\n \"owner\": \"113\"\n },\n {\n \"contact\": \"113\",\n \"field\": \"6\",\n \"value\": \"2008-01-20\",\n \"cdate\": \"2020-08-01T10:54:59-05:00\",\n \"udate\": \"2020-08-01T14:13:34-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/11798/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/11798/field\"\n },\n \"id\": \"11798\",\n \"owner\": \"113\"\n }\n ],\n \"contact\": {\n \"cdate\": \"2018-09-28T13:50:41-05:00\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"0\",\n \"ua\": null,\n \"hash\": \"8309146b50af1ed5f9cb40c7465a0315\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": \"2018-09-28T13:55:59-05:00\",\n \"edate\": null,\n \"deleted_at\": null,\n \"created_utc_timestamp\": \"2018-09-28 13:50:41\",\n \"updated_utc_timestamp\": \"2018-09-28 13:50:41\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/113/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/113/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/113/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/113/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/113/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/113/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/113/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/113/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/113/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/113/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/113/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/113/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/113/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/113/scoreValues\"\n },\n \"id\": \"113\",\n \"organization\": null\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 1\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact to update","required":false,"in":"path","ref":"","_id":"5b998db39643d70003495a12"},{"name":"contact.email","type":"string","enumValues":"","default":"","desc":"Contact's email address","required":false,"in":"body","ref":"","_id":"5bae775f85f2960003bd0348"},{"name":"contact.firstName","type":"string","enumValues":"","default":"","desc":"Contact's first name","required":false,"in":"body","ref":"","_id":"5bae7b59b331870003a6ec76"},{"name":"contact.lastName","type":"string","enumValues":"","default":"","desc":"Contact's last name","required":false,"in":"body","ref":"","_id":"5bae7b59b331870003a6ec75"},{"name":"contact.phone","type":"string","enumValues":"","default":"","desc":"Contact's phone number","required":false,"in":"body","ref":"","_id":"5bae7b59b331870003a6ec74"},{"name":"contact.fieldValues","type":"array_object","enumValues":"","default":"","desc":"Contact's custom field values [{field, value}]","required":false,"in":"body","ref":"","_id":"5f3d9cae5249c50c365b4dee"},{"name":"contact.deleted","type":"boolean","enumValues":"","default":"","desc":"(Deprecated) Please use the the Delete endpoint","required":false,"in":"body","ref":"","_id":"5baeae49b9539e00039de466"},{"name":"contact.orgid","type":"int","enumValues":"","default":"","desc":"(Deprecated) Please use Account-Contact end points","required":false,"in":"body","ref":"","_id":"5baeae49b9539e00039de465"}]},"title":"Update a contact","type":"endpoint","slug":"update-a-contact-new","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2020-08-19T21:39:26.756Z","category":"58c02f80b094740f005116e3","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5969050a543d55002958f614","category":"58c02f80b094740f005116e3","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2017-07-14T17:53:14.991Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}"},{"status":404,"language":"json","code":"{\n \"message\":\"No result found for contact with id 1\"\n}"}]},"examples":{"codes":[]},"auth":"required","params":[{"_id":"59414f253f18ca002f606431","ref":"","in":"path","required":false,"desc":"The contact id","default":"","type":"int","name":"id"}],"url":"/contacts/:id","method":"delete","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":5,"slug":"delete-contact","type":"endpoint","title":"Delete a contact","isBodyEmpty":true,"children":[]},{"_id":"58c0327cab93d80f00271206","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"ids","type":"string","enumValues":"","default":"","desc":"Filter contacts by ID. Can be repeated for multiple IDs. Example: ids[]=1&ids[]=2&ids[]=42","required":false,"in":"query","ref":"","_id":"5910bca90f517e0f006cca6a"},{"name":"email","type":"string","enumValues":"","default":"","desc":"Email address of the contact you want to get","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688e"},{"name":"email_like","type":"string","enumValues":"","default":"","desc":"Filter contacts that contain the given value in the email address","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e6886"},{"name":"exclude","type":"int","enumValues":"","default":"","desc":"Exclude from the response the contact with the given ID","required":false,"in":"query","ref":"","_id":"5910bca90f517e0f006cca69"},{"name":"formid","type":"int","enumValues":"","default":"","desc":"Filter contacts associated with the given form","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e6889"},{"name":"id_greater","type":"int","enumValues":"","default":"","desc":"Only include contacts with an ID greater than the given ID","required":false,"in":"query","ref":"","_id":"5909f591954476190041e2f7"},{"name":"id_less","type":"int","enumValues":"","default":"","desc":"Only include contacts with an ID less than the given ID","required":false,"in":"query","ref":"","_id":"5909f591954476190041e2f6"},{"name":"listid","type":"string","enumValues":"","default":"","desc":"Filter contacts associated with the given list","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688d"},{"name":"phone","type":"string","enumValues":"","default":"","desc":"Filter contacts where the phone number starts with the given value","required":false,"in":"query","ref":"","_id":"6708d50b0b8f1100112991d2"},{"name":"organization","type":"int","enumValues":"","default":"","desc":"(Deprecated) Please use Account-Contact end points. Filter contacts associated with the given organization ID","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e6887"},{"name":"search","type":"string","enumValues":"","default":"null","desc":"Filter contacts that match the given value in the contact names, organization, phone or email","required":false,"in":"query","ref":"","_id":"5909f591954476190041e2f2"},{"name":"segmentid","type":"int","enumValues":"","default":"null","desc":"Return only contacts that match a list segment (the first call kicks off an asynchronous query. When the query is complete, subsequent API calls will return contacts that match the segment - timeout 1hr)","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688a"},{"name":"seriesid","type":"int","enumValues":"","default":"","desc":"Filter contacts associated with the given automation","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e6888"},{"name":"status","type":"int","enumValues":"","default":"-1","desc":"See [available values](https://developers.activecampaign.com/reference/contact)","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688c"},{"name":"tagid","type":"int","enumValues":"","default":"","desc":"Filter contacts associated with the given tag","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688b"},{"name":"filters[created_before]","type":"datetime","enumValues":"","default":"","desc":"Filter contacts that were created prior to this date","required":false,"in":"query","ref":"","_id":"5ada07cd6c55b100035dddbb"},{"name":"filters[created_after]","type":"datetime","enumValues":"","default":"","desc":"Filter contacts that were created after this date","required":false,"in":"query","ref":"","_id":"5ada07cd6c55b100035dddba"},{"name":"filters[updated_before]","type":"datetime","enumValues":"","default":"","desc":"Filter contacts that were updated before this date","required":false,"in":"query","ref":"","_id":"5ada07cd6c55b100035dddb9"},{"name":"filters[updated_after]","type":"datetime","enumValues":"","default":"","desc":"Filter contacts that were updated after this date","required":false,"in":"query","ref":"","_id":"5ada07cd6c55b100035dddb8"},{"name":"waitid","type":"int","enumValues":"","default":"","desc":"Filter by contacts in the wait queue of an automation block","required":false,"in":"query","ref":"","_id":"590cd84d3972770f003dc3ba"},{"name":"orders[id]","type":"string","enumValues":"","default":"ASC","desc":"Order contacts by unique ID","required":false,"in":"query","ref":"","_id":"65f5f3f8d668db0018c0ac32"},{"name":"orders[cdate]","type":"string","enumValues":"","default":"","desc":"Order contacts by creation date","required":false,"in":"query","ref":"","_id":"58d1653c82bad51900a3cf81"},{"name":"orders[email]","type":"string","enumValues":"","default":"ASC","desc":"Order contacts by email","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e6885"},{"name":"orders[first_name]","type":"string","enumValues":"","default":"","desc":"Order contacts by first name","required":false,"in":"query","ref":"","_id":"58d1653c82bad51900a3cf83"},{"name":"orders[last_name]","type":"string","enumValues":"","default":"","desc":"Order contacts by last name","required":false,"in":"query","ref":"","_id":"58d1653c82bad51900a3cf82"},{"name":"orders[name]","type":"string","enumValues":"","default":"","desc":"Order contacts by full name","required":false,"in":"query","ref":"","_id":"58d1653c82bad51900a3cf84"},{"name":"orders[score]","type":"string","enumValues":"","default":"","desc":"Order contacts by score","required":false,"in":"query","ref":"","_id":"5911c4b7076ce90f007f93c5"},{"name":"in_group_lists","type":"string","enumValues":"","default":"","desc":"Set this to \"true\" in order to return only contacts that the current user has permissions to see.","required":false,"in":"query","ref":"","_id":"5b1ebd839410c700033dbbf9"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contacts\":[\n {\n \"cdate\":\"2017-01-25T23:58:14-06:00\",\n \"email\":\"janedoe@example.com\",\n \"phone\":\"3120000000\",\n \"firstName\":\"John\",\n \"lastName\":\"Doe\",\n \"orgid\":\"0\",\n \"segmentio_id\":\"\",\n \"bounced_hard\":\"0\",\n \"bounced_soft\":\"0\",\n \"bounced_date\":\"0000-00-00\",\n \"ip\":\"0\",\n \"ua\":\"\",\n \"hash\":\"31e076c964f4262817f9ba302c96e1c6\",\n \"socialdata_lastcheck\":\"0000-00-00 00:00:00\",\n \"email_local\":\"\",\n \"email_domain\":\"\",\n \"sentcnt\":\"0\",\n \"rating_tstamp\":\"0000-00-00\",\n \"gravatar\":\"3\",\n \"deleted\":\"0\",\n \"adate\":\"2017-02-22 15:26:24\",\n \"udate\":\"2017-01-25T23:58:14-06:00\",\n \"edate\":\"2017-01-27 14:44:13\",\n \"scoreValues\":[\n\n ],\n \"links\":{\n \"bounceLogs\":\"https://:account.api-us1.com/api/:version/contacts/68/bounceLogs\",\n \"contactAutomations\":\"https://:account.api-us1.com/api/:version/contacts/68/contactAutomations\",\n \"contactData\":\"https://:account.api-us1.com/api/:version/contacts/68/contactData\",\n \"contactGoals\":\"https://:account.api-us1.com/api/:version/contacts/68/contactGoals\",\n \"contactLists\":\"https://:account.api-us1.com/api/:version/contacts/68/contactLists\",\n \"contactLogs\":\"https://:account.api-us1.com/api/:version/contacts/68/contactLogs\",\n \"contactTags\":\"https://:account.api-us1.com/api/:version/contacts/68/contactTags\",\n \"contactDeals\":\"https://:account.api-us1.com/api/:version/contacts/68/contactDeals\",\n \"deals\":\"https://:account.api-us1.com/api/:version/contacts/68/deals\",\n \"fieldValues\":\"https://:account.api-us1.com/api/:version/contacts/68/fieldValues\",\n \"geoIps\":\"https://:account.api-us1.com/api/:version/contacts/68/geoIps\",\n \"notes\":\"https://:account.api-us1.com/api/:version/contacts/68/notes\",\n \"organization\":\"https://:account.api-us1.com/api/:version/contacts/68/organization\",\n \"plusAppend\":\"https://:account.api-us1.com/api/:version/contacts/68/plusAppend\",\n \"trackingLogs\":\"https://:account.api-us1.com/api/:version/contacts/68/trackingLogs\",\n \"scoreValues\":\"https://:account.api-us1.com/api/:version/contacts/68/scoreValues\"\n },\n \"id\":\"68\",\n \"organization\":null\n },\n {\n \"cdate\":\"2017-02-09T12:14:58-06:00\",\n \"email\":\"aaronallen@example.com\",\n \"phone\":\"\",\n \"firstName\":\"Aaron\",\n \"lastName\":\"Allen\",\n \"orgid\":\"14\",\n \"segmentio_id\":\"\",\n \"bounced_hard\":\"0\",\n \"bounced_soft\":\"0\",\n \"bounced_date\":\"0000-00-00\",\n \"ip\":\"0\",\n \"ua\":\"\",\n \"hash\":\"31b92c033c3e55de6d9eb9c44ee1bfa5\",\n \"socialdata_lastcheck\":\"0000-00-00 00:00:00\",\n \"email_local\":\"\",\n \"email_domain\":\"\",\n \"sentcnt\":\"0\",\n \"rating_tstamp\":\"0000-00-00\",\n \"gravatar\":\"1\",\n \"deleted\":\"0\",\n \"adate\":\"2017-03-16 13:18:12\",\n \"udate\":\"2017-02-09T12:14:58-06:00\",\n \"edate\":\"0000-00-00 00:00:00\",\n \"scoreValues\":[\n\n ],\n \"accountContacts\": [\n \"1\"\n ],\n \"links\":{\n \"bounceLogs\":\"https://:account.api-us1.com/api/:version/contacts/73/bounceLogs\",\n \"contactAutomations\":\"https://:account.api-us1.com/api/:version/contacts/73/contactAutomations\",\n \"contactData\":\"https://:account.api-us1.com/api/:version/contacts/73/contactData\",\n \"contactGoals\":\"https://:account.api-us1.com/api/:version/contacts/73/contactGoals\",\n \"contactLists\":\"https://:account.api-us1.com/api/:version/contacts/73/contactLists\",\n \"contactLogs\":\"https://:account.api-us1.com/api/:version/contacts/73/contactLogs\",\n \"contactTags\":\"https://:account.api-us1.com/api/:version/contacts/73/contactTags\",\n \"contactDeals\":\"https://:account.api-us1.com/api/:version/contacts/73/contactDeals\",\n \"deals\":\"https://:account.api-us1.com/api/:version/contacts/73/deals\",\n \"fieldValues\":\"https://:account.api-us1.com/api/:version/contacts/73/fieldValues\",\n \"geoIps\":\"https://:account.api-us1.com/api/:version/contacts/73/geoIps\",\n \"notes\":\"https://:account.api-us1.com/api/:version/contacts/73/notes\",\n \"organization\":\"https://:account.api-us1.com/api/:version/contacts/73/organization\",\n \"plusAppend\":\"https://:account.api-us1.com/api/:version/contacts/73/plusAppend\",\n \"trackingLogs\":\"https://:account.api-us1.com/api/:version/contacts/73/trackingLogs\",\n \"scoreValues\":\"https://:account.api-us1.com/api/:version/contacts/73/scoreValues\"\n },\n \"id\":\"73\",\n \"organization\":\"14\"\n }\n ],\n \"meta\":{\n \"total\":\"2\",\n \"page_input\":{\n \"segmentid\":null,\n \"formid\":0,\n \"listid\":0,\n \"tagid\":0,\n \"limit\":20,\n \"offset\":0,\n \"search\":null,\n \"sort\":null,\n \"seriesid\":0,\n \"waitid\":0,\n \"status\":-1,\n \"forceQuery\":0,\n \"cacheid\":\"895202850f4ca4144513c0962812f951\"\n }\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""},{"code":"{\n \"scoreValues\": [],\n \"contacts\": [\n {\n \"cdate\": \"2018-09-12T16:53:50-05:00\",\n \"email\": \"adam@activecampaign.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"0d9c41ae7a4de516313673e2341f6003\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"1\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"udate\": \"2018-09-12T17:00:00-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/5/scoreValues\"\n },\n \"id\": \"5\",\n \"organization\": null\n },\n {\n \"cdate\": \"2018-08-17T13:46:58-05:00\",\n \"email\": \"kconnell2@gmailc.om\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"2130706433\",\n \"ua\": \"\",\n \"hash\": \"4641d20634346d27408557fde5e3ad3b\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"1\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2018-08-31T11:58:25-05:00\",\n \"udate\": \"2018-08-17T13:46:58-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/4/scoreValues\"\n },\n \"id\": \"4\",\n \"organization\": null\n },\n {\n \"cdate\": \"2018-09-18T11:02:57-05:00\",\n \"email\": \"test@gmail.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"0\",\n \"ua\": null,\n \"hash\": \"\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"1\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": \"2018-09-18T11:02:57-05:00\",\n \"edate\": null,\n \"deleted_at\": null,\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/6/scoreValues\"\n },\n \"id\": \"6\",\n \"organization\": null\n },\n {\n \"cdate\": \"2018-08-17T09:56:33-05:00\",\n \"email\": \"test@test.com\",\n \"phone\": \"9813764\",\n \"firstName\": \"Test\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"2130706433\",\n \"ua\": \"\",\n \"hash\": \"e4162c50b2edaf68b0d5012ef3cc82fd\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"1\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2018-08-31T11:52:08-05:00\",\n \"udate\": \"2018-08-17T09:56:33-05:00\",\n \"edate\": \"2018-08-17T13:48:46-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/2/scoreValues\"\n },\n \"id\": \"2\",\n \"organization\": null\n },\n {\n \"cdate\": \"2018-08-17T13:45:23-05:00\",\n \"email\": \"test@testing.com\",\n \"phone\": \"20405938\",\n \"firstName\": \"testing\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"2130706433\",\n \"ua\": null,\n \"hash\": \"e3eba337bb1ede3bd073b1832e3f3def\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"1\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": \"2018-08-17T13:45:23-05:00\",\n \"edate\": null,\n \"deleted_at\": null,\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/3/scoreValues\"\n },\n \"id\": \"3\",\n \"organization\": null\n },\n {\n \"cdate\": \"2018-09-19T23:11:11-05:00\",\n \"email\": \"tjahn+test@activecampaign.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"853be08a2387ac13ca51dee72e586e9c\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2018-09-19T23:24:43-05:00\",\n \"udate\": \"2018-09-19T23:11:11-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"scoreValues\": [],\n \"links\": {\n \"bounceLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/bounceLogs\",\n \"contactAutomations\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactAutomations\",\n \"contactData\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactData\",\n \"contactGoals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactGoals\",\n \"contactLists\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactLists\",\n \"contactLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactLogs\",\n \"contactTags\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactTags\",\n \"contactDeals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/contactDeals\",\n \"deals\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/deals\",\n \"fieldValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/fieldValues\",\n \"geoIps\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/geoIps\",\n \"notes\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/notes\",\n \"organization\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/organization\",\n \"plusAppend\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/plusAppend\",\n \"trackingLogs\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/trackingLogs\",\n \"scoreValues\": \"https://test-enterprise-13.staging.listfly.com/api/3/contacts/7/scoreValues\"\n },\n \"id\": \"7\",\n \"organization\": null\n }\n ],\n \"meta\": {\n \"total\": \"6\",\n \"page_input\": {\n \"segmentid\": 0,\n \"formid\": 0,\n \"listid\": 0,\n \"tagid\": 0,\n \"limit\": 20,\n \"offset\": 0,\n \"search\": null,\n \"sort\": null,\n \"seriesid\": 0,\n \"waitid\": 0,\n \"status\": -1,\n \"forceQuery\": 0,\n \"cacheid\": \"522b5224f2007dca7483e08e7ebf5005\"\n }\n }\n}","language":"json","status":200,"name":null}]},"url":"/contacts","apiSetting":"58b53c301065f9c438aa1f77"},"slug":"list-all-contacts","sync_unique":"","type":"endpoint","category":"58c02f80b094740f005116e3","link_external":false,"order":6,"parentDoc":"58c02fb2ab93d80f0027119f","title":"List, search, and filter contacts","createdAt":"2017-03-08T16:34:04.722Z","hidden":false,"isReference":true,"link_url":"","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b96cad7246f0d0003a6e9e8","category":"58c02f80b094740f005116e3","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2018-09-10T19:49:43.994Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactAutomations\": [\n {\n \"contact\": \"6\",\n \"seriesid\": \"2\",\n \"startid\": \"0\",\n \"status\": \"2\",\n \"batchid\": \"completed\",\n \"adddate\": \"2022-03-01T08:51:57-06:00\",\n \"remdate\": \"2022-03-01T08:51:58-06:00\",\n \"timespan\": \"1\",\n \"lastblock\": \"5\",\n \"lastlogid\": \"0\",\n \"lastdate\": \"2022-03-01T08:51:58-06:00\",\n \"in_als\": \"3\",\n \"completedElements\": 0,\n \"totalElements\": 3,\n \"completed\": 1,\n \"completeValue\": 100,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/3/contactAutomations/6/automation\",\n \"contact\": \"https://:account.api-us1.com/api/3/contactAutomations/6/contact\",\n \"contactGoals\": \"https://:account.api-us1.com/api/3/contactAutomations/6/contactGoals\",\n \"automationLogs\": \"https://:account.api-us1.com/api/3/contactAutomations/6/automationLogs\"\n },\n \"id\": \"6\",\n \"automation\": \"2\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 1\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact to receive automations for","required":false,"in":"path","ref":"","_id":"5b96cad7246f0d0003a6e9e9"}],"url":"/contacts/:id/contactAutomations","method":"get"},"isReference":true,"order":7,"slug":"list-all-contactautomations-for-contact","type":"endpoint","title":"List all automations the contact is in","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5c6481e217770c02b3feed85","createdAt":"2019-02-13T20:45:22.656Z","category":"58c02f80b094740f005116e3","parentDoc":"58c02fb2ab93d80f0027119f","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"scoreValues\": [\n {\n \"score\": \"2\",\n \"contact\": \"1\",\n \"deal\": null,\n \"cdate\": \"2018-03-08T14:01:16-06:00\",\n \"mdate\": \"2018-10-22T20:15:28-05:00\",\n \"scoreValue\": \"0\",\n \"links\": {\n \"score\": \"https://:account.api-us1.com/api/3/scoreValues/1/score\",\n \"contact\": \"https://:account.api-us1.com/api/3/scoreValues/1/contact\",\n \"deal\": \"https://:account.api-us1.com/api/3/scoreValues/1/deal\"\n },\n \"id\": \"1\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"id of the Contact","required":false,"in":"path","ref":"","_id":"622a4394ac01970014bc42ef"}],"url":"/contacts/:id/scoreValues","method":"get"},"isReference":true,"order":8,"slug":"retrieve-a-contacts-score-value","type":"endpoint","title":"Retrieve a contact's score value","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5fcfd32d003078004279e775","api":{"method":"post","url":"/import/bulk_import","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n \"contacts\": [\n {\n \"email\": \"someone@somewhere.com\",\n \"first_name\": \"Jane\",\n \"last_name\": \"Doe\",\n \"phone\": \"123-456-7890\",\n \"customer_acct_name\": \"ActiveCampaign\",\n \"exclude_automations\": false,\n \"tags\": [\n \"dictumst\", \"aliquam\", \"augue quam\", \"sollicitudin rutrum\"\n ],\n \"fields\": [\n { \"id\": 1, \"value\": \"foo\" },\n { \"id\": 2, \"value\": \"||foo||bar||baz||\" }\n ],\n \"subscribe\": [\n { \"listid\": 1 },\n { \"listid\": 2 }\n ],\n \"unsubscribe\": [\n { \"listid\": 3 }\n ]\n }\n ],\n \"callback\": {\n \"url\": \"www.your_web_server.com\",\n \"requestType\": \"POST\",\n \"detailed_results\": \"true\",\n \"params\": [\n { \"key\": \"\", \"value\": \"\" }\n ],\n \"headers\": [\n { \"key\": \"\", \"value\": \"\" }\n ]\n }\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"Success\":1,\n \"queued_contacts\":1,\n \"batchId\":\"0641fbdd-f62f-4c2c-ba02-3a83d5d11ac9\",\n \"message\":\"Contact import queued\"\n}","language":"json","status":200},{"name":"Contact Create Fail","code":"{\n\t\"success\": 0,\n\t\"message\": \"JSON payload did not pass validation. Please fix failure Reasons and retry. The import was not queued for processing.\",\n\t\"failureReasons\": [{\n\t\t\"contact\": 230,\n\t\t\"failureReason\": \"Field‘ email’ incorrect format\"\n\t}]\n}","language":"json","status":400},{"code":"{\n\t\"success\": 0,\n\t\"message\": \"Rate limit exceeded.\",\n\t\"failureReasons\": [\"Up to 100 imports may be requested per minute.Please batch contacts into larger requests, or retry this request in a minute.\"]\n}","language":"json","status":400,"name":"Other Error"}]},"params":[{"name":"contacts","type":"array_object","enumValues":"","default":"","desc":"An array of objects containing information about a single contact. Up to 250 contacts may be included in a single request. The suggested minimum number of contacts is 10. If less than that, then contact/sync api request should be used.","required":true,"in":"body","ref":"Contact","_id":"5fcfd32d003078004279e779"},{"name":"callback","type":"object","enumValues":"","default":"","desc":"Callback function to notify users when an import is complete.","required":false,"in":"body","ref":"ImportCallback","_id":"5fcfd32d003078004279e778"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/json","desc":"","required":false,"in":"header","ref":"","_id":"5fcfd32d003078004279e777"},{"name":"Api-Token","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"header","ref":"","_id":"5fcfd32d003078004279e776"}]},"title":"Bulk import contacts","type":"endpoint","slug":"bulk-import-contacts","order":9,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2020-12-08T19:25:33.861Z","category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"613bcd60bf50880022424d1f","api":{"method":"get","url":"/import/bulk_import","auth":"required","results":{"codes":[{"name":"","code":"{\n \"outstanding\":[\n {\"forDate\":\"2021-06-01\",\"batches\":\"333\",\"contacts\":\"83250\"}\n ],\n \"recentlyCompleted\":[\n {\"forDate\":\"2021-06-01\",\"batches\":\"17\",\"contacts\":\"4250\"},\n {\"forDate\":\"2021-06-02\",\"batches\":\"50\",\"contacts\":\"12500\"}\n ]\n}","language":"json","status":200}]},"params":[],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Bulk import status list","type":"endpoint","slug":"bulk-import-status-list","order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-10T21:25:52.446Z","parentDoc":"58c02fb2ab93d80f0027119f","category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"613bcfd74c759a00290fd417","api":{"method":"get","url":"/import/info","auth":"required","results":{"codes":[{"name":"","code":"{\n \"status\":\"completed\",\n \"success\":[\"123\",\"124\",\"125\",\"126\"],\n \"failure\":[\n \"invalid.email@invalidDomain\", \n \"invalid'character@example.com\"\n ]\n}","language":"json","status":200},{"code":"{\"success\":0,\"message\":\"'batchId' is a required field.\"}","language":"json","status":400,"name":"Bad Request"}]},"params":[{"name":"batchId","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"query","ref":"","_id":"613bcfd74c759a00290fd418"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Bulk import status info","type":"endpoint","slug":"bulk-import-status-info","order":11,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-09-10T21:36:23.796Z","parentDoc":"58c02fb2ab93d80f0027119f","category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"606c9784321efc003ff74d9e","api":{"method":"get","url":"/activities","auth":"required","examples":{"codes":[]},"params":[{"name":"contact","type":"int","enumValues":"","default":"","desc":"Required Contact ID","required":false,"in":"query","ref":"","_id":"5910bca90f517e0f006cca6a"},{"name":"after","type":"datetime","enumValues":"","default":"","desc":"Filter for activities after a specific DateTime","required":false,"in":"query","ref":"","_id":"58d027db08bcac23006e688e"},{"name":"include","type":"string","enumValues":"","default":"activities to include","desc":"Activities to include: notes, notes.user, recipients, recipients.recipient, reference, reference.automation, reference.campaign, reference.campaign.campaignList, reference.campaign.campaignMessage, reference.campaignMessage, reference.contact, reference.contactList, reference.contactList.list, reference.deal, reference.deal.contact, reference.dealTasktype, reference.link, reference.list, reference.log, reference.log.campaign, reference.log.contact, reference.log.message, reference.message, reference.note, reference.sms, reference.sms.automation, user","required":false,"in":"query","ref":"","_id":"5911c4b7076ce90f007f93c5"},{"name":"orders[tstamp]","type":"string","enumValues":"","default":"","desc":"Order activities by tstamp","required":false,"in":"query","ref":"","_id":"58d1653c82bad51900a3cf84"},{"name":"emails","type":"boolean","enumValues":"","default":"false","desc":"FALSE: Excludes email data fields under each activity. No specific connection to emails is mentioned in the JSON data. TRUE: Returns deal activities that include email data fields like \"connection_email.\" Each deal activity specifies the addition of email connection information along with timestamps and relevant metadata.","required":false,"in":"query","ref":"","_id":"6710144dfa61f8006a889f32"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n\tcontacts: [{\n cdate: \"2018-02-13T13:25:54-06:00\",\n email: \"test@example.com\",\n firstName: \"Test\",\n lastName: \"Contact\",\n created_timestamp: \"2019-11-13 16:18:00\",\n updated_timestamp: \"2021-04-06 11:25:59\",\n id: \"4\"\n }],\n activityRecipients: [{\n reltype: \"Subscriber\",\n relid: \"4\",\n activityid: \"865\",\n recipient: {\n type: \"contact\",\n id: \"4\"\n }],\n\tactivities: [{\n tstamp: \"2019-01-03T12:16:19-06:00\",\n subscriberid: \"4\",\n reference_type: \"SubscriberEmail\",\n reference_id: \"13\",\n reference_action: \"\",\n jsonData: null,\n userid: \"1\",\n permission: \"\",\n referenceModelName: \"contact-email\",\n notes: [ ],\n recipients: [\n\t \"1496\"\n ],\n reference: {\n type: \"contact-email\",\n id: \"13\"\n },\n user: \"1\",\n id: \"865\"\n }],\n\tmeta: {\n\t\ttotal: \"1\"\n\t}\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List a contact's activities","type":"endpoint","slug":"list-contact-activities","order":12,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2021-04-06T17:16:52.028Z","category":"58c02f80b094740f005116e3","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"61f308ec4c9add007e69a208","api":{"method":"get","url":"/contacts/:id/bounceLogs","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"bounceLogs\": [\n {\n \"tstamp\": \"2021-05-12T11:30:06-05:00\",\n \"bounceid\": \"1\",\n \"subscriberid\": \"4\",\n \"campaignid\": \"11\",\n \"messageid\": \"12\",\n \"codeid\": \"48\",\n \"email\": \"uhOhBounced@example.com\",\n \"error\": \"\",\n \"source\": \"Return-Path: <>\\nReceived: from xxx.xxxx.xxxxxxc.com (unknown [XX.X.XX.XX]) ...\",\n \"created_timestamp\": \"2021-05-12 11:30:06\",\n \"updated_timestamp\": \"2021-05-12 11:30:06\",\n \"created_by\": null,\n \"updated_by\": null,\n \"links\": {\n \"bounce\": \"https://:account.api-us1.com/api/3/bounceLogs/23/bounce\",\n \"contact\": \"https://:account.api-us1.com/api/3/bounceLogs/23/contact\",\n \"campaign\": \"https://:account.api-us1.com/api/3/bounceLogs/23/campaign\",\n \"message\": \"https://:account.api-us1.com/api/3/bounceLogs/23/message\",\n \"code\": \"https://:account.api-us1.com/api/3/bounceLogs/23/code\"\n },\n \"id\": \"23\",\n \"bounce\": \"1\",\n \"contact\": \"4\",\n \"campaign\": \"11\",\n \"message\": \"12\",\n \"code\": \"48\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fc18fd375f3c004e5d256e"}]},"title":"Retrieve a contact's bounce logs","type":"endpoint","slug":"retrieve-contact-bounce-logs","order":13,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-contacts-bounce-logs","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-27T21:04:44.187Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f3164dd3524f007f03aaa2","api":{"method":"get","url":"/contacts/:id/contactData","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactDatum\": {\n \"contact\": \"4\",\n \"tstamp\": \"2021-06-09T14:35:10-05:00\",\n \"geoTstamp\": null,\n \"geoIp4\": \"0\",\n \"geoCountry2\": \"\",\n \"geo_country\": \"\",\n \"geoState\": \"\",\n \"geoCity\": \"\",\n \"geoZip\": \"\",\n \"geoArea\": \"0\",\n \"geoLat\": \"0.000000\",\n \"geoLon\": \"0.000000\",\n \"geoTz\": \"\",\n \"geoTzOffset\": \"0.00\",\n \"ga_campaign_source\": \"\",\n \"ga_campaign_name\": \"\",\n \"ga_campaign_medium\": \"\",\n \"ga_campaign_term\": \"\",\n \"ga_campaign_content\": \"\",\n \"ga_campaign_customsegment\": \"\",\n \"ga_first_visit\": null,\n \"ga_times_visited\": \"0\",\n \"fb_id\": \"0\",\n \"fb_name\": \"\",\n \"tw_id\": \"0\",\n \"created_timestamp\": \"0000-00-00 00:00:00\",\n \"updated_timestamp\": \"0000-00-00 00:00:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": [],\n \"id\": \"12\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 121\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fc211651342a043598af87"}]},"title":"Retrieve a contact's data","type":"endpoint","slug":"retrieve-contact-data","order":14,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-contacts-data","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-27T22:01:49.938Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f4288217fc1f0010e633b8","api":{"method":"get","url":"/contacts/:id/contactGoals","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactGoals\": [\n {\n \"goalid\": \"3\",\n \"seriesid\": \"2\",\n \"subscriberid\": \"5\",\n \"subscriberseriesid\": \"83\",\n \"timespan\": \"1\",\n \"tstamp\": \"2021-05-12T14:55:19-05:00\",\n \"links\": {\n \"goal\": \"https://:account.api-us1.com/api/3/contactGoals/3/goal\",\n \"automation\": \"https://:account.api-us1.com/api/3/contactGoals/3/automation\",\n \"contact\": \"https://:account.api-us1.com/api/3/contactGoals/3/contact\",\n \"contactAutomation\": \"https://:account.api-us1.com/api/3/contactGoals/3/contactAutomation\",\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/contactGoals/3/contactGoalLists\",\n \"contactGoalTags\": \"https://:account.api-us1.com/api/3/contactGoals/3/contactGoalTags\"\n },\n \"id\": \"3\",\n \"goal\": \"3\",\n \"automation\": \"2\",\n \"contact\": \"5\",\n \"contactAutomation\": \"83\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 121\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fc29d13d2f620078ac7f46"}]},"title":"Retrieve a contact's goals","type":"endpoint","slug":"retrieve-contact-goals","order":15,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T17:31:46.671Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f463718521400032e4af90","api":{"method":"get","url":"/contacts/:id/contactLists","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactLists\": [\n {\n \"contact\": \"19\",\n \"list\": \"1\",\n \"form\": null,\n \"seriesid\": \"0\",\n \"sdate\": \"2021-04-08T11:17:44-05:00\",\n \"udate\": \"2021-05-12T11:10:06-05:00\",\n \"status\": \"3\",\n \"responder\": \"1\",\n \"sync\": \"1\",\n \"unsubreason\": null,\n \"campaign\": null,\n \"message\": null,\n \"first_name\": \"John\",\n \"last_name\": \"Doe\",\n \"ip4Sub\": \"XXXXXXXXXX\",\n \"sourceid\": \"1\",\n \"autosyncLog\": null,\n \"ip4_last\": \"0\",\n \"ip4Unsub\": \"0\",\n \"created_timestamp\": \"2021-04-08 11:17:44\",\n \"updated_timestamp\": \"2021-05-12 11:10:06\",\n \"created_by\": null,\n \"updated_by\": null,\n \"unsubscribeAutomation\": null,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/3/contactLists/19/automation\",\n \"list\": \"https://:account.api-us1.com/api/3/contactLists/19/list\",\n \"contact\": \"https://:account.api-us1.com/api/3/contactLists/19/contact\",\n \"form\": \"https://:account.api-us1.com/api/3/contactLists/19/form\",\n \"autosyncLog\": \"https://:account.api-us1.com/api/3/contactLists/19/autosyncLog\",\n \"campaign\": \"https://:account.api-us1.com/api/3/contactLists/19/campaign\",\n \"unsubscribeAutomation\": \"https://:account.api-us1.com/api/3/contactLists/19/unsubscribeAutomation\",\n \"message\": \"https://:account.api-us1.com/api/3/contactLists/19/message\"\n },\n \"id\": \"19\",\n \"automation\": null\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 121\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fc2f46217bdf017f3ac276"}]},"title":"Retrieve a contact's list memberships","type":"endpoint","slug":"retrieve-contact-list-memberships","order":16,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:43:13.369Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f463efb20fc308e634af96","api":{"method":"get","url":"/contacts/:id/contactLogs","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactLogs\": []\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd89914279fc0029d647cd"}]},"title":"Retrieve a contact's logs","type":"endpoint","slug":"retrieve-contact-logs","order":17,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:45:19.435Z","category":"58c02f80b094740f005116e3","isBodyEmpty":true,"children":[]},{"_id":"61f464390c7f780047afc0aa","api":{"method":"get","url":"/contacts/:id/contactDeals","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2021-11-28T00:00:00-06:00\",\n \"email\": \"john.doe@example.com\",\n \"phone\": \"555-555-5555\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"XX\",\n \"orgname\": \"Opulence Time\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"43fa9ikvd23cbc59915f89asd234gsda27b33\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2021-11-28T00:00:00-06:00\",\n \"udate\": \"2021-11-28T00:00:00-06:00\",\n \"edate\": \"2021-12-20T06:23:31-06:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"created_utc_timestamp\": \"2021-11-28 00:00:00\",\n \"updated_utc_timestamp\": \"2022-01-25 16:26:37\",\n \"created_timestamp\": \"2021-11-28 00:00:00\",\n \"updated_timestamp\": \"2021-12-09 00:00:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"email_empty\": false,\n \"mpp_tracking\": \"0\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/3/contacts/1107/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/3/contacts/1107/contactAutomations?limit=1000&orders%5Blastdate%5D=DESC\",\n \"contactData\": \"https://:account.api-us1.com/api/3/contacts/1107/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/3/contacts/1107/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/3/contacts/1107/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/3/contacts/1107/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/3/contacts/1107/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/3/contacts/1107/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/3/contacts/1107/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/3/contacts/1107/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/3/contacts/1107/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/3/contacts/1107/notes\",\n \"organization\": \"https://:account.api-us1.com/api/3/contacts/1107/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/3/contacts/1107/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/3/contacts/1107/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/3/contacts/1107/scoreValues\",\n \"accountContacts\": \"https://:account.api-us1.com/api/3/contacts/1107/accountContacts\",\n \"automationEntryCounts\": \"https://:account.api-us1.com/api/3/contacts/1107/automationEntryCounts\"\n },\n \"id\": \"XXXX\",\n \"organization\": \"XX\"\n }\n ],\n \"deals\": [\n {\n \"hash\": \"dx60eh125\",\n \"owner\": \"8\",\n \"contact\": \"XXXX\",\n \"organization\": \"31\",\n \"group\": \"1\",\n \"stage\": \"1\",\n \"title\": \"Opulence Time\",\n \"description\": \"\",\n \"percent\": \"0\",\n \"cdate\": \"2022-01-24T00:00:00-06:00\",\n \"mdate\": \"2022-01-25T00:00:00-06:00\",\n \"nextdate\": null,\n \"nexttaskid\": \"0\",\n \"value\": \"7320163\",\n \"currency\": \"usd\",\n \"winProbability\": null,\n \"winProbabilityMdate\": null,\n \"status\": \"0\",\n \"activitycount\": \"24\",\n \"nextdealid\": \"4218\",\n \"edate\": \"2022-03-07 00:00:00\",\n \"links\": {\n \"dealActivities\": \"https://:account.api-us1.com/api/3/deals/4228/dealActivities\",\n \"contact\": \"https://:account.api-us1.com/api/3/deals/4228/contact\",\n \"contactDeals\": \"https://:account.api-us1.com/api/3/deals/4228/contactDeals\",\n \"group\": \"https://:account.api-us1.com/api/3/deals/4228/group\",\n \"nextTask\": \"https://:account.api-us1.com/api/3/deals/4228/nextTask\",\n \"notes\": \"https://:account.api-us1.com/api/3/deals/4228/notes\",\n \"account\": \"https://:account.api-us1.com/api/3/deals/4228/account\",\n \"customerAccount\": \"https://:account.api-us1.com/api/3/deals/4228/customerAccount\",\n \"organization\": \"https://:account.api-us1.com/api/3/deals/4228/organization\",\n \"owner\": \"https://:account.api-us1.com/api/3/deals/4228/owner\",\n \"scoreValues\": \"https://:account.api-us1.com/api/3/deals/4228/scoreValues\",\n \"stage\": \"https://:account.api-us1.com/api/3/deals/4228/stage\",\n \"tasks\": \"https://:account.api-us1.com/api/3/deals/4228/tasks\",\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/3/deals/4228/dealCustomFieldData\"\n },\n \"id\": \"4228\",\n \"isDisabled\": false,\n \"nextTask\": null,\n \"account\": \"31\",\n \"customerAccount\": \"31\"\n }\n ],\n \"contactDeals\": [\n {\n \"deal\": \"4228\",\n \"contact\": \"5\",\n \"role\": null,\n \"cdate\": \"2021-10-22T13:16:27-05:00\",\n \"created_timestamp\": \"2021-10-22 13:16:27\",\n \"updated_timestamp\": \"2021-10-22 13:16:27\",\n \"created_by\": null,\n \"updated_by\": null,\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/3/contactDeals/4248/deal\",\n \"contact\": \"https://:account.api-us1.com/api/3/contactDeals/4248/contact\",\n \"role\": \"https://:account.api-us1.com/api/3/contactDeals/4248/role\"\n },\n \"id\": \"4248\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd745945ccb2005527bcf5"}]},"title":"Retrieve a list of contact's deals","type":"endpoint","slug":"retrieve-contact-deals-list","order":18,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-contact-deals-listx","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:46:33.768Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f46506f9aba60010492a01","api":{"method":"get","url":"/contacts/:id/deals","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"deals\": [\n {\n \"hash\": \"8be32as98\",\n \"owner\": \"8\",\n \"contact\": \"8\",\n \"organization\": \"5\",\n \"group\": \"1\",\n \"stage\": \"4\",\n \"title\": \"Acme Corp\",\n \"description\": \"\",\n \"percent\": \"0\",\n \"cdate\": \"2021-06-30T15:27:44-05:00\",\n \"mdate\": \"2021-06-30T15:27:44-05:00\",\n \"nextdate\": null,\n \"nexttaskid\": null,\n \"value\": \"494227\",\n \"currency\": \"usd\",\n \"winProbability\": null,\n \"winProbabilityMdate\": null,\n \"status\": \"2\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"3060\",\n \"edate\": null,\n \"links\": {\n \"dealActivities\": \"https://:acount.api-us1.com/api/3/deals/3057/dealActivities\",\n \"contact\": \"https://:acount.api-us1.com/api/3/deals/3057/contact\",\n \"contactDeals\": \"https://:acount.api-us1.com/api/3/deals/3057/contactDeals\",\n \"group\": \"https://:acount.api-us1.com/api/3/deals/3057/group\",\n \"nextTask\": \"https://:acount.api-us1.com/api/3/deals/3057/nextTask\",\n \"notes\": \"https://:acount.api-us1.com/api/3/deals/3057/notes\",\n \"account\": \"https://:acount.api-us1.com/api/3/deals/3057/account\",\n \"customerAccount\": \"https://:acount.api-us1.com/api/3/deals/3057/customerAccount\",\n \"organization\": \"https://:acount.api-us1.com/api/3/deals/3057/organization\",\n \"owner\": \"https://:acount.api-us1.com/api/3/deals/3057/owner\",\n \"scoreValues\": \"https://:acount.api-us1.com/api/3/deals/3057/scoreValues\",\n \"stage\": \"https://:acount.api-us1.com/api/3/deals/3057/stage\",\n \"tasks\": \"https://:acount.api-us1.com/api/3/deals/3057/tasks\",\n \"dealCustomFieldData\": \"https://:acount.api-us1.com/api/3/deals/3057/dealCustomFieldData\"\n },\n \"id\": \"3057\",\n \"isDisabled\": false,\n \"account\": \"5\",\n \"customerAccount\": \"5\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd897bc527fc00202b8a50"}]},"title":"Retrieve a contact's deals","type":"endpoint","slug":"retrieve-contact-deals","order":19,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-contact-deal-list","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:49:58.726Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f4657465040500633b9c70","api":{"method":"get","url":"/contacts/:id/fieldValues","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"fieldValues\": [\n {\n \"contact\": \"5\",\n \"field\": \"1\",\n \"value\": \"United States\",\n \"cdate\": \"2021-05-12T14:19:38-05:00\",\n \"udate\": \"2021-05-12T14:54:57-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/1/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/1/field\"\n },\n \"id\": \"1\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"5\",\n \"field\": \"2\",\n \"value\": \"Software\",\n \"cdate\": \"2021-05-12T14:22:54-05:00\",\n \"udate\": \"2021-05-12T14:54:57-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/2/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/2/field\"\n },\n \"id\": \"2\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"5\",\n \"field\": \"3\",\n \"value\": \"Yes\",\n \"cdate\": \"2021-05-12T14:34:19-05:00\",\n \"udate\": \"2021-05-12T14:54:57-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/3/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/3/field\"\n },\n \"id\": \"3\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"5\",\n \"field\": \"4\",\n \"value\": \"Landing Page\",\n \"cdate\": \"2021-05-12T14:34:56-05:00\",\n \"udate\": \"2021-05-12T14:54:57-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/4/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/4/field\"\n },\n \"id\": \"4\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"5\",\n \"field\": \"5\",\n \"value\": \"2021-05-02\",\n \"cdate\": \"2021-05-12T14:36:26-05:00\",\n \"udate\": \"2021-05-19T10:34:19-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/5/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/5/field\"\n },\n \"id\": \"5\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"5\",\n \"field\": \"7\",\n \"value\": \"Director\",\n \"cdate\": \"2021-05-12T14:39:00-05:00\",\n \"udate\": \"2021-05-12T14:54:57-05:00\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/6/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/6/field\"\n },\n \"id\": \"6\",\n \"owner\": \"5\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd8969c2209c007ad55ddc"}]},"title":"Retrieve a contact's field values","type":"endpoint","slug":"retrieve-contact-field-values","order":20,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:51:48.505Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f465ba1559990010e97e8b","api":{"method":"get","url":"/contacts/:id/geoIps","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n\t\"geoIps\": [{\n\t\t\"contact\": \"49\",\n\t\t\"campaignid\": \"11\",\n\t\t\"messageid\": \"12\",\n\t\t\"geoaddrid\": \"2\",\n\t\t\"ip4\": \"1123637995\",\n\t\t\"tstamp\": \"2021-05-12T11:10:06-05:00\",\n\t\t\"links\": {\n\t\t\t\"geoAddress\": \"https://:account.api-us1.com/api/3/geoIps/4/geoAddress\"\n\t\t},\n\t\t\"id\": \"4\",\n\t\t\"geoAddress\": \"2\"\n\t}]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd892884997c0010457edf"}]},"title":"Retrieve a contacts list of geo-ips","type":"endpoint","slug":"retrieve-contact-geo-ips","order":21,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:52:58.940Z","category":"58c02f80b094740f005116e3","icon":"","isBodyEmpty":false,"children":[]},{"_id":"65835131c1b6bb001698f09e","api":{"method":"get","url":"/geoIps/:geoAddressID/geoAddress","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"geoAddress\": {\n \"ip4\": \"1234567890\",\n \"country2\": \"US\",\n \"country\": \"United States\",\n \"state\": \"New York\",\n \"city\": \"New York\",\n \"zip\": \"10001\",\n \"area\": \"0\",\n \"lat\": \"40.7128\",\n \"lon\": \"-74.0060\",\n \"tz\": \"America/Chicago\",\n \"tstamp\": \"2023-12-20T14:14:46-06:00\",\n \"links\": [],\n \"id\": \"3\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"geoAddressID","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd892884997c0010457edf"}]},"title":"Retrieve a contacts geo IP address","icon":"","type":"endpoint","slug":"retrieve-a-contacts-geo-ip-address","order":22,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-contacts-geo-ips-copy","parentDoc":"58c02fb2ab93d80f0027119f","category":"58c02f80b094740f005116e3","createdAt":"2023-12-20T20:40:17.264Z","isBodyEmpty":false,"children":[]},{"_id":"61f465f5239330006d71cb3d","api":{"method":"get","url":"/contacts/:id/notes","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"notes\": [\n {\n \"relid\": \"7\",\n \"reltype\": \"Subscriber\",\n \"userid\": \"1\",\n \"is_draft\": \"0\",\n \"cdate\": \"2022-02-04T14:21:28-06:00\",\n \"mdate\": \"2022-02-04T14:21:28-06:00\",\n \"note\": \"Here is a note!\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/3/notes/1/activities\",\n \"user\": \"https://:account.api-us1.com/api/3/notes/1/user\",\n \"mentions\": \"https://:account.api-us1.com/api/3/notes/1/mentions\",\n \"notes\": \"https://:account.api-us1.com/api/3/notes/1/notes\",\n \"owner\": \"https://:account.api-us1.com/api/3/notes/1/owner\"\n },\n \"id\": \"1\",\n \"user\": \"1\",\n \"owner\": {\n \"type\": \"contact\",\n \"id\": \"7\"\n }\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd8c346b77e50057658712"}]},"title":"Retrieve a contacts notes","type":"endpoint","slug":"retrieve-contact-notes","order":23,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:53:57.786Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"65206a0dd5fb7500449b7413","api":{"method":"get","url":"/notes","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"notes\": [\n {\n \"relid\": \"126\",\n \"reltype\": \"Activity\",\n \"userid\": \"1\",\n \"is_draft\": \"0\",\n \"cdate\": \"2022-05-26T08:58:34-05:00\",\n \"mdate\": \"2022-05-26T08:58:34-05:00\",\n \"note\": \"Oh, hi Mark\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/3/notes/1/activities\",\n \"user\": \"https://:account.api-us1.com/api/3/notes/1/user\",\n \"mentions\": \"https://:account.api-us1.com/api/3/notes/1/mentions\",\n \"notes\": \"https://:account.api-us1.com/api/3/notes/1/notes\",\n \"owner\": \"https://:account.api-us1.com/api/3/notes/1/owner\"\n },\n \"id\": \"1\",\n \"user\": \"1\",\n \"owner\": {\n \"type\": \"activity\",\n \"id\": \"126\"\n }\n },\n {\n \"relid\": \"6\",\n \"reltype\": \"Deal\",\n \"userid\": \"1\",\n \"is_draft\": \"0\",\n \"cdate\": \"2023-08-18T11:09:38-05:00\",\n \"mdate\": \"2023-08-18T11:09:40-05:00\",\n \"note\": \"Here is a note\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/3/notes/2/activities\",\n \"user\": \"https://:account.api-us1.com/api/3/notes/2/user\",\n \"mentions\": \":account.api-us1.com/api/3/notes/2/mentions\",\n \"notes\": \":account.api-us1.com/api/3/notes/2/notes\",\n \"owner\": \":account.api-us1.com/api/3/notes/2/owner\"\n },\n \"id\": \"2\",\n \"user\": \"1\",\n \"owner\": {\n \"type\": \"deal\",\n \"id\": \"6\"\n }\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":""}]},"params":[]},"title":"Retrieve list of all notes","icon":"","type":"endpoint","slug":"retrieve-list-of-all-notes","order":24,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-contacts-notes-copy","parentDoc":"58c02fb2ab93d80f0027119f","category":"58c02f80b094740f005116e3","createdAt":"2023-10-06T20:11:57.980Z","isBodyEmpty":false,"children":[]},{"_id":"61f4662a9280de00547cbc98","api":{"method":"get","url":"/contacts/:id/organization","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"organization\": {\n \"name\": \"M Corp\",\n \"created_timestamp\": \"2021-05-21T16:15:47-05:00\",\n \"updated_timestamp\": \"2021-08-24T06:28:56-05:00\",\n \"userid\": \"1\",\n \"id\": \"9\",\n \"owner\": \"1\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd8cb34149ca002dc8fd88"}]},"title":"Retrieve a contacts organization","type":"endpoint","slug":"retrieve-contact-organization","order":25,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:54:50.603Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f466731559990010e982f2","api":{"method":"get","url":"/contacts/:id/plusAppend","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"plusAppend\": {\n \"contact\": \"3\",\n \"last_updated_rapleaf\": null,\n \"last_updated_fliptop\": null,\n \"last_updated_fullcontact\": null,\n \"imageUrl\": \"https://img.fullcontact.com/static/ece148ad832u8f2c66f23442_3e5923f243234234cec57395be553465p96u9345u69u3456354345634\",\n \"membershipsFacebook\": \"\",\n \"membershipsTwitter\": \"https://twitter.com/twitterHandleHere\",\n \"membershipsLinkedin\": \"\",\n \"links\": {\n \"contact\": \"https://:account.api-us1.com/api/3/plusAppends/2/contact\"\n },\n \"id\": \"2\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd8f1a642e7c0047ac116d"}]},"title":"Retrieve a contacts plus append","type":"endpoint","slug":"retrieve-contact-plus-append","order":26,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:56:03.972Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f466f0da34ee004e3b7b00","api":{"method":"get","url":"/contacts/:id/trackingLogs","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"trackingLogs\": []\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd9333bcad1a004e7534b8"}]},"title":"Retrieve a contacts tracking logs","type":"endpoint","slug":"retrieve-contact-tracking-logs","order":27,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:58:08.820Z","category":"58c02f80b094740f005116e3","isBodyEmpty":true,"children":[]},{"_id":"61f4674828557a0023d41c21","api":{"method":"get","url":"/contacts/:id/accountContacts","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"accountContacts\": [\n {\n \"account\": \"9\",\n \"contact\": \"7\",\n \"jobTitle\": \"\",\n \"createdTimestamp\": \"2021-05-21T16:30:23-05:00\",\n \"updatedTimestamp\": \"2021-05-21T16:30:23-05:00\",\n \"links\": {\n \"account\": \"https://:account.api-us1.com/api/3/accountContacts/7/account\",\n \"contact\": \"https://:account.api-us1.com/api/3/accountContacts/7/contact\"\n },\n \"id\": \"7\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd93a4d2760d002c4a08c1"}]},"title":"Retrieve a contacts account contacts","type":"endpoint","slug":"retrieve-contact-account-contacts","order":28,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T21:59:36.395Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]},{"_id":"61f467a07837310012da3110","api":{"method":"get","url":"/contacts/:id/automationEntryCounts","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"automationEntryCounts\": [\n {\n \"id\": \"2\",\n \"name\": \"Pages: Lead Delivery\",\n \"status\": \"1\",\n \"hidden\": \"0\",\n \"contactEntryCount\": \"1\"\n },\n {\n \"id\": \"4\",\n \"name\": \"Lead Scoring\",\n \"status\": \"1\",\n \"hidden\": \"0\",\n \"contactEntryCount\": \"2\"\n },\n {\n \"id\": \"7\",\n \"name\": \"Foo: Bar Creation\",\n \"status\": \"1\",\n \"hidden\": \"0\",\n \"contactEntryCount\": \"1\"\n }\n ]\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 100\"\n}","name":""}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contact","required":false,"in":"path","ref":"","_id":"61fd941525e00f004ecd35a0"}]},"title":"Retrieve a contacts automation entry counts","type":"endpoint","slug":"retrieve-contact-automation-entry-counts","order":29,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58c02fb2ab93d80f0027119f","createdAt":"2022-01-28T22:01:04.327Z","category":"58c02f80b094740f005116e3","isBodyEmpty":false,"children":[]}]},{"_id":"5bad45fd1a1b5f000362f14b","category":"58c02f80b094740f005116e3","createdAt":"2018-09-27T21:05:01.214Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":1,"slug":"automations","type":"basic","title":"Automations","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b96b5054108e90003405d75","category":"58c02f80b094740f005116e3","createdAt":"2018-09-10T18:16:37.517Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n \"contactAutomation\": {\n \"contact\": \"117\",\n \"automation\": \"42\"\n }\n}","language":"json"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2018-08-06T16:26:06-05:00\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"2130706433\",\n \"ua\": null,\n \"hash\": \"054aa0acede49e07a844420c879b3c30\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": null,\n \"edate\": null,\n \"deleted_at\": null,\n \"created_utc_timestamp\": \"2018-09-21 12:04:40\",\n \"updated_utc_timestamp\": \"2018-09-21 12:04:40\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/64/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/64/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/64/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/64/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/64/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/64/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/64/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/64/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/64/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/64/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/64/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/64/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/64/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/64/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/64/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/64/scoreValues\"\n },\n \"id\": \"64\",\n \"organization\": null\n }\n ],\n \"contactAutomation\": {\n \"contact\": \"64\",\n \"seriesid\": \"2\",\n \"startid\": 0,\n \"status\": 1,\n \"lastblock\": \"4\",\n \"completedElements\": \"1\",\n \"totalElements\": \"2\",\n \"completed\": 0,\n \"completeValue\": 50,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactAutomations/3/automation\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactAutomations/3/contact\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contactAutomations/3/contactGoals\"\n },\n \"id\": \"3\",\n \"automation\": \"2\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Could not create SubscriberSeries\"\n}","name":""}]},"auth":"required","params":[{"name":"contactAutomation.contact","type":"int","enumValues":"","default":"","desc":"Contact ID of the Contact, to be linked to the contactAutomation","required":true,"in":"body","ref":"","_id":"5babd841a0ab3e0003ead039"},{"name":"contactAutomation.automation","type":"int","enumValues":"","default":"","desc":"Automation ID of the automation, to be linked to the contactAutomation","required":true,"in":"body","ref":"","_id":"5babd841a0ab3e0003ead038"}],"url":"/contactAutomations","method":"post"},"isReference":true,"order":0,"slug":"create-new-contactautomation","type":"endpoint","title":"Add a contact to an automation","parentDoc":"5bad45fd1a1b5f000362f14b","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b96b6dc40d30c0003f224c0","category":"58c02f80b094740f005116e3","createdAt":"2018-09-10T18:24:28.871Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"contactAutomation\": {\n \"contact\": \"110\",\n \"seriesid\": \"2\",\n \"startid\": \"0\",\n \"status\": \"2\",\n \"batchid\": null,\n \"adddate\": \"2018-09-19T09:44:26-05:00\",\n \"remdate\": \"2018-09-19T09:44:26-05:00\",\n \"timespan\": \"0\",\n \"lastblock\": \"5\",\n \"lastlogid\": \"2\",\n \"lastdate\": \"2018-09-19T09:44:26-05:00\",\n \"completedElements\": \"1\",\n \"totalElements\": \"2\",\n \"completed\": 1,\n \"completeValue\": 100,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactAutomations/2/automation\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactAutomations/2/contact\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contactAutomations/2/contactGoals\"\n },\n \"id\": \"2\",\n \"automation\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for SubscriberSeries with id 3\"\n}","language":"json","status":404}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the contactAutomation to retrieve","required":false,"in":"path","ref":"","_id":"5b96b6dc40d30c0003f224c1"}],"url":"/contactAutomations/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-contactautomation","type":"endpoint","title":"Retrieve an automation a contact is in","parentDoc":"5bad45fd1a1b5f000362f14b","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b96b5eeff009a0003fd12f0","category":"58c02f80b094740f005116e3","createdAt":"2018-09-10T18:20:30.900Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for SubscriberSeries with id 3\"\n}","name":""}]},"auth":"required","params":[{"_id":"5b96b5eeff009a0003fd12f1","ref":"","in":"path","required":false,"desc":"ID of the contactAutomation to delete","default":"","type":"int","name":"id"}],"url":"/contactAutomations/:id","method":"delete"},"isReference":true,"order":2,"slug":"delete-a-contactautomation","type":"endpoint","title":"Remove a contact from an automation","parentDoc":"5bad45fd1a1b5f000362f14b","isBodyEmpty":true,"children":[]},{"_id":"5bee7f7b28da650213243863","category":"58c02f80b094740f005116e3","parentDoc":"5bad45fd1a1b5f000362f14b","createdAt":"2018-11-16T08:27:39.526Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"contactAutomations\": [\n {\n \"contact\": \"10003\",\n \"seriesid\": \"1\",\n \"startid\": \"0\",\n \"status\": \"2\",\n \"batchid\": null,\n \"adddate\": \"2018-11-16T02:32:33-06:00\",\n \"remdate\": \"2018-11-16T02:32:33-06:00\",\n \"timespan\": \"0\",\n \"lastblock\": \"1\",\n \"lastlogid\": \"0\",\n \"lastdate\": \"2018-11-16T02:32:33-06:00\",\n \"completedElements\": \"0\",\n \"totalElements\": \"1\",\n \"completed\": 1,\n \"completeValue\": 100,\n \"links\": {\n \"automation\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/automation\",\n \"contact\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/contact\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contactAutomations/1/contactGoals\"\n },\n \"id\": \"1\",\n \"automation\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"1\",\n \"showcase_stats\": []\n }\n}","language":"json","status":200}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[],"url":"/contactAutomations","method":"get"},"isReference":true,"order":3,"slug":"list-all-contact-automations","type":"endpoint","title":"List all automations a contact is in","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5ba8f1054c8c220003a08e41","category":"58c02f80b094740f005116e3","createdAt":"2018-09-24T14:13:25.702Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":2,"slug":"fields","type":"basic","title":"Custom Fields","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5ba8f3b312256800034de1d2","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2018-09-24T14:24:51.045Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"fieldOptions\": [],\n \"fieldRels\": [],\n \"fields\": [\n {\n \"title\": \"Another Test Title\",\n \"descript\": null,\n \"type\": \"\",\n \"isrequired\": \"0\",\n \"perstag\": \"ANOTHER_TEST_TITLE\",\n \"defval\": null,\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"2\",\n \"cdate\": \"2018-11-15T21:43:38-06:00\",\n \"udate\": \"2018-11-15T21:43:38-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/2/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/2/relations\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": \"1\",\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": \"1\",\n \"rows\": \"2\",\n \"cols\": \"2\",\n \"visible\": \"1\",\n \"service\": \"google\",\n \"ordernum\": \"3\",\n \"cdate\": \"2018-11-15T21:42:40-06:00\",\n \"udate\": \"2018-11-15T21:49:52-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":201},{"name":"","code":"{\n \"message\": \"Forbidden\"\n}","language":"json","status":403},{"name":null,"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The field title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\"\n }\n ]\n}"},{"code":"{\n \"errors\": [\n {\n \"title\": \"There is already a field with this personalization tag\",\n \"detail\": \"There is already a personalization tag named 'Perstag' -- choose another name\",\n \"code\": \"field_invalid\"\n }\n ]\n}","language":"json","status":422},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"There is already a field with this title\",\n \"detail\": \"There is already a field named 'Test Title' -- choose another name\",\n \"code\": \"duplicate\"\n }\n ]\n}"}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"field\": {\n\t\t\"type\": \"textarea\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","name":"textarea"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"text\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"text"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"date\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"2019-01-01\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"date"},{"name":"dropdown","language":"json","code":"{\n\t\"field\": {\n\t\t\"type\": \"dropdown\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"listbox\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"multiselect"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"radio\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"radio"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"checkbox\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"checkbox"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"hidden\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"hidden"},{"code":"{\n\t\"field\": {\n\t\t\"type\": \"datetime\",\n\t\t\"title\": \"Field Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"2020-05-19T02:45:00-05:00\",\n\t\t\"visible\": 1,\n\t\t\"ordernum\": 1\n }\n}","language":"json","name":"datetime"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"field.title","type":"string","enumValues":"","default":"","desc":"Title of the field being created","required":true,"in":"body","ref":"","_id":"5baaa3bb02675500038e2b53"},{"name":"field.type","type":"string","enumValues":"","default":"","desc":"Possible Values: dropdown, hidden, checkbox, date, text, datetime, textarea, NULL, listbox, radio","required":true,"in":"body","ref":"","_id":"5bafe51e8a2fbe0003a91fb4"},{"name":"field.descript","type":"string","enumValues":"","default":"","desc":"Description of field being created","required":false,"in":"body","ref":"","_id":"5bafea2e8a2fbe0003a9202b"},{"name":"field.perstag","type":"string","enumValues":"","default":"","desc":"The perstag that represents the field being created","required":false,"in":"body","ref":"","_id":"5bafea2e8a2fbe0003a92029"},{"name":"field.defval","type":"string","enumValues":"","default":"","desc":"Default value of the field being created","required":false,"in":"body","ref":"","_id":"5bafea2e8a2fbe0003a92028"},{"name":"field.show_in_list","type":"boolean","enumValues":"","default":"","desc":"Show this field in the contact list view (Deprecated - no longer used)","required":false,"in":"body","ref":"","_id":"5bb00144b6fc1000030b065f"},{"name":"field.rows","type":"int","enumValues":"","default":"","desc":"Num of rows for a textarea (Deprecated - no longer used)","required":false,"in":"body","ref":"","_id":"5c5859903263ee005d5912b5"},{"name":"field.cols","type":"int","enumValues":"","default":"","desc":"Num of columns for a textarea (Deprecated - no longer used)","required":false,"in":"body","ref":"","_id":"5c5859903263ee005d5912b4"},{"name":"field.visible","type":"boolean","enumValues":"","default":"","desc":"Show or hide this field when using the Form Builder","required":false,"in":"body","ref":"","_id":"5bb00144b6fc1000030b065e"},{"name":"field.service","type":"string","enumValues":"","default":"","desc":"Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook","required":false,"in":"body","ref":"","_id":"5bb00dda14dfd100039347ca"},{"name":"field.ordernum","type":"int","enumValues":"","default":"","desc":"Order of appearance in ‘My Fields’ tab.","required":false,"in":"body","ref":"","_id":"5bb00dda14dfd100039347c9"}],"url":"/fields","method":"post"},"isReference":true,"order":0,"slug":"create-a-contact-custom-field","type":"endpoint","title":"Create a custom field","previousSlug":"retrieve-fields","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"651c7f8739bdbe000c10d8dd","api":{"method":"post","url":"/groupMembers","auth":"required","results":{"codes":[{"name":"","code":"{\n \"groupMember\": {\n \"id\": 87,\n \"group_id\": 1,\n \"rel_id\": 10,\n \"ordernum\": 18,\n \"created_by\": 1,\n \"updated_by\": 1,\n \"links\": {\n \"groupDefinition\": \"https://yourAccounut.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}","language":"json","status":200},{"name":"rel_id left blank","code":"{\n \"message\": \"Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:\\n{\\\"message\\\": {\\\"rel_id\\\": \\\"rel_id is required\\\"}}\\n\\n\"\n}","language":"json","status":403},{"name":null,"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The field title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\"\n }\n ]\n}"},{"code":"{\n \"message\": \"No Result found for GroupDefinition with id 94\"\n}","language":"json","status":404}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"groupMember\": {\n\t\t\"rel_id\": \"10\",\n\t\t\"ordernum\": null,\n\t\t\"group_id\": \"1\"\n\t}\n}\n","name":"POST"}]},"apiSetting":"58b53c301065f9c438aa1f77","params":[{"name":"rel_id","type":"int","enumValues":"","default":"","desc":"Custom field ID","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5f1"},{"name":"ordernum","type":"int","enumValues":"","default":"","desc":"Order within the field group, use null to append","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5f0"},{"name":"group_id","type":"int","enumValues":"","default":"Field group ID (see notes)","desc":"","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5ef"}]},"title":"Add Custom Field to Field Group","icon":"","type":"endpoint","slug":"add-custom-field-to-field-group","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-a-custom-field-copy","parentDoc":"5ba8f1054c8c220003a08e41","category":"58c02f80b094740f005116e3","createdAt":"2023-10-03T20:54:31.268Z","isBodyEmpty":false,"children":[]},{"_id":"65204d3dffb219004ba48719","api":{"method":"delete","url":"/groupMembers/{groupID}","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}","language":"json","status":404}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"groupMember\": {\n\t\t\"rel_id\": \"10\",\n\t\t\"ordernum\": null,\n\t\t\"group_id\": \"1\"\n\t}\n}\n","name":"POST"}]},"apiSetting":"58b53c301065f9c438aa1f77","params":[{"name":"groupID","type":"string","enumValues":"","default":"","desc":"Group ID","required":false,"in":"path","ref":"","_id":"65204e0ef93d210014985683"}]},"title":"Delete Custom Field Field Group","icon":"","type":"endpoint","slug":"delete-custom-field-field-group","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-custom-field-field-group","parentDoc":"5ba8f1054c8c220003a08e41","category":"58c02f80b094740f005116e3","createdAt":"2023-10-06T18:09:01.499Z","isBodyEmpty":true,"children":[]},{"_id":"5ba8fd7812256800034de288","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2018-09-24T15:06:32.477Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"field\": {\n\t\t\"type\": \"textarea\",\n\t\t\"title\": \"Title\",\n\t\t\"descript\": \"Field description\",\n\t\t\"perstag\": \"Personalized Tag\",\n\t\t\"defval\": \"Defaut Value\",\n\t\t\"show_in_list\": 1,\n\t\t\"rows\": 2,\n\t\t\"cols\": 2,\n\t\t\"visible\": 1,\n\t\t\"service\": \"google\",\n\t\t\"ordernum\": 3\n }\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"field\": {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": 0,\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": 1,\n \"rows\": 2,\n \"cols\": 2,\n \"visible\": 1,\n \"service\": \"google\",\n \"ordernum\": 3,\n \"cdate\": \"2018-09-25T16:06:08-05:00\",\n \"udate\": \"2018-09-29T18:23:20-05:00\",\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/3/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/3/relations\"\n },\n \"id\": \"3\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Forbidden\"\n}","language":"json","status":403}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field to update","required":false,"in":"path","ref":"","_id":"5ba8fdd5e360c80003469ffc"},{"name":"field.type","type":"string","enumValues":"","default":"","desc":"Possible Values: dropdown, hidden, checkbox, date, datetime, text, textarea, NULL, listbox, radio","required":false,"in":"body","ref":"","_id":"5bb0014614dfd10003934787"},{"name":"field.title","type":"string","enumValues":"","default":"","desc":"Title of the field being updated","required":false,"in":"body","ref":"","_id":"5bb009a2b6fc1000030b068e"},{"name":"field.descript","type":"string","enumValues":"","default":"","desc":"Description of field being updated","required":false,"in":"body","ref":"","_id":"5bb009a2b6fc1000030b068d"},{"name":"field.perstag","type":"string","enumValues":"","default":"","desc":"The perstag that represents the field being created","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4d2"},{"name":"field.defval","type":"string","enumValues":"","default":"","desc":"Default value of the field being created","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4d1"},{"name":"field.show_in_list","type":"boolean","enumValues":"","default":"","desc":"Show this field in the contact list view (No longer Used)","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4d0"},{"name":"field.visible","type":"boolean","enumValues":"","default":"","desc":"Setting to show/hide field","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4cf"},{"name":"field.service","type":"string","enumValues":"","default":"","desc":"Possible Vales: nimble, contactually, mindbody, salesforce, highrise, google_spreadsheets, pipedrive, onepage, google_contacts, freshbooks, shopify, zendesk, etsy, NULL, bigcommerce, capsule, bigcommerce_oauth, sugarcrm, zohocrm, batchbook","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4ce"},{"name":"field.ordernum","type":"string","enumValues":"","default":"","desc":"Order of appearance in ‘My Fields’ tab.","required":false,"in":"body","ref":"","_id":"5bb00dcaa78760000374a4cd"}],"url":"/fields/:id","method":"put"},"isReference":true,"order":3,"slug":"update-a-field","type":"endpoint","title":"Update a custom field","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5ba8f86f12256800034de20d","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2018-09-24T14:45:03.129Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"fieldOptions\": [],\n \"fieldRels\": [\n {\n \"field\": \"1\",\n \"relid\": \"0\",\n \"dorder\": \"0\",\n \"cdate\": \"2018-08-17T11:09:43-05:00\",\n \"links\": [],\n \"id\": \"1\"\n }\n ],\n \"field\": {\n \"title\": \"test\",\n \"descript\": \"\",\n \"type\": \"text\",\n \"isrequired\": \"0\",\n \"perstag\": \"TEST\",\n \"defval\": \"\",\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"1\",\n \"cdate\": \"2018-08-17T11:09:43-05:00\",\n \"udate\": \"2018-08-17T11:09:43-05:00\",\n \"options\": [],\n \"relations\": [\n \"1\"\n ],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/3/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/3/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n}","name":null},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field to retrieve","required":false,"in":"path","ref":"","_id":"5ba8fb254c8c220003a08ee8"}],"url":"/fields/:id","method":"get"},"isReference":true,"order":4,"slug":"retrieve-a-custom-field-contact","type":"endpoint","title":"Retrieve a custom field","deprecated":false,"previousSlug":"retrieve-a-field","isBodyEmpty":false,"children":[]},{"_id":"65204f920986350079bf0f35","api":{"method":"get","url":"/groupMembers/{groupID}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"groupMember\": {\n \"id\": 89,\n \"group_id\": 1,\n \"rel_id\": 5,\n \"ordernum\": 20,\n \"links\": {\n \"groupDefinition\": \"https://:account.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}","language":"json","status":200},{"code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}","language":"json","status":404}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"groupMember\": {\n\t\t\"rel_id\": \"10\",\n\t\t\"ordernum\": null,\n\t\t\"group_id\": \"1\"\n\t}\n}\n","name":"POST"}]},"apiSetting":"58b53c301065f9c438aa1f77","params":[{"name":"groupID","type":"string","enumValues":"","default":"","desc":"Group ID","required":false,"in":"path","ref":"","_id":"65204e0ef93d210014985683"}]},"title":"Get Custom Field to Field Group","icon":"","type":"endpoint","slug":"get-custom-field-to-field-group","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-custom-field-to-field-group-copy","parentDoc":"5ba8f1054c8c220003a08e41","category":"58c02f80b094740f005116e3","createdAt":"2023-10-06T18:18:58.093Z","isBodyEmpty":true,"children":[]},{"_id":"65204ed963a50c006c83c682","api":{"method":"put","url":"/groupMembers/:groupId","auth":"required","results":{"codes":[{"name":"","code":"{\n \"groupMember\": {\n \"id\": 87,\n \"group_id\": 1,\n \"rel_id\": 10,\n \"ordernum\": 18,\n \"created_by\": 1,\n \"updated_by\": 1,\n \"links\": {\n \"groupDefinition\": \"https://yourAccounut.api-us1.com/api/3/groupDefinitions/1\"\n }\n }\n}","language":"json","status":200},{"name":"rel_id left blank","code":"{\n \"message\": \"Client error: `POST https://escape-velocity-grouper.cluster-private.app-us1.com/member` resulted in a `400 Bad Request` response:\\n{\\\"message\\\": {\\\"rel_id\\\": \\\"rel_id is required\\\"}}\\n\\n\"\n}","language":"json","status":403},{"name":null,"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The field title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\"\n }\n ]\n}"},{"code":"{\n \"message\": \"No Result found for GroupDefinition with id 94\"\n}","language":"json","status":404}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"groupMember\": {\n\t\t\"rel_id\": \"10\",\n\t\t\"ordernum\": null,\n\t\t\"group_id\": \"1\"\n\t}\n}\n","name":"POST"}]},"apiSetting":"58b53c301065f9c438aa1f77","params":[{"name":"rel_id","type":"int","enumValues":"","default":"","desc":"Custom field ID","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5f1"},{"name":"ordernum","type":"int","enumValues":"","default":"","desc":"Order within the field group, use null to append","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5f0"},{"name":"group_id","type":"int","enumValues":"","default":"Field group ID (see notes)","desc":"","required":false,"in":"body","ref":"","_id":"651c89b8a8a9a009410fe5ef"},{"name":"groupId","type":"string","enumValues":"","default":"","desc":"Field group ID (see notes)","required":false,"in":"path","ref":"","_id":"65204f4cc4bfa8001e5ae3e9"}]},"title":"Update Custom Field Field Group","icon":"","type":"endpoint","slug":"update-custom-field-field-group","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"add-custom-field-to-field-group-copy","parentDoc":"5ba8f1054c8c220003a08e41","category":"58c02f80b094740f005116e3","createdAt":"2023-10-06T18:15:53.263Z","isBodyEmpty":false,"children":[]},{"_id":"5ba900a6e360c8000346a027","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2018-09-24T15:20:06.461Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Field with id 99\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field option to delete","required":false,"in":"path","ref":"","_id":"5ba900a6e360c8000346a028"}],"url":"/fields/:id","method":"delete"},"isReference":true,"order":7,"slug":"delete-a-field","type":"endpoint","title":"Delete a custom field","deprecated":false,"previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5ba8f1834c8c220003a08e48","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2018-09-24T14:15:31.280Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"fieldOptions\": [],\n \"fieldRels\": [],\n \"fields\": [\n {\n \"title\": \"Another Test Title\",\n \"descript\": null,\n \"type\": \"\",\n \"isrequired\": \"0\",\n \"perstag\": \"ANOTHER_TEST_TITLE\",\n \"defval\": null,\n \"show_in_list\": \"0\",\n \"rows\": \"0\",\n \"cols\": \"0\",\n \"visible\": \"1\",\n \"service\": \"\",\n \"ordernum\": \"2\",\n \"cdate\": \"2018-11-15T21:43:38-06:00\",\n \"udate\": \"2018-11-15T21:43:38-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/2/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/2/relations\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Title\",\n \"descript\": \"Field description\",\n \"type\": \"textarea\",\n \"isrequired\": \"1\",\n \"perstag\": \"PERSONALIZEDTAG\",\n \"defval\": \"Defaut Value\",\n \"show_in_list\": \"1\",\n \"rows\": \"2\",\n \"cols\": \"2\",\n \"visible\": \"1\",\n \"service\": \"google\",\n \"ordernum\": \"3\",\n \"cdate\": \"2018-11-15T21:42:40-06:00\",\n \"udate\": \"2018-11-15T21:49:52-06:00\",\n \"options\": [],\n \"relations\": [],\n \"links\": {\n \"options\": \"https://:account.api-us1.com/api/:version/fields/1/options\",\n \"relations\": \"https://:account.api-us1.com/api/:version/fields/1/relations\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":""}]},"auth":"required","params":[{"name":"limit","type":"int","enumValues":"","default":"100","desc":"The number of fields returned per request.","required":false,"in":"query","ref":"","_id":"5fdc040edaaed50041830efe"},{"name":"filters[perstag]","type":"string","enumValues":"","default":"","desc":"The custom field's persistant tag to filter by (Ex: CUSTOMER_GROUP)","required":false,"in":"query","ref":"","_id":"6695684a2a1e7300115ddb98"}],"url":"/fields","method":"get"},"isReference":true,"order":8,"slug":"retrieve-fields","type":"endpoint","title":"List all custom fields","previousSlug":"retrieve-fields-1","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5c545c9c61e9d300622b93b6","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2019-02-01T14:50:04.066Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"fieldRel\": {\n\t\t\"field\": 8,\n\t\t\"relid\": 2\n\t}\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"fieldRel\": {\n \"relid\": 2,\n \"field\": 8,\n \"cdate\": \"2019-02-01T08:39:25-06:00\",\n \"links\": [],\n \"id\": \"19\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Forbidden\"\n}","name":""}]},"auth":"required","params":[{"name":"fieldRel","type":"object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"fieldRel","_id":"5c545c9c61e9d300622b93b9"}],"url":"/fieldRels","method":"post"},"isReference":true,"order":9,"slug":"create-a-custom-field-relationship-to-lists","type":"endpoint","title":"Create a custom field relationship to list(s)","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5cb0b41fe2aea200315d50e7","createdAt":"2019-04-12T15:51:59.304Z","category":"58c02f80b094740f005116e3","parentDoc":"5ba8f1054c8c220003a08e41","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n \"fieldOptions\": [\n {\n \"orderid\": 1,\n \"value\": \"X\",\n \"label\": \"Option X\",\n \"isdefault\": false,\n \"field\": \"62\"\n },\n {\n \"orderid\": 2,\n \"value\": \"Y\",\n \"label\": \"Option Y\",\n \"isdefault\": false,\n \"field\": \"62\"\n },\n {\n \"orderid\": 3,\n \"value\": \"Z\",\n \"label\": \"Option Z\",\n \"isdefault\": false,\n \"field\": \"62\"\n }\n ]\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"fieldOptions\": [\n {\n \"orderid\": 1,\n \"value\": \"X\",\n \"label\": \"Option X\",\n \"isdefault\": 0,\n \"field\": \"62\",\n \"cdate\": \"2023-06-08T15:36:49-05:00\",\n \"udate\": \"2023-06-08T15:36:49-05:00\",\n \"links\": {\n \"field\": \"https://{{yourAccount}}.api-us1.com/api/3/fieldOptions/1/field\"\n },\n \"id\": \"1\"\n },\n {\n \"orderid\": 2,\n \"value\": \"Y\",\n \"label\": \"Option Y\",\n \"isdefault\": 0,\n \"field\": \"62\",\n \"cdate\": \"2023-06-08T15:36:49-05:00\",\n \"udate\": \"2023-06-08T15:36:49-05:00\",\n \"links\": {\n \"field\": \"https://{{yourAccount}}.api-us1.com/api/3/fieldOptions/2/field\"\n },\n \"id\": \"2\"\n },\n {\n \"orderid\": 3,\n \"value\": \"Z\",\n \"label\": \"Option Z\",\n \"isdefault\": 0,\n \"field\": \"62\",\n \"cdate\": \"2023-06-08T15:36:49-05:00\",\n \"udate\": \"2023-06-08T15:36:49-05:00\",\n \"links\": {\n \"field\": \"{{yourAccount}}.api-us1.com/api/3/fieldOptions/3/field\"\n },\n \"id\": \"3\"\n }\n ]\n}","name":""},{"status":422,"language":"json","code":"{\n \"errors\": \"Bulk operation failed. Request must contain an array of fieldOption objects.\"\n}","name":""}]},"auth":"required","params":[{"name":"field","type":"int","enumValues":"","default":"","desc":"ID of the custom field to add options to","required":true,"in":"body","ref":"","_id":"5cb0b41fe2aea200315d50ec"},{"name":"label","type":"string","enumValues":"","default":"","desc":"Name of the option","required":false,"in":"body","ref":"","_id":"5cb0b41fe2aea200315d50eb"},{"name":"value","type":"string","enumValues":"","default":"","desc":"Value of the option","required":true,"in":"body","ref":"","_id":"5cb0b41fe2aea200315d50ea"},{"name":"orderid","type":"int","enumValues":"","default":"","desc":"Order for displaying the custom field option","required":false,"in":"body","ref":"","_id":"5cb0b41fe2aea200315d50e9"},{"name":"isdefault","type":"boolean","enumValues":"","default":"","desc":"Whether or not this option is the default value","required":false,"in":"body","ref":"","_id":"5cb0b41fe2aea200315d50e8"}],"url":"/fieldOption/bulk","method":"post"},"isReference":true,"order":10,"slug":"create-custom-field-options","type":"endpoint","title":"Create custom field options","deprecated":false,"previousSlug":"bulk-create-custom-field-options","icon":"","isBodyEmpty":false,"children":[]},{"_id":"6244ba212bc34f00466c89ea","api":{"method":"delete","url":"/fieldRels/:fieldRelId","auth":"required","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Forbidden\"\n}","name":""}]},"params":[{"name":"fieldRelId","type":"int","enumValues":"","default":"","desc":"Field relationship ID to be deleted","required":false,"in":"path","ref":"","_id":"6244ba212bc34f00466c89eb"}]},"title":"Delete a custom field relationship to list(s)","type":"endpoint","slug":"delete-a-custom-field-relationship-to-lists","order":11,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-a-custom-field-relationship","parentDoc":"5ba8f1054c8c220003a08e41","createdAt":"2022-03-30T20:14:25.680Z","category":"58c02f80b094740f005116e3","isBodyEmpty":true,"children":[]}]},{"_id":"5b9ac8763acc1d0003c4001a","category":"58c02f80b094740f005116e3","createdAt":"2018-09-13T20:28:38.455Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":3,"slug":"fieldvalues","type":"basic","title":"Custom Field Values","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5ba3fdd58478340003427428","category":"58c02f80b094740f005116e3","parentDoc":"5b9ac8763acc1d0003c4001a","createdAt":"2018-09-20T20:06:45.706Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"name":"text/textarea/hidden value","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 3,\n \"value\": \"Blue\"\n },\n \"useDefaults\": true\n}"},{"name":"dropdown/radio value","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 4,\n \"value\": \"||option 1||option 2||option 3||\"\n }\n}"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 7,\n \"value\": \"2018-12-31\"\n }\n}","language":"json","name":"date value"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 7,\n \"value\": \"2020-05-19T02:45:00-05:00\"\n }\n}","language":"json","name":"datetime value ISO format"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 6,\n \"value\": \"||Option 1||Option 3||Option 4||\"\n }\n}","language":"json","name":"multiselect with multiple options"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 6,\n \"value\": \"||Option 2||\"\n }\n}","language":"json","name":"multiselect with single option"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2018-08-06T16:26:04-05:00\",\n \"email\": \"ikreimont+2@activecampaign.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"0\",\n \"ua\": null,\n \"hash\": \"14d8c4418ae944c68e9dde4a975854cc\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": \"2018-10-01T17:18:40-05:00\",\n \"edate\": null,\n \"deleted_at\": null,\n \"created_utc_timestamp\": \"2018-09-21 12:04:40\",\n \"updated_utc_timestamp\": \"2018-10-01 17:18:40\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/2/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/2/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/2/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/2/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/2/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/2/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/2/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/2/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/2/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/2/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/2/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/2/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/2/scoreValues\"\n },\n \"id\": \"2\",\n \"organization\": null\n }\n ],\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 3,\n \"value\": \"Blue\",\n \"cdate\": \"2018-10-01T17:18:40-05:00\",\n \"udate\": \"2018-10-01T17:18:40-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/:version/fieldValues/15/owner\",\n \"field\": \"https://:account.api-us1.com/api/:version/fieldValues/15/field\"\n },\n \"owner\": 2,\n \"id\": \"15\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Forbidden\"\n}","name":""}]},"auth":"required","params":[{"name":"fieldValue.contact","type":"string","enumValues":"","default":"","desc":"ID of the contact whose field value you're updating","required":true,"in":"body","ref":"","_id":"5bd0bb6953aa27004a8f11b3"},{"name":"fieldValue.field","type":"string","enumValues":"","default":"","desc":"ID of the custom field whose value you're updating for the contact","required":true,"in":"body","ref":"","_id":"5bd0bb6953aa27004a8f11b2"},{"name":"fieldValue.value","type":"string","enumValues":"","default":"","desc":"Value for the field that you're updating. For multi-select options this needs to be in the format of ||option1||option2||","required":true,"in":"body","ref":"","_id":"5bd0bb6953aa27004a8f11b1"},{"name":"useDefaults","type":"boolean","enumValues":"","default":"false","desc":"If true, this will populate the missing required fields for this contact with default values","required":false,"in":"body","ref":"","_id":"5fce947f0f519b01128540a0"}],"url":"/fieldValues","method":"post"},"isReference":true,"order":0,"slug":"create-fieldvalue","type":"endpoint","title":"Create a custom field value","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b9ac9403acc1d0003c40029","category":"58c02f80b094740f005116e3","parentDoc":"5b9ac8763acc1d0003c4001a","createdAt":"2018-09-13T20:32:00.332Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"fieldValue\": {\n \"contact\": \"0\",\n \"field\": null,\n \"value\": null,\n \"cdate\": \"2018-09-18T10:30:31-05:00\",\n \"udate\": \"2018-09-18T10:30:31-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/2/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/2/field\"\n },\n \"id\": \"2\",\n \"owner\": null\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for FieldValue with id 10\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the fieldValue to retrieve","required":false,"in":"path","ref":"","_id":"5b9ac9403acc1d0003c4002a"}],"url":"/fieldValues/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-fieldvalues","type":"endpoint","title":"Retrieve a custom field value","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bc751a3cd4bc40056dd5861","category":"58c02f80b094740f005116e3","parentDoc":"5b9ac8763acc1d0003c4001a","createdAt":"2018-10-17T15:13:39.948Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"name":"text/textarea/hidden value","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 4,\n \"field\": 24,\n \"value\": \"Blue\"\n },\n \"useDefaults\": true\n}"},{"name":"dropdown/radio value","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 5,\n \"value\": \"Option 1\"\n }\n}"},{"name":"checkbox/listbox values (multiple)","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 6,\n \"value\": \"||Option 1||Option 3||Option 4||\"\n }\n}"},{"name":"date value","language":"json","code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 7,\n \"value\": \"2018-12-31\"\n }\n}"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 7,\n \"value\": \"2020-05-19T02:45:00-05:00\"\n }\n}","language":"json","name":"datetime value (ISO)"},{"code":"{\n \"fieldValue\": {\n \"contact\": 2,\n \"field\": 6,\n \"value\": \"||Option 2||\"\n }\n}","language":"json","name":"checkbox/listbox values (single)"}]},"results":{"codes":[{"name":"","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2018-08-06T16:56:43-05:00\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"4\",\n \"ua\": \"\",\n \"hash\": \"867d56644591991f6b50e1cb913f038b\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2018-10-24T13:33:06-05:00\",\n \"udate\": \"2018-10-24T13:33:11-05:00\",\n \"edate\": \"2018-10-24T13:33:07-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"created_utc_timestamp\": \"2018-09-21 12:04:48\",\n \"updated_utc_timestamp\": \"2018-10-24 13:33:11\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/24/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/24/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/24/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/24/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/24/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/24/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/24/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/24/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/24/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/24/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/24/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/24/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/24/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/24/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/24/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/24/scoreValues\"\n },\n \"id\": \"24\",\n \"organization\": null\n }\n ],\n \"fieldValue\": {\n \"contact\": 4,\n \"field\": 24,\n \"value\": \"Blue\",\n \"cdate\": \"2018-10-24T13:32:52-05:00\",\n \"udate\": \"2018-10-24T13:33:11-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/:version/fieldValues/15/owner\",\n \"field\": \"https://:account.api-us1.com/api/:version/fieldValues/15/field\"\n },\n \"owner\": 4,\n \"id\": \"15\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"fieldValue.contact","type":"string","enumValues":"","default":"","desc":"ID of the contact whose field value you're updating","required":true,"in":"body","ref":"","_id":"5bd0bb899dbccc004a99ca58"},{"name":"fieldValue.field","type":"string","enumValues":"","default":"","desc":"ID of the custom field whose value you're updating for the contact","required":true,"in":"body","ref":"","_id":"5bd0bb99a01a3d00560e8e34"},{"name":"fieldValue.value","type":"string","enumValues":"","default":"","desc":"Value for the field that you're updating","required":true,"in":"body","ref":"","_id":"5bd0bba8db2d9a00134ac3cb"},{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the fieldValue to update","required":false,"in":"path","ref":"","_id":"5c00318f0efd3b021ee572fe"},{"name":"useDefaults","type":"boolean","enumValues":"","default":"false","desc":"If true, this will populate the missing required fields for this contact with default values","required":false,"in":"body","ref":"","_id":"5fce94b97beec3006cdf1a4e"}],"url":"/fieldValues/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-custom-field-value-for-contact","type":"endpoint","title":"Update a custom field value for contact","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5ba3fed0bde6e200031bb7e4","category":"58c02f80b094740f005116e3","parentDoc":"5b9ac8763acc1d0003c4001a","createdAt":"2018-09-20T20:10:56.457Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Forbidden\"\n}","name":""}]},"auth":"required","params":[{"_id":"5ba3fed0bde6e200031bb7e5","ref":"","in":"path","required":false,"desc":"ID of the fieldValue to delete","default":"","type":"int","name":"id"}],"url":"/fieldValues/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-fieldvalue-1","type":"endpoint","title":"Delete a custom field value","isBodyEmpty":true,"children":[]},{"_id":"5c002890f965a4021f262d47","category":"58c02f80b094740f005116e3","parentDoc":"5b9ac8763acc1d0003c4001a","createdAt":"2018-11-29T17:57:36.867Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"fieldValues\": [\n {\n \"contact\": \"5\",\n \"field\": \"1\",\n \"value\": \"Burger\",\n \"cdate\": \"2018-09-29T12:03:11-06:00\",\n \"udate\": \"2018-09-29T12:03:11-06:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/1/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/1/field\"\n },\n \"id\": \"1\",\n \"owner\": \"5\"\n },\n {\n \"contact\": \"7\",\n \"field\": \"2\",\n \"value\": \"2018-05-10\",\n \"cdate\": \"2018-04-24T12:04:46-06:00\",\n \"udate\": \"2018-04-24T12:04:46-06:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/fieldValues/2/owner\",\n \"field\": \"https://:account.api-us1.com/api/3/fieldValues/2/field\"\n },\n \"id\": \"2\",\n \"owner\": \"7\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"filters[fieldid]","type":"string","enumValues":"","default":"","desc":"ID of the field the value belongs to.","required":false,"in":"query","ref":"","_id":"5ce706ab38c70a0010ce2baf"},{"name":"filters[val]","type":"string","enumValues":"","default":"","desc":"Value of the custom field for a specific contact","required":false,"in":"query","ref":"","_id":"5ce706ab38c70a0010ce2bae"}],"url":"/fieldValues","method":"get"},"isReference":true,"order":4,"slug":"list-all-custom-field-values","type":"endpoint","title":"List all custom field values","deprecated":false,"previousSlug":"list-all-custom-field-values-1","isBodyEmpty":false,"children":[]}]},{"_id":"5b1ebec4a6a4c80003f2ba35","category":"58c02f80b094740f005116e3","createdAt":"2018-06-11T18:26:12.805Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]}},"isReference":true,"order":4,"slug":"email-emailactivities","type":"basic","title":"Email (emailActivities)","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b1ebf6aa6a4c80003f2ba4f","category":"58c02f80b094740f005116e3","parentDoc":"5b1ebec4a6a4c80003f2ba35","createdAt":"2018-06-11T18:28:58.818Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"filters[subscriberid]","type":"int","enumValues":"","default":"","desc":"Set this parameter to return only email activities belonging to a given subscriber.","required":false,"in":"query","ref":"","_id":"5b1ebfd7a6a4c80003f2ba67"},{"name":"filters[dealId]","type":"int","enumValues":"","default":"","desc":"Set this parameter to return only email activities belonging to a given deal.","required":false,"in":"query","ref":"","_id":"5ee79417763805002dfe5807"}],"url":"/emailActivities","method":"get","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]}},"isReference":true,"order":0,"slug":"list-all-email-activities","type":"endpoint","title":"List all email activities","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5939b4ca6c83cb003b99bb57","category":"58c02f80b094740f005116e3","createdAt":"2017-06-08T20:34:18.248Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":5,"slug":"contact-tags","type":"basic","title":"Tags","parentDoc":null,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[{"_id":"5939b866109baf00336c0ceb","category":"58c02f80b094740f005116e3","parentDoc":"5939b4ca6c83cb003b99bb57","createdAt":"2017-06-08T20:49:42.536Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n\t\"contactTag\": {\n\t\t\"cdate\": \"2017-06-08T16:11:53-05:00\",\n\t\t\"contact\":\"1\",\n\t\t\"id\":\"1\",\n\t\t\"links\":{\n\t\t\t\"contact\":\"/1/contact\",\n\t\t\t\"tag\":\"/1/tag\"\n\t\t},\n\t\t\"tag\":\"20\"\n\t}\n}"},{"status":404,"language":"json","code":"{\n \"errors\":[\n {\n \"status\":404,\n \"title\":\"Not Found\",\n \"detail\":\"Contact not found\"\n }\n ]\n}"},{"status":422,"language":"json","code":"{\n \"errors\":[\n {\n \"status\":422,\n \"title\":\"Missing attribute\",\n \"source\":{\n \"pointer\":\"/data/attributes/contact\"\n }\n }\n ]\n}"}]},"auth":"required","params":[{"name":"contactTag.contact","type":"int","enumValues":"","default":"1","desc":"The id of the Contact","required":false,"in":"body","ref":"contactTag","_id":"623a01292db1050477476c83"},{"name":"contactTag.tag","type":"int","enumValues":"","default":"20","desc":"The id of the tag","required":false,"in":"body","ref":"","_id":"624314f902b3d20027ab5af4"}],"url":"/contactTags","method":"post","examples":{"codes":[{"code":"{\n\t\"contactTag\": {\n\t\t\"contact\": \"1\",\n\t\t\"tag\": \"20\"\n\t}\n}","language":"json","name":"Example 1"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":0,"slug":"create-contact-tag","type":"endpoint","title":"Add a tag to contact","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"59414f253f18ca002f606430","category":"58c02f80b094740f005116e3","parentDoc":"5939b4ca6c83cb003b99bb57","createdAt":"2017-06-14T14:58:45.778Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}"},{"status":404,"language":"json","code":"{\n \"message\":\"No Result found for SubscriberTag with id 1\"\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The contactTag id","required":false,"in":"path","ref":"","_id":"59414f253f18ca002f606431"}],"url":"/contactTags/:id","method":"delete","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":1,"slug":"remove-a-contacts-tag","type":"endpoint","title":"Remove a tag from a contact","previousSlug":"delete-contact-tag","deprecated":false,"isBodyEmpty":false,"children":[]}]}]},{"_id":"6075e4661fc6a80010e74e4b","title":"Custom Objects","slug":"custom-objects-schema","order":10,"reference":true,"isAPI":false,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2021-04-13T18:35:18.162Z","__v":0,"pages":[{"_id":"6075e5e9fe3d34002a6af5eb","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Custom Object schemas","type":"basic","slug":"custom-object-schemas","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"schema-overview","createdAt":"2021-04-13T18:41:45.859Z","category":"6075e4661fc6a80010e74e4b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"607606415cacf300688e0d64","api":{"method":"get","url":"/customObjects/schemas","auth":"required","results":{"codes":[{"name":"","code":"{\n \"schemas\": [\n {\n \"id\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"slug\": \"my-object\",\n \"visibility\": \"private\",\n \"labels\": {\n \"singular\": \"My Object\",\n \"plural\": \"My Objects\"\n },\n \"description\": \"Sample Schema\",\n \"createdTimestamp\": \"2021-04-16T15:08:25.783751329Z\",\n \"updatedTimestamp\": \"2021-04-16T15:08:25.783751329Z\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"labels\": {\n \"singular\": \"Number\",\n \"plural\": \"Numbers\"\n },\n \"type\": \"number\",\n \"required\": false,\n \"scale\": 0\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact to this object\",\n \"namespace\": \"contacts\",\n \"hasMany\": false\n }\n ]\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"count\": 1,\n \"limit\": 20,\n \"offset\": 0\n }\n}\n","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"limit","type":"int","enumValues":"","default":"20","desc":"The number of schemas to retrieve for each API call. Maximum value is 100.","required":false,"in":"query","ref":"","_id":"607606ac1fc6a80010e7acc5"},{"name":"offset","type":"int","enumValues":"","default":"0","desc":"Offset index of items to return","required":false,"in":"query","ref":"","_id":"607606ac1fc6a80010e7acc4"},{"name":"orders","type":"array_string","enumValues":"","default":"","desc":"Array of sorting criteria to fetch items","required":false,"in":"query","ref":"","_id":"607606ac1fc6a80010e7acc3"},{"name":"filters","type":"string","enumValues":"","default":"","desc":"Filters schemas by different criteria","required":false,"in":"query","ref":"","_id":"61f9aa31335a5c05654c794a"},{"name":"showFields","type":"string","enumValues":"","default":"all","desc":"Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.","required":false,"in":"query","ref":"","_id":"62a35d4eae4c55009056b7c6"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List all schemas","type":"endpoint","slug":"list-all-schemas","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-13T20:59:45.343Z","parentDoc":"6075e5e9fe3d34002a6af5eb","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"607607934c50e4006881ad99","api":{"method":"get","url":"/customObjects/schemas/:id","auth":"required","results":{"codes":[{"name":"","code":"{\n \"schema\": {\n \"id\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"slug\": \"my-object\",\n \"visibility\": \"private\",\n \"labels\": {\n \"singular\": \"My Object\",\n \"plural\": \"My Objects\"\n },\n \"description\": \"Sample Schema\",\n \"createdTimestamp\": \"2021-04-16T15:08:25.783751329Z\",\n \"updatedTimestamp\": \"2021-04-16T15:08:25.783751329Z\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"labels\": {\n \"singular\": \"Number\",\n \"plural\": \"Numbers\"\n },\n \"type\": \"number\",\n \"required\": false,\n \"scale\": 0\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact to this object\",\n \"namespace\": \"contacts\",\n \"hasMany\": false\n }\n ]\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Not Found\"\n}","language":"json","status":404}]},"params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Id of the Schema","required":false,"in":"path","ref":"","_id":"607607934c50e4006881ad9a"},{"name":"showFields","type":"string","enumValues":"","default":"all","desc":"Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.","required":false,"in":"query","ref":"","_id":"62a35d642a4ac70027a319e0"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Retrieve a schema","type":"endpoint","slug":"retrieve-a-schema","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6075e5e9fe3d34002a6af5eb","createdAt":"2021-04-13T21:05:23.911Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"607608f6a5d6a100426e14cb","api":{"method":"post","url":"/customObjects/schemas","auth":"required","results":{"codes":[{"name":null,"code":"{\n \"schema\": {\n \"id\": \"2123028c-64e6-40e2-97bc-9d63a2ca920b\",\n \"slug\": \"my-object\",\n \"visibility\": \"private\",\n \"labels\": {\n \"singular\": \"My Object\",\n \"plural\": \"My Objects\"\n },\n \"description\": \"Sample Schema\",\n \"createdTimestamp\": \"2021-03-19T18:23:17.153996399Z\",\n \"updatedTimestamp\": \"2021-03-19T18:23:17.153996399Z\",\n \"fields\": [{\n \"id\": \"my-number-field\",\n \"labels\": {\n \"singular\": \"Number\",\n \"plural\": \"Numbers\"\n },\n \"type\": \"number\",\n \"required\": false,\n \"scale\": 0\n }],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [{\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact to this object\",\n \"namespace\": \"contacts\",\n \"hasMany\": false\n }]\n }\n}","language":"json","status":201},{"name":"invalid field value","code":"{\n \"errors\": [\n {\n \"title\": \"Invalid value for field \\\"schema.fields.labels\\\"\",\n \"detail\": \"Schema fields must provide labels\",\n \"source\": {\n \"type\": \"pointer\",\n \"value\": \"/data/attributes/schema/fields/labels\"\n }\n }\n ]\n}","language":"json","status":422},{"code":"{\n \"errors\": [\n {\n \"title\": \"Invalid value for field \\\"schema.slug\\\"\",\n \"detail\": \"Schema slug must be unique\",\n \"source\": {\n \"type\": \"pointer\",\n \"value\": \"/data/attributes/schema/slug\"\n }\n }\n ]\n}","language":"json","status":422,"name":"slug conflict"}]},"params":[{"name":"schema.slug","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"schema-create","_id":"6239d42a5db31503f7e6b9ac"},{"name":"schema.labels.singular","type":"string","enumValues":"","default":"","desc":"Singular label for Schema","required":false,"in":"body","ref":"","_id":"62434ee569ac0d008e759b53"},{"name":"schema.labels.plural","type":"string","enumValues":"","default":"","desc":"Plural label for Schema","required":false,"in":"body","ref":"","_id":"62434ee569ac0d008e759b52"},{"name":"schema.description","type":"string","enumValues":"","default":"","desc":"Description of the Schema","required":false,"in":"body","ref":"","_id":"62434ee569ac0d008e759b51"},{"name":"schema.fields","type":"array_object","enumValues":"","default":"","desc":"List of Schema fields","required":false,"in":"body","ref":"Schema-field","_id":"62434ee569ac0d008e759b50"},{"name":"schema.relationships","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"Schema-relationship","_id":"62434f67acecec0021c72ccd"}],"examples":{"codes":[{"code":"{\n\t\"schema\": {\n\t\t\"slug\": \"my-object\",\n\t\t\"labels\": {\n\t\t\t\"singular\": \"My Object\",\n\t\t\t\"plural\": \"My Objects\"\n\t\t},\n\t\t\"description\": \"Sample Schema\",\n\t\t\"fields\": [{\n\t\t\t\"id\": \"my-number-field\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Number\",\n\t\t\t\t\"plural\": \"Numbers\"\n\t\t\t},\n\t\t\t\"type\": \"number\",\n\t\t\t\"required\": false,\n\t\t\t\"scale\": 0\n\t\t}],\n\t\t\"relationships\": [{\n\t\t\t\"id\": \"primary-contact\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Primary Contact\",\n\t\t\t\t\"plural\": \"Primary Contacts\"\n\t\t\t},\n\t\t\t\"description\": \"Primary contact to this object\",\n\t\t\t\"namespace\": \"contacts\",\n\t\t\t\"hasMany\": false\n\t\t}]\n\t}\n}","language":"json","name":"A single field with a relationship to the contact"},{"code":"{\n\t\"schema\": {\n\t\t\"slug\": \"my-object\",\n\t\t\"labels\": {\n\t\t\t\"singular\": \"My Object\",\n\t\t\t\"plural\": \"My Objects\"\n\t\t},\n\t\t\"description\": \"Sample Schema\",\n\t\t\"fields\": [{\n\t\t\t\"id\": \"my-number-field\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Number\",\n\t\t\t\t\"plural\": \"Numbers\"\n\t\t\t},\n\t\t\t\"type\": \"number\",\n\t\t\t\"required\": false,\n\t\t\t\"scale\": 0\n\t\t}],\n\t\t\"relationships\": [{\n\t\t\t\"id\": \"account\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Account\",\n\t\t\t\t\"plural\": \"Accounts\"\n\t\t\t},\n\t\t\t\"description\": \"Accounts related to this object\",\n\t\t\t\"namespace\": \"accounts\",\n\t\t\t\"hasMany\": false\n\t\t}]\n\n\t}\n}","language":"json","name":"A single field with a relationship to an account"},{"code":"{\n\t\"schema\": {\n\t\t\"slug\": \"my-object\",\n\t\t\"labels\": {\n\t\t\t\"singular\": \"My Object\",\n\t\t\t\"plural\": \"My Objects\"\n\t\t},\n\t\t\"description\": \"Sample Schema\",\n\t\t\"fields\": [{\n\t\t\t\"id\": \"my-number-field\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Number\",\n\t\t\t\t\"plural\": \"Numbers\"\n\t\t\t},\n\t\t\t\"type\": \"number\",\n\t\t\t\"required\": false,\n\t\t\t\"scale\": 0\n\t\t}],\n\t\t\"relationships\": [{\n\t\t\t\"id\": \"deal\",\n\t\t\t\"labels\": {\n\t\t\t\t\"singular\": \"Deal\",\n\t\t\t\t\"plural\": \"Deals\"\n\t\t\t},\n\t\t\t\"description\": \"Deals related to this object\",\n\t\t\t\"namespace\": \"deals\",\n\t\t\t\"hasMany\": false\n\t\t}]\n\n\t}\n}","language":"json","name":"A single field with a relationship to a deal"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a schema","type":"endpoint","slug":"create-a-schema","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6075e5e9fe3d34002a6af5eb","createdAt":"2021-04-13T21:11:18.877Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"60760a82198bbb001c7afb48","api":{"method":"put","url":"/customObjects/schemas/{schemaId}","auth":"required","results":{"codes":[{"name":"","code":"{\n \"schema\": {\n \"id\": \"schema-9999-9999\",\n \"slug\": \"stripe-order\",\n \"labels\": {\n \"singular\": \"Stripe Order\",\n \"plural\": \"Stripe Orders\"\n },\n \"description\": \"Orders placed through the Stripe integration\",\n \"appId\": \"123456\",\n \"fields\": [\n {\n \"id\": \"name\",\n \"labels\": {\n \"singular\": \"Product Name\",\n \"plural\": \"Product Name\"\n },\n \"description\": \"Name of the product from the Stripe integration\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"text\"\n },\n {\n \"id\": \"total\",\n \"labels\": {\n \"singular\": \"Order Total\",\n \"plural\": \"Order Totals\"\n },\n \"description\": \"Total cost of the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"currency\",\n \"defaultCurrency\": \"USD\"\n },\n {\n \"id\": \"status\",\n \"labels\": {\n \"singular\": \"Order Status\",\n \"plural\": \"Order Statuses\"\n },\n \"description\": \"Status of the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"dropdown\",\n \"options\": [\n {\n \"id\": \"264d3b73-069e-4ca1-b270-dbfa3137b541\",\n \"value\": \"Processed\"\n }\n ]\n },\n {\n \"id\": \"features\",\n \"labels\": {\n \"singular\": \"Order Feature\",\n \"plural\": \"Order Features\"\n },\n \"description\": \"Extra features for the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"multiselect\",\n \"options\": [\n {\n \"id\": \"041ef416-a85b-678f-4a15-5dd481dad123\",\n \"value\": \"Expedited Shipping\"\n }\n ]\n },\n {\n \"id\": \"rating\",\n \"labels\": {\n \"singular\": \"Order Rating\",\n \"plural\": \"Order Ratings\"\n },\n \"description\": \"Customer satisfaction rating\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"decimal\",\n \"scale\": 2\n }\n ],\n \"icons\": {\n \"default\": \"https://activehosted.com/temp-placeholder.svg\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Products purchased in this Stripe order\",\n \"namespace\": \"contacts\",\n \"hasMany\": false\n }\n ],\n \"createdTimestamp\": \"2021-04-13T21:12:53.390Z\",\n \"updatedTimestamp\": \"2021-04-13T21:12:53.390Z\"\n }\n}","language":"json","status":200},{"code":"{\n \"errors\": [\n {\n \"title\": \"Invalid value for field \\\"{field_name}\\\"\",\n \"detail\": \"{description}\",\n \"source\": {\n \"type\": \"pointer\",\n \"value\": \"/data/attributes/{field_name}\"\n }\n }\n ]\n}","language":"json","status":422,"name":null},{"code":"","language":"json","status":404}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"Id of Schema being updated","required":false,"in":"path","ref":"","_id":"60760a82198bbb001c7afb4b"},{"name":"validateOnly","type":"boolean","enumValues":"","default":"false","desc":"When set to `true` the API will validate the schema update without saving changes","required":false,"in":"header","ref":"","_id":"60760a82198bbb001c7afb4a"},{"name":"schema.slug","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"62435762f48f6300139c527f"},{"name":"schema.labels.singular","type":"string","enumValues":"","default":"","desc":"Singular label for Schema","required":false,"in":"body","ref":"","_id":"62435762f48f6300139c527e"},{"name":"schema.labels.plural","type":"string","enumValues":"","default":"","desc":"Plural label for Schema","required":false,"in":"body","ref":"","_id":"62435762f48f6300139c527d"},{"name":"schema.description","type":"string","enumValues":"","default":"","desc":"Text description of the Schema","required":false,"in":"body","ref":"","_id":"62435762f48f6300139c527c"},{"name":"schema.appId","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"62435762f48f6300139c527b"},{"name":"schema.fields","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"schema-record-update-field","_id":"62435762f48f6300139c527a"},{"name":"schema.icons.default","type":"string","enumValues":"","default":"","desc":"URI location of the default icon shown on Schema","required":false,"in":"body","ref":"","_id":"62435c771faf4b00620381c8"},{"name":"schema.relationships","type":"object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"Schema-relationship","_id":"62435c771faf4b00620381c7"},{"name":"showFields","type":"string","enumValues":"","default":"all","desc":"Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.","required":false,"in":"query","ref":"","_id":"62a35d6f9e5dfe06664e43d1"}],"examples":{"codes":[{"code":"{\n \"schema\": {\n \"slug\": \"stripe-order\",\n \"labels\": {\n \"singular\": \"Stripe Order\",\n \"plural\": \"Stripe Orders\"\n },\n \"description\": \"Orders placed through the Stripe integration\",\n \"appId\": \"123456\",\n \"fields\": [\n {\n \"id\": \"name\",\n \"labels\": {\n \"singular\": \"Product Name\",\n \"plural\": \"Product Name\"\n },\n \"description\": \"Name of the product from the Stripe integration\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"text\"\n },\n {\n \"id\": \"total\",\n \"labels\": {\n \"singular\": \"Order Total\",\n \"plural\": \"Order Totals\"\n },\n \"description\": \"Total cost of the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"currency\",\n \"defaultCurrency\": \"USD\"\n },\n {\n \"id\": \"status\",\n \"labels\": {\n \"singular\": \"Order Status\",\n \"plural\": \"Order Statuses\"\n },\n \"description\": \"Status of the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"dropdown\",\n \"options\": [\n {\n \"value\": \"Processed\"\n }\n ]\n },\n {\n \"id\": \"features\",\n \"labels\": {\n \"singular\": \"Order Feature\",\n \"plural\": \"Order Features\"\n },\n \"description\": \"Extra features for the order\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"multiselect\",\n \"options\": [\n {\n \"value\": \"Expedited Shipping\"\n }\n ]\n },\n {\n \"id\": \"rating\",\n \"labels\": {\n \"singular\": \"Order Rating\",\n \"plural\": \"Order Ratings\"\n },\n \"description\": \"Customer satisfaction rating\",\n \"isRequired\": true,\n \"origin\": \"stripe\",\n \"type\": \"decimal\",\n \"scale\": 2\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Products purchased in this Stripe order\",\n \"namespace\": \"contacts\",\n \"hasMany\": false\n }\n ]\n }\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Update a schema","type":"endpoint","slug":"update-a-schema","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-13T21:17:54.177Z","parentDoc":"6075e5e9fe3d34002a6af5eb","category":"6075e4661fc6a80010e74e4b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60760bf0e78c2a03395a5796","api":{"method":"delete","url":"/customObjects/schemas/:id","auth":"required","results":{"codes":[{"name":"","code":"","language":"json","status":200},{"name":"","code":"{\n \"message\": \"Not Found\"\n}","language":"json","status":404}]},"params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Id of schema to delete","required":false,"in":"path","ref":"","_id":"607607934c50e4006881ad9a"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a schema","type":"endpoint","slug":"delete-a-schema","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6075e5e9fe3d34002a6af5eb","createdAt":"2021-04-13T21:24:00.253Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6286a475cb45730093d37ae8","api":{"method":"delete","url":"/customObjects/schemas/:schemaId/fields/:fieldId","auth":"required","results":{"codes":[{"name":"Accepted","code":"{\n \"schema\": {\n \"id\": \"82ec659f-8283-4e88-9df3-26f4585fec02\",\n \"slug\": \"my-object\",\n \"visibility\": \"private\",\n \"labels\": {\n \"singular\": \"My Object\",\n \"plural\": \"My Objects\"\n },\n \"description\": \"Sample Schema\",\n \"createdTimestamp\": \"2021-10-04T20:08:09.574382410Z\",\n \"updatedTimestamp\": \"2022-06-10T14:19:06.834158129Z\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"labels\": {\n \"singular\": \"Number\",\n \"plural\": \"Numbers\"\n },\n \"type\": \"number\",\n \"required\": false,\n \"scale\": 0,\n \"inherited\": false\n },\n {\n \"id\": \"multiselect\",\n \"labels\": {\n \"singular\": \"Multiselect\",\n \"plural\": \"Multiselect\"\n },\n \"type\": \"multiselect\",\n \"required\": false,\n \"options\": [\n {\n \"id\": \"c56d7f15-d61d-46a6-9b7e-edec21192cd5\",\n \"value\": \"Option 4\"\n },\n {\n \"id\": \"91fa9499-c08d-4b24-97c7-04a7fcf5d0dc\",\n \"value\": \"Option 5\"\n },\n {\n \"id\": \"42bc2e29-eab5-40ff-85cb-b703c7bc9fd9\",\n \"value\": \"Option 6\"\n }\n ],\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"test-field-1\",\n \"labels\": {\n \"singular\": \"test field\",\n \"plural\": \"test field\"\n },\n \"type\": \"text\",\n \"required\": false,\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"test-field\",\n \"labels\": {\n \"singular\": \"test field\",\n \"plural\": \"test field\"\n },\n \"type\": \"text\",\n \"required\": false,\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"dropdown\",\n \"labels\": {\n \"singular\": \"Dropdown\",\n \"plural\": \"Dropdown\"\n },\n \"type\": \"dropdown\",\n \"required\": false,\n \"options\": [\n {\n \"id\": \"81529d6b-b5f5-4b13-a3d7-f00b62f1072f\",\n \"value\": \"Option 1\"\n },\n {\n \"id\": \"0a9d10a0-a3ea-4247-a2ef-0ed990e2d908\",\n \"value\": \"Option 2\"\n },\n {\n \"id\": \"d60f84cf-cca5-4284-97fd-fdc833caa82b\",\n \"value\": \"Option 3\"\n }\n ],\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact to this object\",\n \"namespace\": \"contacts\",\n \"hasMany\": false,\n \"inherited\": false\n }\n ]\n }\n}","language":"json","status":202},{"code":"{\n \"schema\": {\n \"id\": \"82ec659f-8283-4e88-9df3-26f4585fec02\",\n \"slug\": \"my-object\",\n \"visibility\": \"private\",\n \"labels\": {\n \"singular\": \"My Object\",\n \"plural\": \"My Objects\"\n },\n \"description\": \"Sample Schema\",\n \"createdTimestamp\": \"2021-10-04T20:08:09.574382410Z\",\n \"updatedTimestamp\": \"2022-06-10T14:19:06.834158129Z\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"labels\": {\n \"singular\": \"Number\",\n \"plural\": \"Numbers\"\n },\n \"type\": \"number\",\n \"required\": false,\n \"scale\": 0,\n \"inherited\": false\n },\n {\n \"id\": \"multiselect\",\n \"labels\": {\n \"singular\": \"Multiselect\",\n \"plural\": \"Multiselect\"\n },\n \"type\": \"multiselect\",\n \"required\": false,\n \"options\": [\n {\n \"id\": \"c56d7f15-d61d-46a6-9b7e-edec21192cd5\",\n \"value\": \"Option 4\"\n },\n {\n \"id\": \"91fa9499-c08d-4b24-97c7-04a7fcf5d0dc\",\n \"value\": \"Option 5\"\n },\n {\n \"id\": \"42bc2e29-eab5-40ff-85cb-b703c7bc9fd9\",\n \"value\": \"Option 6\"\n }\n ],\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"test-field-1\",\n \"labels\": {\n \"singular\": \"test field\",\n \"plural\": \"test field\"\n },\n \"type\": \"text\",\n \"required\": false,\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"test-field\",\n \"labels\": {\n \"singular\": \"test field\",\n \"plural\": \"test field\"\n },\n \"type\": \"text\",\n \"required\": false,\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n },\n {\n \"id\": \"dropdown\",\n \"labels\": {\n \"singular\": \"Dropdown\",\n \"plural\": \"Dropdown\"\n },\n \"type\": \"dropdown\",\n \"required\": false,\n \"options\": [\n {\n \"id\": \"81529d6b-b5f5-4b13-a3d7-f00b62f1072f\",\n \"value\": \"Option 1\"\n },\n {\n \"id\": \"0a9d10a0-a3ea-4247-a2ef-0ed990e2d908\",\n \"value\": \"Option 2\"\n },\n {\n \"id\": \"d60f84cf-cca5-4284-97fd-fdc833caa82b\",\n \"value\": \"Option 3\"\n }\n ],\n \"inherited\": false,\n \"status\": \"marked_for_deletion\"\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n },\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact to this object\",\n \"namespace\": \"contacts\",\n \"hasMany\": false,\n \"inherited\": false\n }\n ]\n }\n}","language":"json","status":202,"name":null}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"Schema ID of the field to be deleted","required":false,"in":"path","ref":"","_id":"6286a4e0859dbc0034fbdcfb"},{"name":"fieldId","type":"string","enumValues":"","default":"","desc":"Field ID of the field to be deleted","required":false,"in":"path","ref":"","_id":"6286a4e0859dbc0034fbdcfa"},{"name":"showFields","type":"string","enumValues":"","default":"all","desc":"Toggle which fields are shown in the response body of a schema (if there hidden due to e.g. recently being deleted). Omit this parameter entirely to hide fields by default.","required":false,"in":"query","ref":"","_id":"6286aa1b5be83b002e058c6e"}],"examples":{"codes":[{"code":"","language":"java"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a field","type":"endpoint","slug":"delete-a-field-1","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-05-19T20:11:33.157Z","parentDoc":"6075e5e9fe3d34002a6af5eb","category":"6075e4661fc6a80010e74e4b","isBodyEmpty":true,"children":[]}]},{"_id":"610c39b571bf40001c5fec3a","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Parent and Child Schemas","type":"basic","slug":"parent-and-child-schemas","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-05T19:19:17.012Z","category":"6075e4661fc6a80010e74e4b","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"610c3ad08c064a0010a6fd39","api":{"method":"post","url":"/customObjects/schemas/public","auth":"required","results":{"codes":[{"name":"","code":"{\n \"schema\": {\n \"id\": \"230f6065-a8e5-4df2-a70a-f6832d004d8d\",\n \"slug\": \"app-230f6065-a8e5-4df2-a70a-f6832d004d8d-event-tickets\",\n \"visibility\": \"public\",\n \"labels\": {\"singular\": \"Event Ticket\", \"plural\": \"Event Tickets\"},\n \"description\": \"Event Tickets\",\n \"appId\": \"cxapp-studio-app-id\",\n \"fields\": [\n {\n \"id\": \"name\",\n \"labels\": {\"singular\": \"Name\", \"plural\": \"Names\"},\n \"type\": \"textarea\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact that owns a ticket\",\n \"namespace\": \"contacts\",\n \"hasMany\": false,\n \"inherited\": false\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n }\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"schema.slug","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"6243627f319588003caec140"},{"name":"schema.appId","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"6243627f319588003caec13f"},{"name":"schema.labels","type":"object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"Schema-labels","_id":"6243627f319588003caec13e"},{"name":"schema.description","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"6243627f319588003caec13d"},{"name":"schema.fields","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"Schema-field","_id":"6243627f319588003caec13c"},{"name":"schema.relationships","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"Schema-relationship","_id":"6243627f319588003caec13b"}],"examples":{"codes":[{"code":"{\n \"schema\": {\n \"slug\": \"event-tickets\",\n \"appId\": \"cxapp-studio-app-id\",\n \"labels\": {\"singular\": \"Event Ticket\", \"plural\": \"Event Tickets\"},\n \"description\": \"Event Tickets\",\n \"fields\": [\n {\n \"id\": \"name\",\n \"labels\": {\"singular\": \"Name\", \"plural\": \"Names\"},\n \"type\": \"textarea\"\n }\n ],\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact that owns a ticket\",\n \"namespace\": \"contacts\"\n }\n ]\n }\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a public schema","type":"endpoint","slug":"create-a-public-schema","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-05T19:24:00.074Z","parentDoc":"610c39b571bf40001c5fec3a","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"610c3b5adaeb360016092669","api":{"method":"post","url":"/customObjects/schemas/:id/child","auth":"required","results":{"codes":[{"name":"","code":"{\n \"schema\": {\n \"id\": \"475c4ea7-65cc-4d59-a690-6ac232633fca\",\n \"parentId\": \"230f6065-a8e5-4df2-a70a-f6832d004d8d\",\n \"slug\": \"app-cxapp-studio-app-id-event-tickets\",\n \"appId\": \"cxapp-studio-app-id\",\n \"visibility\": \"private\",\n \"labels\": {\"singular\": \"Event Ticket\", \"plural\": \"Event Tickets\"},\n \"description\": \"Event Tickets\",\n \"fields\": [\n {\n \"id\": \"name\",\n \"labels\": {\"singular\": \"Name\", \"plural\": \"Names\"},\n \"type\": \"textarea\",\n \"inherited\": true\n }\n ],\n \"relationships\": [\n {\n \"id\": \"primary-contact\",\n \"labels\": {\n \"singular\": \"Primary Contact\",\n \"plural\": \"Primary Contacts\"\n },\n \"description\": \"Primary contact that owns a ticket\",\n \"namespace\": \"contacts\",\n \"inherited\": true\n }\n ],\n \"icons\": {\n \"default\": \"https://d226aj4ao1t61q.cloudfront.net/n9mayqo2d_customobject.png\"\n }\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Id of the parent schema the new child schema will extend","required":false,"in":"path","ref":"","_id":"610c3b5adaeb36001609266a"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a child schema","type":"endpoint","slug":"create-a-child-schema","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-08-05T19:26:18.860Z","parentDoc":"610c39b571bf40001c5fec3a","category":"6075e4661fc6a80010e74e4b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"60760d5ddc3a13000fed1409","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Managing Records","type":"basic","slug":"custom-object-records","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"custom-objects-data","createdAt":"2021-04-13T21:30:05.149Z","category":"6075e4661fc6a80010e74e4b","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"60773dff2ae6560032ddd69c","api":{"method":"get","url":"/customObjects/records/:schemaId","auth":"required","results":{"codes":[{"name":"200","code":"{\n \"records\": [\n {\n \"id\": \"1fba439a-208e-48e6-bd23-f6c97c3e0519\",\n \"externalId\": \"test-obj-1\",\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"primary-contact\": [\n \"14\"\n ]\n },\n \"createdTimestamp\": \"2021-04-16T16:12:22.222685095Z\",\n \"updatedTimestamp\": \"2021-04-16T16:13:12.022671090Z\"\n }\n ],\n \"meta\": {\n \"total\": 1,\n \"count\": 1,\n \"limit\": 20,\n \"offset\": 0\n }\n}\n","language":"json","status":200},{"name":"","code":"{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}","language":"json","status":400},{"code":"{\n \"message\": \"Not Found\"\n}","language":"text","status":404}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60773dff2ae6560032ddd69f"},{"name":"limit","type":"int","enumValues":"","default":"20","desc":"The number of records to return for each call. Maximum value is 100.","required":false,"in":"query","ref":"","_id":"60773dff2ae6560032ddd69e"},{"name":"offset","type":"int","enumValues":"","default":"0","desc":"Offset index of records to return","required":false,"in":"query","ref":"","_id":"60773dff2ae6560032ddd69d"},{"name":"filters","type":"array_string","enumValues":"","default":"","desc":"Use ?filters[relationships.{your-contact-relationship}][eq]={contactId} to filter records to a specific contact.","required":false,"in":"query","ref":"","_id":"6079b8fc3453330063a289ee"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List records by schema","type":"endpoint","slug":"list-records-created-from-a-schema","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-objects-created-from-a-schema","createdAt":"2021-04-14T19:09:51.691Z","parentDoc":"60760d5ddc3a13000fed1409","category":"6075e4661fc6a80010e74e4b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60774bf09070bf004778736f","api":{"method":"post","url":"/customObjects/records/:schemaId","auth":"required","results":{"codes":[{"name":"","code":"{\n \"record\": {\n \t\"id\": \"test-obj-1\",\n \t\"externalId\": \"test-obj-1\",\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"account\": [123]\n }\n }\n}","language":"json","status":201},{"name":"","code":"{\"errors\":[{\"status\":400,\"title\":\"Bad Request\"}]}","language":"json","status":400},{"code":"{\n \"errors\": [\n {\n \"title\": \"Invalid value for field \\\"{field_name}\\\"\",\n \"detail\": \"{field_name} cannot accept a value that is not defined in the schema.\",\n \"source\": {\n \"type\": \"pointer\",\n \"value\": \"/data/attributes/{field_name}\"\n }\n }\n ]\n}","language":"text","status":422,"name":"invalid field value"}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60773dff2ae6560032ddd69f"},{"name":"record.id","type":"string","enumValues":"","default":"","desc":"The Record's id","required":false,"in":"body","ref":"","_id":"6243690bc64956006c14144d"},{"name":"record.externalId","type":"string","enumValues":"","default":"","desc":"The Record's external id","required":false,"in":"body","ref":"","_id":"6243690bc64956006c14144c"},{"name":"record.fields","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"schema-record-update-field","_id":"6243690bc64956006c14144b"},{"name":"record.relationships","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"schema-record-update-relationship","_id":"6243690bc64956006c14144a"}],"examples":{"codes":[{"code":"{\n \"record\": {\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"id\": \"test-obj-1\",\n \"externalId\": \"test-obj-1\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"primary-contact\": [\n 14\n ]\n }\n }\n}\n","language":"json","name":"Create with Contact"},{"code":"{\n \"record\": {\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"id\": \"test-obj-1\",\n \"externalId\": \"test-obj-1\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"deal\": [22]\n }\n }\n}\n","language":"json","name":"Create with Deal"},{"code":"{\n \"record\": {\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"id\": \"test-obj-1\",\n \"externalId\": \"test-obj-1\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"account\": [123]\n }\n }\n}\n","language":"json","name":"Create with Account"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create or update record","type":"endpoint","slug":"create-or-update-record","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"create-or-update-object","parentDoc":"60760d5ddc3a13000fed1409","createdAt":"2021-04-14T20:09:20.331Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"60774ccfee6ec30063dc88cc","api":{"method":"get","url":"/customObjects/records/:schemaId/:recordId","auth":"required","results":{"codes":[{"name":"Success","code":"{\n \"record\": {\n \"id\": \"1fba439a-208e-48e6-bd23-f6c97c3e0519\",\n \"externalId\": \"test-obj-1\",\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"primary-contact\": [\n \"14\"\n ]\n },\n \"createdTimestamp\": \"2021-04-16T16:12:22.222685095Z\",\n \"updatedTimestamp\": \"2021-04-16T16:13:12.022671090Z\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}","language":"json","status":400}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60773dff2ae6560032ddd69f"},{"name":"recordId","type":"string","enumValues":"","default":"","desc":"ID of record","required":false,"in":"path","ref":"","_id":"60774ccfee6ec30063dc88cd"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Get a record by id","type":"endpoint","slug":"get-a-single-record","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"get-a-single-object","parentDoc":"60760d5ddc3a13000fed1409","createdAt":"2021-04-14T20:13:03.130Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"60898ac9d5943f0016b666fc","api":{"method":"get","url":"/records/:schemdId/external/:externalId","auth":"required","results":{"codes":[{"name":"","code":"{\n \"record\": {\n \"id\": \"1fba439a-208e-48e6-bd23-f6c97c3e0519\",\n \"externalId\": \"test-obj-1\",\n \"schemaId\": \"6449c3f3-b68d-46d1-850b-c8aea998ce1b\",\n \"fields\": [\n {\n \"id\": \"my-number-field\",\n \"value\": 100\n }\n ],\n \"relationships\": {\n \"primary-contact\": [\n \"14\"\n ]\n },\n \"createdTimestamp\": \"2021-04-16T16:12:22.222685095Z\",\n \"updatedTimestamp\": \"2021-04-16T16:13:12.022671090Z\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}","language":"json","status":400}]},"params":[{"name":"schemdId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60898ac9d5943f0016b666fe"},{"name":"externalId","type":"string","enumValues":"","default":"","desc":"External ID for record","required":false,"in":"path","ref":"","_id":"60898ac9d5943f0016b666fd"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Get a record by external id","type":"endpoint","slug":"get-a-single-record-using-external-id","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-28T16:18:17.406Z","parentDoc":"60760d5ddc3a13000fed1409","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"60774d14b8250600112c1ca0","api":{"method":"delete","url":"/customObjects/records/:schemaId/:recordId","auth":"required","results":{"codes":[{"name":"","code":"","language":"json","status":202},{"name":"","code":"{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}","language":"json","status":400}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60773dff2ae6560032ddd69f"},{"name":"recordId","type":"string","enumValues":"","default":"","desc":"ID of record","required":false,"in":"path","ref":"","_id":"60774ccfee6ec30063dc88cd"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a record by id","type":"endpoint","slug":"delete-a-record","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-an-object","parentDoc":"60760d5ddc3a13000fed1409","createdAt":"2021-04-14T20:14:12.622Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":true,"children":[]},{"_id":"60774d60ad3c51005fd5d238","api":{"method":"delete","url":"/customObjects/records/:schemaId/external/:externalId","auth":"required","results":{"codes":[{"name":"","code":"","language":"json","status":202},{"name":"","code":"{\n \"errors\": [\n {\n \"status\":400,\n \"title\":\"Bad Request\"\n }\n ]\n}","language":"json","status":400}]},"params":[{"name":"schemaId","type":"string","enumValues":"","default":"","desc":"ID of schema","required":false,"in":"path","ref":"","_id":"60773dff2ae6560032ddd69f"},{"name":"externalId","type":"string","enumValues":"","default":"","desc":"External ID of record","required":false,"in":"path","ref":"","_id":"60774ccfee6ec30063dc88cd"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a record by external ID","type":"endpoint","slug":"delete-a-record-by-external-id","order":5,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-an-object-by-external-id","parentDoc":"60760d5ddc3a13000fed1409","createdAt":"2021-04-14T20:15:28.030Z","category":"6075e4661fc6a80010e74e4b","deprecated":false,"isBodyEmpty":true,"children":[]}]},{"_id":"60787ca81efdd2000fafcc49","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Paging, Ordering, Sorting, and Filtering","type":"basic","slug":"paging-ordering-sorting-and-filtering","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-15T17:49:28.024Z","category":"6075e4661fc6a80010e74e4b","parentDoc":null,"deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"58b5ee57e31a610f003a59b5","title":"Deals","project":"57b6f40e480bae1900ce4e21","isAPI":false,"createdAt":"2017-02-28T21:40:39.897Z","order":11,"slug":"deals","__v":0,"version":"57b6f40e480bae1900ce4e24","reference":true,"from_sync":false,"pages":[{"_id":"58b72787d92e682300b2c05b","api":{"params":[],"url":"","method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"auth":"required"},"link_external":false,"parentDoc":null,"sync_unique":"","type":"basic","slug":"deal","title":"Deals","hidden":false,"link_url":"","isReference":true,"order":0,"category":"58b5ee57e31a610f003a59b5","createdAt":"2017-03-01T19:56:55.213Z","isBodyEmpty":false,"children":[{"_id":"5f337727c2f652003c8b3dd9","api":{"method":"post","url":"/deals","auth":"required","examples":{"codes":[{"code":"{\n \"deal\": {\n \"contact\": \"51\",\n \"account\": \"45\",\n \"description\": \"This deal is an important deal\",\n \"currency\": \"usd\",\n \"group\": \"1\",\n \"owner\": \"1\",\n \"percent\": null,\n \"stage\": \"1\",\n \"status\": 0,\n \"title\": \"AC Deal\",\n \"value\": 45600,\n \"fields\": [\n {\n \"customFieldId\": 1,\n \"fieldValue\": \"First field value\"\n },\n {\n \"customFieldId\": 2,\n \"fieldValue\": \"2008-01-20\"\n },\n {\n \"customFieldId\": 3,\n \"fieldValue\": 5500,\n \"fieldCurrency\": \"EUR\"\n }\n ]\n }\n}\n","language":"json","name":"POST /deals (Example REQUEST)"}]},"params":[{"name":"deal.title","type":"string","enumValues":"","default":"","desc":"Deal's title.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"deal.description","type":"string","enumValues":"","default":"","desc":"Deal's description","required":false,"in":"body","ref":"","_id":"5ba324146048990003fb6ef9"},{"name":"deal.account","type":"string","enumValues":"","default":"","desc":"Deal’s account id. Required if `deal.contact` is not provided.","required":true,"in":"body","ref":"","_id":"5df273ec8999a50060ac4db6"},{"name":"deal.contact","type":"string","enumValues":"","default":"","desc":"Deal's primary contact's id. Required if `deal.account` is not provided.","required":true,"in":"body","ref":"","_id":"58b60392cc6a600f0005134b"},{"name":"deal.value","type":"int","enumValues":"","default":"","desc":"Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b3"},{"name":"deal.currency","type":"string","enumValues":"","default":"","desc":"Deal's currency in 3-digit ISO format, lowercased.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936ba"},{"name":"deal.group","type":"string","enumValues":"","default":"","desc":"Deal's pipeline id. Required if `deal.stage` is not provided. If `deal.group` is not provided, the stage's pipeline will be assigned to the deal automatically.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b9"},{"name":"deal.stage","type":"string","enumValues":"","default":"","desc":"Deal's stage id. Required if `deal.group` is not provided. If `deal.stage` is not provided, the deal will be assigned with the first stage in the pipeline provided in `deal.group`.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b6"},{"name":"deal.owner","type":"string","enumValues":"","default":"","desc":"Deal's owner id. Required if pipeline's auto-assign option is disabled.","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b8"},{"name":"deal.percent","type":"int","enumValues":"","default":"","desc":"Deal's percentage.","required":false,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b7"},{"name":"deal.status","type":"int","enumValues":"","default":"0","desc":"Deal's status. See [available values](ref:deal).","required":false,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b5"},{"name":"deal.fields","type":"array_object","enumValues":"","default":"","desc":"Deal's custom field values `{customFieldId: string, fieldValue: string, fieldCurrency?:string}[]`","required":false,"in":"body","ref":"CustomFieldData","_id":"5f3379dcddd1fa023219bac8"}],"results":{"codes":[{"code":"{\n \"contacts\": [\n {\n \"adate\": \"2017-02-06 15:50:11\",\n \"bounced_date\": \"0000-00-00\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"cdate\": \"2017-02-03T11:26:41-06:00\",\n \"deleted\": \"0\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"email\": \"johndoe@example.com\",\n \"email_domain\": \"\",\n \"email_local\": \"\",\n \"firstName\": \"\",\n \"gravatar\": \"1\",\n \"hash\": \"e1705a92f24edf5313ed21df44d6ff5f\",\n \"id\": \"51\",\n \"ip\": \"0\",\n \"lastName\": \"\",\n \"links\": {\n \"bounceLogs\": \"/api/3/contacts/51/bounceLogs\",\n \"contactAutomations\": \"/api/3/contacts/51/contactAutomations\",\n \"contactData\": \"/api/3/contacts/51/contactData\",\n \"contactDeals\": \"/api/3/contacts/51/contactDeals\",\n \"contactGoals\": \"/api/3/contacts/51/contactGoals\",\n \"contactLists\": \"/api/3/contacts/51/contactLists\",\n \"contactLogs\": \"/api/3/contacts/51/contactLogs\",\n \"contactTags\": \"/api/3/contacts/51/contactTags\",\n \"deals\": \"/api/3/contacts/51/deals\",\n \"fieldValues\": \"/api/3/contacts/51/fieldValues\",\n \"geoIps\": \"/api/3/contacts/51/geoIps\",\n \"notes\": \"/api/3/contacts/51/notes\",\n \"organization\": \"/api/3/contacts/51/organization\",\n \"plusAppend\": \"/api/3/contacts/51/plusAppend\",\n \"scoreValues\": \"/api/3/contacts/51/scoreValues\",\n \"trackingLogs\": \"/api/3/contacts/51/trackingLogs\"\n },\n \"organization\": null,\n \"orgid\": \"0\",\n \"phone\": \"\",\n \"rating_tstamp\": \"0000-00-00\",\n \"segmentio_id\": \"\",\n \"sentcnt\": \"0\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"ua\": \"\",\n \"udate\": \"2017-02-03T11:26:41-06:00\"\n }\n ],\n \"deal\": {\n \"description\": \"This deal is an important deal\",\n \"currency\": \"usd\",\n \"percent\": null,\n \"status\": 0,\n \"title\": \"AC Deal\",\n \"value\": 45600,\n \"organization\": 45,\n \"contact\": 1,\n \"group\": \"1\",\n \"owner\": \"1\",\n \"stage\": \"1\",\n \"cdate\": \"2019-12-09T12:29:33-06:00\",\n \"mdate\": \"2019-12-09T12:29:33-06:00\",\n \"nextdate\": null,\n \"hash\": \"c3a5497c\",\n \"winProbability\": null,\n \"winProbabilityMdate\": null,\n \"links\": {\n \"dealActivities\": \"/api/3/deals/51/dealActivities\",\n \"contact\": \"/api/3/deals/51/contact\",\n \"contactDeals\": \"/api/3/deals/51/contactDeals\",\n \"group\": \"/api/3/deals/51/group\",\n \"nextTask\": \"/api/3/deals/51/nextTask\",\n \"notes\": \"/api/3/deals/51/notes\",\n \"account\": \"/api/3/deals/51/account\",\n \"customerAccount\": \"/api/3/deals/51/customerAccount\",\n \"organization\": \"/api/3/deals/51/organization\",\n \"owner\": \"/api/3/deals/51/owner\",\n \"scoreValues\": \"/api/3/deals/51/scoreValues\",\n \"stage\": \"/api/3/deals/51/stage\",\n \"tasks\": \"/api/3/deals/51/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/51/dealCustomFieldData\"\n },\n \"fields\": [\n {\n \"customFieldId\": 1,\n \"fieldValue\": \"First field value\",\n \"dealId\": \"51\"\n },\n {\n \"customFieldId\": 2,\n \"fieldValue\": \"2008-01-20\",\n \"dealId\": \"51\"\n },\n {\n \"customFieldId\": 3,\n \"fieldValue\": 5500,\n \"fieldCurrency\": \"EUR\",\n \t\"dealId\": \"51\"\n }\n ],\n \"id\": \"51\",\n \"isDisabled\": false,\n \"account\": 45,\n \"customerAccount\": 45\n }\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": \"2017-01-20T09:27:32-06:00\",\n \"width\": \"280\"\n }\n ]\n}\n","name":"","status":201,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a deal","type":"endpoint","slug":"create-a-deal-new","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58b72787d92e682300b2c05b","createdAt":"2020-08-12T04:59:19.189Z","category":"58b5ee57e31a610f003a59b5","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"58b5ee7ce31a610f003a59bc","title":"Retrieve a deal","link_external":false,"parentDoc":"58b72787d92e682300b2c05b","sync_unique":"","category":"58b5ee57e31a610f003a59b5","createdAt":"2017-02-28T21:41:16.637Z","link_url":"","type":"endpoint","api":{"results":{"codes":[{"language":"json","code":"{\n \"deal\": {\n \"owner\": \"1\",\n \"contact\": \"39\",\n \"organization\": \"20\",\n \"group\": \"1\",\n \"stage\": \"2\",\n \"title\": \"Able Hyena\",\n \"description\": \"Article do skill hope.\",\n \"percent\": \"0\",\n \"cdate\": \"2019-09-06T11:29:48-05:00\",\n \"mdate\": \"2019-09-06T11:29:48-05:00\",\n \"nextdate\": null,\n \"nexttaskid\": null,\n \"value\": \"1872151\",\n \"currency\": \"usd\",\n \"winProbability\": 44,\n \"winProbabilityMdate\": \"2019-10-05T12:27:22-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"46\",\n \"edate\": \"2019-11-22 14:15:37\",\n \"links\": {\n \t\"dealActivities\": \"/api/3/deals/46/dealActivities\",\n \t\"contact\":/api/3/deals/46/contact\",\n \t\"contactDeals\": \"/api/3/deals/46/contactDeals\",\n \t\"group\": \"/api/3/deals/46/group\",\n \t\"nextTask\": \"/api/3/deals/46/nextTask\",\n \t\"notes\": \"/api/3/deals/46/notes\",\n \t\"account\": \"/api/3/deals/46/account\",\n \t\"customerAccount\": \"/api/3/deals/46/customerAccount\",\n \t\"organization\": \"/api/3/deals/46/organization\",\n \t\"owner\": \"/api/3/deals/46/owner\",\n \t\"scoreValues\": \"/api/3/deals/46/scoreValues\",\n \t\"stage\": \"/api/3/deals/46/stage\",\n \t\"tasks\": \"api/3/deals/46/tasks\",\n \t\"dealCustomFieldData\": \"/api/3/deals/46/dealCustomFieldData\"\n },\n \"id\": \"46\",\n \"isDisabled\": false,\n \"account\": \"20\",\n \"customerAccount\": \"20\"\n }\n}","name":"with pipeline permission","status":200},{"name":"without pipeline permission","status":200,"language":"json","code":"{\n \"deal\": {\n \"id\": \"2\",\n \"isDisabled\": true,\n \"title\": \"Demo Requested\"\n }\n}"}]},"url":"/deals/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The Deal's id","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"isReference":true,"order":1,"slug":"retrieve-a-deal","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5f3c952a7a0ed0005d1437eb","api":{"method":"put","url":"/deals/:id","auth":"required","examples":{"codes":[{"code":"{\n \"deal\": {\n \"contact\": \"51\",\n \"account\": \"45\",\n \"description\": \"This deal is an important deal\",\n \"currency\": \"usd\",\n \"group\": \"1\",\n \"owner\": \"1\",\n \"percent\": null,\n \"stage\": \"1\",\n \"status\": 0,\n \"title\": \"AC Deal\",\n \"value\": 45600,\n \"fields\": [\n {\n \"customFieldId\": 1,\n \"fieldValue\": \"First field value\"\n },\n {\n \"customFieldId\": 2,\n \"fieldValue\": \"2008-01-20\"\n },\n {\n \"customFieldId\": 3,\n \"fieldValue\": 8800,\n \"fieldCurrency\": \"USD\"\n }\n ]\n }\n}\n\n","language":"json"}]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The Deal's id","required":false,"in":"path","ref":"","_id":"58b603b300eb000f000cad7f"},{"name":"deal.title","type":"string","enumValues":"","default":"","desc":"Deal's title.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9d"},{"name":"deal.description","type":"string","enumValues":"","default":"","desc":"Deal's description","required":false,"in":"body","ref":"","_id":"5ba323b56048990003fb6ef7"},{"name":"deal.account","type":"string","enumValues":"","default":"","desc":"Deal's account id","required":false,"in":"body","ref":"","_id":"5df27496292f910038ea2d7b"},{"name":"deal.contact","type":"string","enumValues":"","default":"","desc":"Deal's primary contact id.","required":false,"in":"body","ref":"","_id":"58b6e6fcb72a430f007f9ecd"},{"name":"deal.value","type":"int","enumValues":"","default":"","desc":"Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9c"},{"name":"deal.currency","type":"string","enumValues":"","default":"","desc":"Deal's currency in 3-digit ISO format, lowercased.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8baa3"},{"name":"deal.group","type":"string","enumValues":"","default":"","desc":"Deal's pipeline id. Deal's stage or `deal.stage` should belong to `deal.group`.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8baa2"},{"name":"deal.stage","type":"string","enumValues":"","default":"0","desc":"Deal's stage id. `deal.stage` should belong to Deal's pipeline or `deal.group`.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9f"},{"name":"deal.owner","type":"string","enumValues":"","default":"","desc":"Deal's owner id.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8baa1"},{"name":"deal.percent","type":"int","enumValues":"","default":"","desc":"Deal's percentage.","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8baa0"},{"name":"deal.status","type":"int","enumValues":"","default":"0","desc":"Deal's status (0=\"open\", 1=\"won\", or 2=\"lost\")","required":false,"in":"body","ref":"","_id":"58b6e7f8253bae2d00c8ba9e"},{"name":"deal.fields","type":"array_object","enumValues":"","default":"","desc":"Deal's custom field values `{customFieldId: string, fieldValue: string, fieldCurrency?:string}[]`","required":false,"in":"body","ref":"CustomFieldData","_id":"5f3c958078dc6401386f8ee1"}],"results":{"codes":[{"name":"","code":"{\n \"contacts\": [\n {\n \"adate\": \"2017-02-06 15:50:11\",\n \"bounced_date\": \"0000-00-00\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"cdate\": \"2017-02-03T11:26:41-06:00\",\n \"deleted\": \"0\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"email\": \"johndoe@example.com\",\n \"email_domain\": \"\",\n \"email_local\": \"\",\n \"firstName\": \"\",\n \"gravatar\": \"1\",\n \"hash\": \"e1705a92f24edf5313ed21df44d6ff5f\",\n \"id\": \"51\",\n \"ip\": \"0\",\n \"lastName\": \"\",\n \"links\": {\n \"bounceLogs\": \"/api/3/contacts/51/bounceLogs\",\n \"contactAutomations\": \"/api/3/contacts/51/contactAutomations\",\n \"contactData\": \"/api/3/contacts/51/contactData\",\n \"contactDeals\": \"/api/3/contacts/51/contactDeals\",\n \"contactGoals\": \"/api/3/contacts/51/contactGoals\",\n \"contactLists\": \"/api/3/contacts/51/contactLists\",\n \"contactLogs\": \"/api/3/contacts/51/contactLogs\",\n \"contactTags\": \"/api/3/contacts/51/contactTags\",\n \"deals\": \"/api/3/contacts/51/deals\",\n \"fieldValues\": \"/api/3/contacts/51/fieldValues\",\n \"geoIps\": \"/api/3/contacts/51/geoIps\",\n \"notes\": \"/api/3/contacts/51/notes\",\n \"organization\": \"/api/3/contacts/51/organization\",\n \"plusAppend\": \"/api/3/contacts/51/plusAppend\",\n \"scoreValues\": \"/api/3/contacts/51/scoreValues\",\n \"trackingLogs\": \"/api/3/contacts/51/trackingLogs\"\n },\n \"organization\": null,\n \"orgid\": \"0\",\n \"phone\": \"\",\n \"rating_tstamp\": \"0000-00-00\",\n \"segmentio_id\": \"\",\n \"sentcnt\": \"0\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"ua\": \"\",\n \"udate\": \"2017-02-03T11:26:41-06:00\"\n }\n ],\n \"deal\": {\n \"description\": \"This deal is an important deal\",\n \"currency\": \"usd\",\n \"percent\": null,\n \"status\": 0,\n \"title\": \"AC Deal\",\n \"value\": 45600,\n \"organization\": 45,\n \"contact\": 1,\n \"group\": \"1\",\n \"owner\": \"1\",\n \"stage\": \"1\",\n \"cdate\": \"2019-12-09T12:29:33-06:00\",\n \"mdate\": \"2019-12-09T12:29:33-06:00\",\n \"nextdate\": null,\n \"hash\": \"c3a5497c\",\n \"winProbability\": null,\n \"winProbabilityMdate\": null,\n \"links\": {\n \"dealActivities\": \"/api/3/deals/51/dealActivities\",\n \"contact\": \"/api/3/deals/51/contact\",\n \"contactDeals\": \"/api/3/deals/51/contactDeals\",\n \"group\": \"/api/3/deals/51/group\",\n \"nextTask\": \"/api/3/deals/51/nextTask\",\n \"notes\": \"/api/3/deals/51/notes\",\n \"account\": \"/api/3/deals/51/account\",\n \"customerAccount\": \"/api/3/deals/51/customerAccount\",\n \"organization\": \"/api/3/deals/51/organization\",\n \"owner\": \"/api/3/deals/51/owner\",\n \"scoreValues\": \"/api/3/deals/51/scoreValues\",\n \"stage\": \"/api/3/deals/51/stage\",\n \"tasks\": \"/api/3/deals/51/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/51/dealCustomFieldData\"\n },\n \"fields\": [\n {\n \"customFieldId\": 1,\n \"fieldValue\": \"First field value\",\n \"dealId\": \"51\"\n },\n {\n \"customFieldId\": 2,\n \"fieldValue\": \"2008-01-20\",\n \"dealId\": \"51\"\n },\n {\n \"customFieldId\": 3,\n \"fieldValue\": 8800,\n \"fieldCurrency\": \"USD\",\n \t\"dealId\": \"51\"\n }\n ],\n \"id\": \"51\",\n \"isDisabled\": false,\n \"account\": 45,\n \"customerAccount\": 45\n }\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": \"2017-01-20T09:27:32-06:00\",\n \"width\": \"280\"\n }\n ]\n}\n","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Update a deal","type":"endpoint","slug":"update-a-deal-new","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58b72787d92e682300b2c05b","createdAt":"2020-08-19T02:57:46.469Z","category":"58b5ee57e31a610f003a59b5","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"58b603ca3c785d0f00b74ec2","parentDoc":"58b72787d92e682300b2c05b","title":"Delete a deal","type":"endpoint","createdAt":"2017-02-28T23:12:10.844Z","link_url":"","order":3,"slug":"delete-a-deal","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The Deal's id","required":false,"in":"path","ref":"","_id":"58b603ca3c785d0f00b74ec3"}],"results":{"codes":[{"code":"","language":"json","status":200,"name":""},{"language":"json","status":400,"name":"","code":"{}"}]},"url":"/deals/:id","apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"isReference":true,"link_external":false,"category":"58b5ee57e31a610f003a59b5","sync_unique":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b6040c3c785d0f00b74ec4","category":"58b5ee57e31a610f003a59b5","hidden":false,"link_external":false,"parentDoc":"58b72787d92e682300b2c05b","api":{"results":{"codes":[{"name":"","code":"{\n \"deals\": [\n {\n \"owner\": \"1\",\n \"contact\": \"39\",\n \"organization\": \"20\",\n \"group\": \"1\",\n \"stage\": \"2\",\n \"title\": \"Able Hyena\",\n \"description\": \"Article do skill hope.\",\n \"percent\": \"0\",\n \"cdate\": \"2019-09-06T11:29:48-05:00\",\n \"mdate\": \"2019-09-06T11:29:48-05:00\",\n \"nextdate\": null,\n \"nexttaskid\": null,\n \"value\": \"1872151\",\n \"currency\": \"usd\",\n \"winProbability\": 44,\n \"winProbabilityMdate\": \"2019-10-05T12:27:22-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"46\",\n \"edate\": \"2019-11-22 14:15:37\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/46/dealActivities\",\n \"contact\":\"/api/3/deals/46/contact\",\n \"contactDeals\": \"/api/3/deals/46/contactDeals\",\n \"group\": \"/api/3/deals/46/group\",\n \"nextTask\": \"/api/3/deals/46/nextTask\",\n \"notes\": \"/api/3/deals/46/notes\",\n \"account\": \"/api/3/deals/46/account\",\n \"customerAccount\": \"/api/3/deals/46/customerAccount\",\n \"organization\": \"/api/3/deals/46/organization\",\n \"owner\": \"/api/3/deals/46/owner\",\n \"scoreValues\": \"/api/3/deals/46/scoreValues\",\n \"stage\": \"/api/3/deals/46/stage\",\n \"tasks\": \"api/3/deals/46/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/46/dealCustomFieldData\"\n\t\t},\n \"id\": \"46\",\n \"isDisabled\": false,\n \"account\": \"20\",\n \"customerAccount\": \"20\"\n\t\t},\n {\n \"activitycount\": \"62\",\n \"cdate\": \"2017-01-20T09:28:02-06:00\",\n \"contact\": \"44\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"2\",\n \"hash\": \"d6ca7d0b\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-02-06T12:21:12-06:00\",\n \"nextTask\": \"2\",\n \"nextdate\": \"2017-02-06T12:00:00-06:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"2\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"1\",\n \"title\": \"Test Deal\",\n \"description\": \"A deal that will make a big difference\",\n \"value\": \"10000\"\n },\n {\n \"id\": \"2\",\n \"isDisabled\": 1,\n \"title\": \"Demo Requested\"\n }\n ],\n \"meta\": {\n \"currencies\": {\n \"USD\": {\n \"currency\": \"USD\",\n \"total\": \"3\",\n \"value\": \"30000\"\n }\n },\n \"total\": 3\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"url":"/deals","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"filters[search]","type":"string","enumValues":"","default":"","desc":"Search text to use with `search_field` parameter.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f60"},{"name":"filters[search_field]","type":"string","enumValues":"","default":"","desc":"Field to search for. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values).","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5f"},{"name":"filters[title]","type":"string","enumValues":"","default":"","desc":"Filter by deal's title","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f69"},{"name":"filters[stage]","type":"int","enumValues":"","default":"","desc":"Filter by deal's stage","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f67"},{"name":"filters[group]","type":"int","enumValues":"","default":"","desc":"Filter by deal's pipeline","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f63"},{"name":"filters[status]","type":"int","enumValues":"","default":"","desc":"Filter by deal's status. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values)","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f62"},{"name":"filters[owner]","type":"int","enumValues":"","default":"","desc":"Filter by deal's owner","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f61"},{"name":"filters[nextdate_range]","type":"string","enumValues":"","default":"","desc":"Filter by deal's tasks due dates. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values)","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5a"},{"name":"filters[tag]","type":"string","enumValues":"","default":"","desc":"Filter by tag names associated with deal's primary contact. See [available values](https://developers.activecampaign.com/reference/deal#deals-parameters-available-values).","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f58"},{"name":"filters[tasktype]","type":"string","enumValues":"","default":"","desc":"Filter by deals that have tasks with given type","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5b"},{"name":"filters[created_before]","type":"datetime","enumValues":"","default":"","desc":"Returns deals that are created less than given date","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f54"},{"name":"filters[created_after]","type":"datetime","enumValues":"","default":"","desc":"Returns deals that are created greater than or equal to given date","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f57"},{"name":"filters[updated_before]","type":"datetime","enumValues":"","default":"","desc":"Returns deals that are updated less than given date","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f55"},{"name":"filters[updated_after]","type":"datetime","enumValues":"","default":"","desc":"Returns deals that are updated greater than or equal to given date","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f56"},{"name":"filters[organization]","type":"int","enumValues":"","default":"","desc":"Filter by deal's primary contact's organization's id","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5e"},{"name":"filters[minimum_value]","type":"int","enumValues":"","default":"","desc":"In USD with dollar portion. Returns deals whose values are greater than or equal to given value","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f53"},{"name":"filters[maximum_value]","type":"int","enumValues":"","default":"","desc":"In USD with dollar portion. Returns deals whose values are less than or equal to given value","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f52"},{"name":"filters[score_greater_than]","type":"string","enumValues":"","default":"","desc":"In a format of `<score_id>:<score_value>`. Returns deals whose score value is greater than given value","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f51"},{"name":"filters[score_less_than]","type":"string","enumValues":"","default":"","desc":"In a format of `<score_id>:<score_value>`. Returns deals whose score value is less than given value","required":false,"in":"query","ref":"","_id":"58b6fc7aeeacc63b004936a5"},{"name":"filters[score]","type":"string","enumValues":"","default":"","desc":"In a format of `<score_id>:<score_value>`. Returns deals whose score value is equal to given value","required":false,"in":"query","ref":"","_id":"58b6fc7aeeacc63b004936a4"},{"name":"orders[title]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's title.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f66"},{"name":"orders[value]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's value.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f65"},{"name":"orders[cdate]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's created date.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f64"},{"name":"orders[contact_name]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's primary contact's first name.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5d"},{"name":"orders[contact_orgname]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's primary contact's organization name.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f5c"},{"name":"orders[next-action]","type":"string","enumValues":"","default":"ASC","desc":"Order by deal's next task's due date first. Then append deals with no next task. Lastly append deals with overdue tasks. If dates are the same, order by deal's id.","required":false,"in":"query","ref":"","_id":"58b6fafcb72a430f007f9f59"}],"apiSetting":"58b53c301065f9c438aa1f77"},"slug":"list-all-deals","isReference":true,"link_url":"","sync_unique":"","title":"List all deals","createdAt":"2017-02-28T23:13:16.892Z","order":4,"type":"endpoint","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"592ed75532d401000ff2c42a","category":"58b5ee57e31a610f003a59b5","parentDoc":"58b72787d92e682300b2c05b","createdAt":"2017-05-31T14:46:45.240Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"language":"json","status":201,"name":"","code":"{\n \"deals\": [\n {\n \"activitycount\": \"2\",\n \"cdate\": \"2017-05-25T12:01:01-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": null,\n \"group\": \"1\",\n \"hash\": \"e42436fc\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-05-25T12:17:23-05:00\",\n \"nextdate\": null,\n \"nextdealid\": \"1\",\n \"nexttaskid\": null,\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New Deal\",\n \"value\": \"10000\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-05-31T09:54:30-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-05-31T09:54:30-05:00\",\n \"note\": \"Note for the deal\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}"}]},"examples":{"codes":[{"language":"json","code":"{\n \"note\": {\n \"note\": \"Note for the deal\"\n }\n}"}]},"auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"The Deal note's content","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"id","type":"string","enumValues":"","default":"","desc":"The Deal's id to assign new note to","required":false,"in":"path","ref":"","_id":"592ed91e05a05e0027ce9645"}],"url":"/deals/:id/notes","method":"post","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":5,"slug":"create-a-deal-note","type":"endpoint","title":"Create a deal note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"592eda49a5cc09002fb60af1","category":"58b5ee57e31a610f003a59b5","parentDoc":"58b72787d92e682300b2c05b","createdAt":"2017-05-31T14:59:21.902Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"language":"json","code":"{\n \"note\": {\n \"note\": \"Update with more info\"\n }\n}"}]},"results":{"codes":[{"code":"{\n \"deals\": [\n {\n \"activitycount\": \"3\",\n \"cdate\": \"2017-06-01T13:40:04-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"5604d5b5\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-06-01T13:41:57-05:00\",\n \"nextTask\": \"1\",\n \"nextdate\": \"2017-06-02T12:00:00-05:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"1\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New deal\",\n \"value\": \"10000\"\n }\n ],\n \"note\": {\n \"cdate\": \"2017-06-01T13:42:13-05:00\",\n \"id\": \"2\",\n \"links\": {\n \"activities\": \"/api/3/notes/2/activities\",\n \"mentions\": \"/api/3/notes/2/mentions\",\n \"notes\": \"/api/3/notes/2/notes\",\n \"owner\": \"/api/3/notes/2/owner\",\n \"user\": \"/api/3/notes/2/user\"\n },\n \"mdate\": \"2017-06-01T13:42:13-05:00\",\n \"note\": \"Update with more info\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"user\": \"1\",\n \"userid\": \"1\"\n }\n}\n","name":"","status":200,"language":"json"}]},"auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"Deal note's content","required":true,"in":"body","ref":"","_id":"58b6fed4eeacc63b004936b4"},{"name":"id","type":"string","enumValues":"","default":"","desc":"Deal's id to assign new note to","required":false,"in":"path","ref":"","_id":"592ed91e05a05e0027ce9645"},{"name":"noteId","type":"string","enumValues":"","default":"","desc":"Deal note's id to update","required":false,"in":"path","ref":"","_id":"592eda8c1cd2c400257eeddd"}],"url":"/deals/:id/notes/:noteId","method":"put","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":6,"slug":"update-a-deal-note","type":"endpoint","title":"Update a deal note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"6182f020fdc216005e901b69","api":{"method":"patch","url":"/deals/bulkUpdate","auth":"required","examples":{"codes":[{"code":"{\n \"deals\": [\n {\n \"id\": 1,\n \"ownerId\": 1\n },\n {\n \"id\": 2,\n \"ownerId\": 1\n },\n {\n \"id\": 3,\n \"ownerId\": 1\n }\n ]\n}","language":"json","name":"Correct request"},{"code":"{\n \"deals\": [\n {\n \"id\": 1\n },\n {\n \"id\": 2,\n \"ownerId\": 2\n }\n ]\n}","language":"json","name":"Missing ownerId"},{"code":"{\n \"deals\": [\n {\n \"id\": 99999999,\n \"ownerId\": 2\n }\n ]\n}","language":"json","name":"Non-existing deal id"},{"code":"{\n \"deals\": [\n {\n \"id\": 1,\n \"ownerId\": 999999\n }\n ]\n}","language":"text","name":"Non-existing ownerId"}]},"params":[{"name":"deals","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"deal-owners","_id":"6243745d15d9160054954f9a"}],"results":{"codes":[{"name":"","code":"{\n \"success\": [\n \"1\",\n \"2\"\n ],\n \"nochange\": [\n \"3\"\n ],\n \"failed\": []\n}","language":"json","status":200},{"name":"Mandatory ownerId","code":"{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"ownerId is required for a deal '1'.\"\n }\n ]\n}","language":"json","status":422},{"code":"{\n \"errors\": [\n {\n \"status\": 422,\n \"title\": \"Owner(user) with id '999999' was not found for a deal '1'.\"\n }\n ]\n}","language":"text","status":422,"name":"Non-existing ownerId"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Bulk Update Deal Owners","type":"endpoint","slug":"bulk-update-deal-owners","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"update-a-deal","parentDoc":"58b72787d92e682300b2c05b","createdAt":"2021-11-03T20:25:04.631Z","category":"58b5ee57e31a610f003a59b5","isBodyEmpty":false,"children":[]},{"_id":"65174982fc55e4001e5323c3","api":{"method":"get","url":"/dealActivities","auth":"required","results":{"codes":[{"name":"","code":"\"dealActivities\": [\n\t{\n \"d_id\": \"1361\",\n \"d_stageid\": \"0\",\n \"userid\": \"1\",\n \"dataId\": \"0\",\n \"dataType\": \"\",\n \"dataAction\": \"add\",\n \"dataOldval\": \"\",\n \"cdate\": \"2023-03-29T10:22:03-05:00\",\n \"sortdate\": \"2023-03-29T10:22:03-05:00\",\n \"isAddtask\": \"0\",\n \"deleted\": \"0\",\n \"seriesid\": \"0\",\n \"links\": {\n \"deal\": \"https://account.activehosted.com/api/3/dealActivities/15110/deal\",\n \"stage\": \"https://account.activehosted.com/api/3/dealActivities/15110/stage\",\n \"user\": \"https://account.activehosted.com/api/3/dealActivities/15110/user\",\n \"automation\": \"https://account.activehosted.com/api/3/dealActivities/15110/automation\",\n \"activity\": \"https://account.activehosted.com/api/3/dealActivities/15110/activity\"\n },\n \"id\": \"15110\",\n \"deal\": \"1361\",\n \"stage\": null,\n \"user\": \"1\",\n \"automation\": null\n },\n {\n \"d_id\": \"1361\",\n \"d_stageid\": \"0\",\n \"userid\": \"1\",\n \"dataId\": \"1512\",\n \"dataType\": \"contact\",\n \"dataAction\": \"add\",\n \"dataOldval\": \"\",\n \"cdate\": \"2023-03-29T10:22:04-05:00\",\n \"sortdate\": \"2023-03-29T10:22:04-05:00\",\n \"isAddtask\": \"0\",\n \"deleted\": \"0\",\n \"seriesid\": \"0\",\n \"links\": {\n \"deal\": \"https://account.activehosted.com/api/3/dealActivities/15111/deal\",\n \"stage\": \"https://account.activehosted.com/api/3/dealActivities/15111/stage\",\n \"user\": \"https://account.activehosted.com/api/3/dealActivities/15111/user\",\n \"automation\": \"https://account.activehosted.com/api/3/dealActivities/15111/automation\",\n \"activity\": \"https://account.activehosted.com/api/3/dealActivities/15111/activity\"\n },\n \"id\": \"15111\",\n \"deal\": \"1361\",\n \"stage\": null,\n \"user\": \"1\",\n \"automation\": null\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"exclude=email","type":"string","enumValues":"","default":"","desc":"Include this param to exclude \"email\", \"connection_email\", and \"LinkData\" activity types","required":false,"in":"query","ref":"","_id":"65174982fc55e4001e5323c6"},{"name":"deal","type":"string","enumValues":"","default":"","desc":"Filter by deal ID","required":false,"in":"query","ref":"","_id":"65174982fc55e4001e5323c5"},{"name":"filters[data_type]","type":"string","enumValues":"","default":"","desc":"Enter any dataType (see Response Details) to filter by that type. Examples: \"userid\" or task\" or \"note\"","required":false,"in":"query","ref":"","_id":"653195cc3446120049637f90"},{"name":"filters[data_id]","type":"string","enumValues":"","default":"","desc":"Enter any dataId (see Response details) to filter by related object. Example \"291\" for a note with ID 291","required":false,"in":"query","ref":"","_id":"653195cc3446120049637f8f"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List all deal activities","icon":"","type":"endpoint","slug":"list-all-deal-activities","order":8,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58b72787d92e682300b2c05b","category":"58b5ee57e31a610f003a59b5","createdAt":"2023-09-29T22:02:42.848Z","isBodyEmpty":false,"children":[]}]},{"_id":"58b72a2df22b830f009a0bee","category":"58b5ee57e31a610f003a59b5","createdAt":"2017-03-01T20:08:13.290Z","link_url":"","order":1,"type":"basic","isReference":true,"parentDoc":null,"slug":"pipelines","api":{"params":[],"url":"","method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required"},"hidden":false,"link_external":false,"sync_unique":"","title":"Pipelines","isBodyEmpty":false,"children":[{"_id":"58b72f5ceeacc63b00493808","createdAt":"2017-03-01T20:30:20.281Z","hidden":false,"isReference":true,"link_url":"","order":0,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"cdate\": \"2017-03-30T12:12:41-05:00\",\n \"currency\": \"eur\",\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n \"6\",\n \"7\"\n ],\n \"id\": \"5\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/5/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/5/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/5/stages\"\n },\n \"stages\": [\n \"12\",\n \"13\",\n \"14\"\n ],\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T12:12:41-05:00\"\n },\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n {\n \"cdate\": null,\n \"dealGroup\": \"5\",\n \"id\": \"6\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/6/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/6/user\"\n },\n \"user\": \"3\"\n },\n {\n \"cdate\": null,\n \"dealGroup\": \"5\",\n \"id\": \"7\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/7/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/7/user\"\n },\n \"user\": \"4\"\n }\n ],\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"12\",\n \"links\": {\n \"group\": \"/api/3/dealStages/12/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"13\",\n \"links\": {\n \"group\": \"/api/3/dealStages/13/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"14\",\n \"links\": {\n \"group\": \"/api/3/dealStages/14/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ]\n}\n","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/dealGroups","auth":"required","examples":{"codes":[{"code":"{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"currency\": \"eur\",\n \"title\": \"Qualifications\",\n \"users\": [\"3\", \"4\"]\n }\n}","language":"json"}]},"method":"post","params":[{"name":"dealGroup.title","type":"string","enumValues":"","default":"","desc":"Pipeline's title.","required":true,"in":"body","ref":"","_id":"58b737e2b72a430f007fa096"},{"name":"dealGroup.currency","type":"string","enumValues":"","default":"","desc":"Default currency to assign to new deals that belong to this deal group.","required":true,"in":"body","ref":"","_id":"58b737e2b72a430f007fa097"},{"name":"dealGroup.allgroups","type":"int","enumValues":"","default":"1","desc":"Whether all user groups have permission to manage this pipeline. Can be either `1` or `0`. If `1`, all user groups can manage this pipeline. If `0`, only user groups in `dealGroup.groups` parameter can manage this pipeline.","required":false,"in":"body","ref":"","_id":"58b7372df22b830f009a0c23"},{"name":"dealGroup.allusers","type":"int","enumValues":"","default":"0","desc":"Whether new deals get auto-assigned to all users. Can be either `1` or `0`. If `1`, new deals are auto-assigned to all users unless auto-assign is disabled. If `0`, new deals are auto-assigned to only the users in `dealGroup.users` parameter.","required":false,"in":"body","ref":"","_id":"58b7372df22b830f009a0c22"},{"name":"dealGroup.autoassign","type":"int","enumValues":"","default":"1","desc":"Deal auto-assign option. Can be one of `0`, `1`, and `2`. If `0`, auto-assign is disabled. If `1`, Round Robin method is used to auto-assign new deals. If `2`, deals are distributed based on deal values.","required":false,"in":"body","ref":"","_id":"58b737e2b72a430f007fa098"},{"name":"dealGroup.users","type":"array_string","enumValues":"","default":"","desc":"List of user ids to auto-assign new deals to unless auto-assign option is disabled.","required":false,"in":"body","ref":"","_id":"58c083b4ed548f0f00406525"},{"name":"dealGroup.groups","type":"array_string","enumValues":"","default":"","desc":"List of user group ids to allow managing this pipeline.","required":false,"in":"body","ref":"","_id":"58c083b4ed548f0f00406524"}],"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a pipeline","sync_unique":"","category":"58b5ee57e31a610f003a59b5","link_external":false,"parentDoc":"58b72a2df22b830f009a0bee","slug":"create-a-pipeline","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b72f80f22b830f009a0c06","order":1,"type":"endpoint","hidden":false,"isReference":true,"link_url":"","slug":"retrieve-a-pipeline","sync_unique":"","title":"Retrieve a pipeline","api":{"auth":"required","examples":{"codes":[{"language":"json","code":""}]},"method":"get","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Pipeline's id","required":false,"in":"path","ref":"","_id":"58c076d8edbb130f00a58ed8"}],"results":{"codes":[{"name":"","code":"{\n \"dealGroup\": {\n \"allgroups\": \"1\",\n \"allusers\": \"0\",\n \"autoassign\": \"1\",\n \"cdate\": \"2017-03-30T12:11:30-05:00\",\n \"currency\": \"eur\",\n \"id\": \"4\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/4/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/4/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/4/stages\"\n },\n \"stages\": [\n \"9\",\n \"10\",\n \"11\"\n ],\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T13:44:32-05:00\"\n },\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"9\",\n \"links\": {\n \"group\": \"/api/3/dealStages/9/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"10\",\n \"links\": {\n \"group\": \"/api/3/dealStages/10/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"11\",\n \"links\": {\n \"group\": \"/api/3/dealStages/11/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ]\n}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"url":"/dealGroups/:id","apiSetting":"58b53c301065f9c438aa1f77"},"link_external":false,"parentDoc":"58b72a2df22b830f009a0bee","category":"58b5ee57e31a610f003a59b5","createdAt":"2017-03-01T20:30:56.079Z","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58c196026d8f471b00609833","hidden":false,"category":"58b5ee57e31a610f003a59b5","sync_unique":"","title":"Update a pipeline","type":"endpoint","parentDoc":"58b72a2df22b830f009a0bee","slug":"update-a-pipeline","link_external":false,"link_url":"","api":{"examples":{"codes":[{"code":"{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"currency\": \"eur\",\n \"title\": \"Qualifications\",\n \"users\": [\"3\"],\n \"groups\": []\n }\n}","language":"json"}]},"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Pipeline's id","required":false,"in":"path","ref":"","_id":"58c1d2a6a3f55c0f00a05635"},{"name":"dealGroup.title","type":"string","enumValues":"","default":"","desc":"Pipeline's title","required":false,"in":"body","ref":"","_id":"58b737e2b72a430f007fa096"},{"name":"dealGroup.currency","type":"string","enumValues":"","default":"","desc":"Default currency to assign to new deals that belong to this deal group.","required":false,"in":"body","ref":"","_id":"58b737e2b72a430f007fa097"},{"name":"dealGroup.allgroups","type":"int","enumValues":"","default":"1","desc":"Whether all user groups have permission to manage this pipeline. Can be either `1` or `0`. If `1`, all user groups can manage this pipeline. If `0`, only user groups in `dealGroup.groups` parameter can manage this pipeline.","required":false,"in":"body","ref":"","_id":"58b7372df22b830f009a0c23"},{"name":"dealGroup.allusers","type":"int","enumValues":"","default":"0","desc":"Whether new deals get auto-assigned to all users. Can be either `1` or `0`. If `1`, new deals are auto-assigned to all users unless auto-assign is disabled. If `0`, new deals are auto-assigned to only the users in `dealGroup.users` parameter.","required":false,"in":"body","ref":"","_id":"58b7372df22b830f009a0c22"},{"name":"dealGroup.autoassign","type":"int","enumValues":"","default":"1","desc":"Deal auto-assign option. Can be one of `0`, `1`, and `2`. If `0`, auto-assign is disabled. If `1`, Round Robin method is used to auto-assign new deals. If `2`, deals are distributed based on deal values.","required":false,"in":"body","ref":"","_id":"58b737e2b72a430f007fa098"},{"name":"dealGroup.users","type":"array_string","enumValues":"","default":"","desc":"List of user ids to auto-assign new deals to unless auto-assign option is disabled.","required":false,"in":"body","ref":"","_id":"58c083b4ed548f0f00406525"},{"name":"dealGroup.groups","type":"array_string","enumValues":"","default":"","desc":"List of user group ids to allow managing this pipeline.","required":false,"in":"body","ref":"","_id":"58c083b4ed548f0f00406524"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealGroup\": {\n \"allgroups\": 1,\n \"allusers\": 0,\n \"autoassign\": 1,\n \"cdate\": \"2017-03-30T12:11:30-05:00\",\n \"currency\": \"eur\",\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n \"4\"\n ],\n \"id\": \"4\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/4/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/4/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/4/stages\"\n },\n \"title\": \"Qualifications\",\n \"udate\": \"2017-03-30T13:44:32-05:00\"\n },\n \"dealGroupGroups\": [],\n \"dealGroupUsers\": [\n {\n \"cdate\": null,\n \"dealGroup\": \"4\",\n \"id\": \"4\",\n \"links\": {\n \"dealGroup\": \"/api/3/dealGroupUsers/4/dealGroup\",\n \"user\": \"/api/3/dealGroupUsers/4/user\"\n },\n \"user\": \"3\"\n }\n ]\n}\n","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/dealGroups/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"createdAt":"2017-03-09T17:50:58.420Z","order":2,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b72ffab72a430f007fa072","type":"endpoint","createdAt":"2017-03-01T20:32:58.637Z","hidden":false,"order":3,"title":"Delete a pipeline","category":"58b5ee57e31a610f003a59b5","isReference":true,"link_external":false,"link_url":"","parentDoc":"58b72a2df22b830f009a0bee","sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"_id":"58b73917f22b830f009a0c2c","ref":"","in":"path","required":false,"desc":"Pipeline's id","default":"","type":"int","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"","name":"deals exist"}]},"url":"/dealGroups/:id","apiSetting":"58b53c301065f9c438aa1f77"},"slug":"delete-a-pipeline","isBodyEmpty":false,"children":[]},{"_id":"58b73010d92e682300b2c07c","link_url":"","parentDoc":"58b72a2df22b830f009a0bee","sync_unique":"","isReference":true,"order":4,"category":"58b5ee57e31a610f003a59b5","createdAt":"2017-03-01T20:33:20.646Z","link_external":false,"title":"List all pipelines","type":"endpoint","api":{"method":"get","params":[{"name":"filters[title]","type":"string","enumValues":"","default":"","desc":"Filter by pipeline's title. The filter matches any pipeline titles that contain the provided title (i.e. \"Contact\" matches all of \"In Contact\", \"To Contact\", and \"Contact Pipeline\").","required":false,"in":"query","ref":"","_id":"58b739bdd92e682300b2c0ad"},{"name":"filters[have_stages]","type":"int","enumValues":"","default":"","desc":"Filter by whether pipelines have deal stages. Can be either `1` or `0`. If `1`, only pipelines with at least one stage will be returned.","required":false,"in":"query","ref":"","_id":"58b73c28f22b830f009a0c38"},{"name":"orders[title]","type":"string","enumValues":"","default":"ASC","desc":"Order by Pipeline's title","required":false,"in":"query","ref":"","_id":"58b739cab72a430f007fa0ad"},{"name":"orders[popular]","type":"string","enumValues":"","default":"ASC","desc":"Order by number of deals each pipeline has. If pipelines have same number of deals, pipelines' created dates are used to determine the order.","required":false,"in":"query","ref":"","_id":"58b73c28f22b830f009a0c39"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealGroups\": [\n {\n \"allgroups\": \"1\",\n \"allusers\": \"1\",\n \"autoassign\": \"1\",\n \"cdate\": \"2017-01-16T14:51:57-06:00\",\n \"currency\": \"usd\",\n \"id\": \"1\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/1/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/1/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/1/stages\"\n },\n \"stages\": [\n \"1\",\n \"2\"\n ],\n \"title\": \"Pipeline A\",\n \"udate\": \"2017-03-01T11:06:32-06:00\"\n },\n {\n \"allgroups\": \"1\",\n \"allusers\": \"1\",\n \"autoassign\": \"0\",\n \"cdate\": \"2017-03-01T14:45:16-06:00\",\n \"currency\": \"usd\",\n \"id\": \"5\",\n \"links\": {\n \"dealGroupGroups\": \"/api/3/dealGroups/5/dealGroupGroups\",\n \"dealGroupUsers\": \"/api/3/dealGroups/5/dealGroupUsers\",\n \"stages\": \"/api/3/dealGroups/5/stages\"\n },\n \"stages\": [\n \"12\",\n \"13\",\n \"14\"\n ],\n \"title\": \"Pipeline Yesterday\",\n \"udate\": \"2017-03-01T15:07:18-06:00\"\n }\n ],\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"Stage 1\",\n \"udate\": \"2017-03-01T11:06:14-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:34-06:00\",\n \"color\": \"00ECC5\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"1\",\n \"id\": \"2\",\n \"links\": {\n \"group\": \"/api/3/dealStages/2/group\"\n },\n \"order\": \"2\",\n \"title\": \"Stage 2\",\n \"udate\": \"2017-03-01T11:06:20-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"18D499\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"12\",\n \"links\": {\n \"group\": \"/api/3/dealStages/12/group\"\n },\n \"order\": \"1\",\n \"title\": \"To Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"13\",\n \"links\": {\n \"group\": \"/api/3/dealStages/13/group\"\n },\n \"order\": \"2\",\n \"title\": \"In Contact\",\n \"udate\": null,\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": null,\n \"color\": \"E6CE4B\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"5\",\n \"id\": \"14\",\n \"links\": {\n \"group\": \"/api/3/dealStages/14/group\"\n },\n \"order\": \"3\",\n \"title\": \"Follow Up\",\n \"udate\": null,\n \"width\": \"280\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/dealGroups","auth":"required","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"slug":"list-all-pipelines","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"58b72cf1f22b830f009a0bf9","api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"category":"58b5ee57e31a610f003a59b5","link_external":false,"slug":"deal-stages","link_url":"","parentDoc":null,"title":"Stages","createdAt":"2017-03-01T20:20:01.197Z","hidden":false,"isReference":true,"order":2,"sync_unique":"","type":"basic","isBodyEmpty":false,"children":[{"_id":"58b741f3eeacc63b0049385d","parentDoc":"58b72cf1f22b830f009a0bf9","slug":"create-a-deal-stage","hidden":false,"link_url":"","order":0,"sync_unique":"","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"dealStage\": {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"order\": 1,\n \"title\": \"Initial Contact\",\n \"width\": 360\n }\n}"}]},"method":"post","params":[{"name":"dealStage.title","type":"string","enumValues":"","default":"","desc":"Deal stage's title","required":true,"in":"body","ref":"","_id":"58b744bdeeacc63b00493874"},{"name":"dealStage.group","type":"string","enumValues":"","default":"","desc":"Deal stage's pipeline id","required":true,"in":"body","ref":"","_id":"58b744bdeeacc63b00493876"},{"name":"dealStage.order","type":"int","enumValues":"","default":"(the highest order of deal stages within the same pipeline) + 1","desc":"Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same. If `dealStage.order` is not provided, the order is assigned with `(the highest order of deal stages within the same pipeline) + 1`","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493875"},{"name":"dealStage.dealOrder","type":"string","enumValues":"","default":"next-action DESC","desc":"Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either \"ASC\" or \"DESC\". See [available options](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493877"},{"name":"dealStage.cardRegion1","type":"string","enumValues":"","default":"title","desc":"What to show in upper-left corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387d"},{"name":"dealStage.cardRegion2","type":"string","enumValues":"","default":"next-action","desc":"What to show in upper-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387c"},{"name":"dealStage.cardRegion3","type":"string","enumValues":"","default":"show-avatar","desc":"Whether to show the avatar in Deal Cards. Can be one of `show-avatar` and `hide-avatar`. If set to `show-avatar`, deal cards will show the avatars. If set to `hide-avatar`, deal cards will hide the avatars","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387b"},{"name":"dealStage.cardRegion4","type":"string","enumValues":"","default":"contact-fullname-orgname","desc":"What to show next to the avatar in Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387a"},{"name":"dealStage.cardRegion5","type":"string","enumValues":"","default":"value","desc":"What to show in lower-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493879"},{"name":"dealStage.color","type":"string","enumValues":"","default":"3f3f3f","desc":"Deal Stage's color. 6-character HEX color code without the hashtag. e.g. \"434343\" to assign the hex color value \"#434343\"","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493878"},{"name":"dealStage.width","type":"int","enumValues":"","default":"280","desc":"Deal stage's width in pixels, without `px` unit","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493873"},{"name":"reorder","type":"int","enumValues":"","default":"","desc":"Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of `0` and `1`. If set to `1`, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest `id` will be assigned with the lowest `order`","required":false,"in":"query","ref":"","_id":"58ef82009f17721b00587987"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealStage\": {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": 1,\n \"title\": \"Initial Contact\",\n \"udate\": \"2017-03-01T15:55:58-06:00\",\n \"width\": 280\n }\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"url":"/dealStages","apiSetting":"58b53c301065f9c438aa1f77"},"category":"58b5ee57e31a610f003a59b5","title":"Create a stage","type":"endpoint","isReference":true,"createdAt":"2017-03-01T21:49:39.310Z","link_external":false,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b8677758927d230065b6e8","slug":"retrieve-a-deal-stage","type":"endpoint","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealStage\": {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-01-20T09:27:32-06:00\",\n \"color\": \"C481DF\",\n \"dealOrder\": \"score DESC\",\n \"group\": \"1\",\n \"id\": \"1\",\n \"links\": {\n \"group\": \"/api/3/dealStages/1/group\"\n },\n \"order\": \"1\",\n \"title\": \"Stage 1\",\n \"udate\": \"2017-03-02T11:41:01-06:00\",\n \"width\": \"280\"\n }\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/dealStages/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal stage's id","required":false,"in":"path","ref":"","_id":"58b867d058927d230065b6ea"}],"apiSetting":"58b53c301065f9c438aa1f77"},"category":"58b5ee57e31a610f003a59b5","hidden":false,"isReference":true,"link_url":"","order":1,"createdAt":"2017-03-02T18:41:59.508Z","link_external":false,"parentDoc":"58b72cf1f22b830f009a0bf9","sync_unique":"","title":"Retrieve a stage","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b865099cce072d0084e783","category":"58b5ee57e31a610f003a59b5","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"dealStage\": {\n \"cardRegion1\": \"contact-orgname\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"hide-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"color\": \"696969\",\n \"dealOrder\": \"title ASC\",\n \"group\": \"4\",\n \"order\": 1,\n \"title\": \"Qualifications - Low\",\n \"width\": 270\n }\n}"}]},"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal stage's id","required":false,"in":"path","ref":"","_id":"58b8660758927d230065b6e2"},{"name":"dealStage.title","type":"string","enumValues":"","default":"","desc":"Deal stage's title","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493874"},{"name":"dealStage.group","type":"string","enumValues":"","default":"","desc":"Deal stage's pipeline id","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493876"},{"name":"dealStage.order","type":"int","enumValues":"","default":"","desc":"Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493875"},{"name":"dealStage.dealOrder","type":"string","enumValues":"","default":"","desc":"Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either \"ASC\" or \"DESC\". See [available options](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493877"},{"name":"dealStage.cardRegion1","type":"string","enumValues":"","default":"","desc":"What to show in upper-left corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387d"},{"name":"dealStage.cardRegion2","type":"string","enumValues":"","default":"","desc":"What to show in upper-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387c"},{"name":"dealStage.cardRegion3","type":"string","enumValues":"","default":"","desc":"Whether to show the avatar in Deal Cards. Can be one of `show-avatar` and `hide-avatar`. If set to `show-avatar`, deal cards will show the avatars. If set to `hide-avatar`, deal cards will hide the avatars","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387b"},{"name":"dealStage.cardRegion4","type":"string","enumValues":"","default":"","desc":"What to show next to the avatar in Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b0049387a"},{"name":"dealStage.cardRegion5","type":"string","enumValues":"","default":"","desc":"What to show in lower-right corner of Deal Cards. See [available values](#section-deal-stage-parameters-available-values)","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493879"},{"name":"dealStage.color","type":"string","enumValues":"","default":"","desc":"Deal Stage's color. 6-character HEX color code without the hashtag. e.g. \"434343\" to assign the hex color value \"#434343\"","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493878"},{"name":"dealStage.width","type":"int","enumValues":"","default":"","desc":"Deal stage's width in pixels, without `px` unit","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493873"},{"name":"reorder","type":"int","enumValues":"","default":"","desc":"Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of `0` and `1`. If set to `1`, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest `id` will be assigned with the lowest `order`","required":false,"in":"query","ref":"","_id":"58f9174ecc16db0f0045cf3e"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealStage\": {\n \"cardRegion1\": \"contact-orgname\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"hide-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"696969\",\n \"dealOrder\": \"title ASC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": 1,\n \"title\": \"Qualifications - Low\",\n \"udate\": \"2017-03-01T16:03:57-06:00\",\n \"width\": 270\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/dealStages/:id","apiSetting":"58b53c301065f9c438aa1f77"},"link_url":"","slug":"update-a-deal-stage","isReference":true,"link_external":false,"sync_unique":"","title":"Update a stage","type":"endpoint","hidden":false,"parentDoc":"58b72cf1f22b830f009a0bf9","createdAt":"2017-03-02T18:31:37.659Z","order":2,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b74231eeacc63b0049385f","category":"58b5ee57e31a610f003a59b5","link_external":false,"parentDoc":"58b72cf1f22b830f009a0bf9","createdAt":"2017-03-01T21:50:41.785Z","hidden":false,"link_url":"","slug":"delete-a-deal-stage","api":{"params":[{"_id":"58b74221b72a430f007fa0db","ref":"","in":"path","required":false,"desc":"Deal stage's id","default":"","type":"int","name":"id"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"}]},"url":"/dealStages/:id","auth":"required","examples":{"codes":[]},"method":"delete","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":3,"sync_unique":"","title":"Delete a stage","type":"endpoint","isBodyEmpty":false,"children":[]},{"_id":"58b7423fb72a430f007fa0dc","link_url":"","createdAt":"2017-03-01T21:50:55.717Z","hidden":false,"order":4,"parentDoc":"58b72cf1f22b830f009a0bf9","category":"58b5ee57e31a610f003a59b5","link_external":false,"slug":"list-all-deal-stages","sync_unique":"","title":"List all stages","api":{"params":[{"name":"filters[title]","type":"string","enumValues":"","default":"","desc":"Filter by deal stages' titles. Any stages whose titles partial-match the filter value are returned","required":false,"in":"query","ref":"","_id":"58b746a5eeacc63b00493883"},{"name":"filters[d_groupid]","type":"string","enumValues":"","default":"","desc":"Filter by pipeline's id","required":false,"in":"query","ref":"","_id":"58f919909052ee0f001b5b08"},{"name":"orders[title]","type":"string","enumValues":"","default":"","desc":"Order by deal stage's title","required":false,"in":"query","ref":"","_id":"58b746a5eeacc63b00493882"}],"results":{"codes":[{"code":"{\n \"dealStages\": [\n {\n \"cardRegion1\": \"title\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"show-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:52:42-06:00\",\n \"color\": \"32B0FC\",\n \"dealOrder\": \"next-action DESC\",\n \"group\": \"4\",\n \"id\": \"15\",\n \"links\": {\n \"group\": \"/api/3/dealStages/15/group\"\n },\n \"order\": \"1\",\n \"title\": \"Initial Contact\",\n \"udate\": \"2017-03-01T15:52:42-06:00\",\n \"width\": \"280\"\n },\n {\n \"cardRegion1\": \"contact-orgname\",\n \"cardRegion2\": \"next-action\",\n \"cardRegion3\": \"hide-avatar\",\n \"cardRegion4\": \"contact-fullname-orgname\",\n \"cardRegion5\": \"value\",\n \"cdate\": \"2017-03-01T15:55:58-06:00\",\n \"color\": \"696969\",\n \"dealOrder\": \"title ASC\",\n \"group\": \"4\",\n \"id\": \"16\",\n \"links\": {\n \"group\": \"/api/3/dealStages/16/group\"\n },\n \"order\": \"1\",\n \"title\": \"Qualifications - Low\",\n \"udate\": \"2017-03-01T16:03:57-06:00\",\n \"width\": \"270\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":"","status":200,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/dealStages","auth":"required","examples":{"codes":[]},"method":"get","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"591f5ecb7050410f00dee857","title":"Move deals to another stage","hidden":false,"isReference":true,"link_url":"","order":5,"parentDoc":"58b72cf1f22b830f009a0bf9","api":{"auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"deal\": {\n \"stage\": \"3\"\n }\n}"}]},"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal stage's id whose deals are to be moved to another deal stage","required":false,"in":"path","ref":"","_id":"58b8660758927d230065b6e2"},{"name":"deal.stage","type":"string","enumValues":"","default":"","desc":"Target deal stage's id to move deals to","required":false,"in":"body","ref":"","_id":"58b744bdeeacc63b00493873"}],"results":{"codes":[{"name":"","code":"{\n \"deals\": [\n {\n \"activitycount\": \"1\",\n \"cdate\": \"2017-05-19T16:21:47-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"6faccb2d\",\n \"id\": \"1\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/1/dealActivities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-05-19T16:21:47-05:00\",\n \"nextTask\": null,\n \"nextdealid\": \"2\",\n \"nexttaskid\": \"0\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"0\",\n \"title\": \"Another Deal\",\n \"value\": \"10000\"\n },\n {\n \"activitycount\": \"1\",\n \"cdate\": \"2017-05-19T16:23:01-05:00\",\n \"contact\": \"2\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"fe7cc4f3\",\n \"id\": \"2\",\n \"links\": {\n \"dealActivities\": \"/api/3/deals/2/dealActivities\",\n \"contact\": \"/api/3/deals/2/contact\",\n \"contactDeals\": \"/api/3/deals/2/contactDeals\",\n \"group\": \"/api/3/deals/2/group\",\n \"nextTask\": \"/api/3/deals/2/nextTask\",\n \"notes\": \"/api/3/deals/2/notes\",\n \"organization\": \"/api/3/deals/2/organization\",\n \"owner\": \"/api/3/deals/2/owner\",\n \"scoreValues\": \"/api/3/deals/2/scoreValues\",\n \"stage\": \"/api/3/deals/2/stage\",\n \"tasks\": \"/api/3/deals/2/tasks\"\n },\n \"mdate\": \"2017-05-19T16:23:01-05:00\",\n \"nextTask\": null,\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"0\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"3\",\n \"status\": \"0\",\n \"title\": \"Urgent Deal\",\n \"value\": \"10000\"\n }\n ]\n}","language":"json","status":200},{"language":"json","status":422,"name":"Different pipeline","code":"{\n \"errors\": [\n {\n \"detail\": \"Target stage does not belong to same pipeline\",\n \"source\": {\n \"pointer\": \"/data/attributes/stage\"\n },\n \"status\": 422,\n \"title\": \"Invalid attribute\"\n }\n ]\n}"}]},"url":"/dealStages/:id/deals","apiSetting":"58b53c301065f9c438aa1f77"},"category":"58b5ee57e31a610f003a59b5","createdAt":"2017-05-19T21:08:27.246Z","link_external":false,"sync_unique":"","slug":"move-deals-to-another-deal-stage","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5bccf44397cb800028020fe7","category":"58b5ee57e31a610f003a59b5","createdAt":"2018-10-21T21:48:51.182Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":3,"slug":"dealcustomfieldmeta","type":"basic","title":"Custom Deal Fields","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5bcce1b05190cf003edaee4c","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf44397cb800028020fe7","createdAt":"2018-10-21T20:29:36.251Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 19:57:37\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/3/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}"},{"status":422,"language":"json","code":"{\n\t\"errors\": [\n \t\"title\": \"The field type field is required.\",\n \"detail\": \"\",\n \"code\": 422\n ]\n}"}]},"examples":{"codes":[{"language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample text field2\",\n\t\t\"fieldType\": \"text\",\n\t\t\"fieldDefault\": \"Default Text\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 1\n\t}\n}","name":"text"},{"code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample textarea field\",\n\t\t\"fieldType\": \"textarea\",\n\t\t\"fieldDefault\": \"Default Text in Text Area\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 2\n\t}\n}","language":"json","name":"textarea"},{"code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample date field\",\n\t\t\"fieldType\": \"date\",\n\t\t\"fieldDefault\": \"2018-12-31 00:00:00\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 3\n\t}\n}","language":"json","name":"date"},{"name":"dropdown","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample dropdown field\",\n\t\t\"fieldType\": \"dropdown\",\n\t\t\"fieldDefault\": \"option 2\",\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 4\n\t}\n}"},{"name":"multiselect","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample multiselect field\",\n\t\t\"fieldType\": \"multiselect\",\n\t\t\"fieldDefault\": [\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 5\n\t}\n}"},{"name":"radio","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample radio field\",\n\t\t\"fieldType\": \"radio\",\n\t\t\"fieldDefault\": \"option 2\",\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 6\n\t}\n}"},{"name":"checkbox","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample checkbox field\",\n\t\t\"fieldType\": \"checkbox\",\n\t\t\"fieldDefault\": [\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"fieldOptions\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 2\",\n\t\t\t\"option 3\"\n\t\t],\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 7\n\t}\n}"},{"name":"hidden","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample hidden field\",\n\t\t\"fieldType\": \"hidden\",\n\t\t\"fieldDefault\": \"Default Text in Hidden Field\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 8\n\t}\n}"},{"name":"number","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample number field\",\n\t\t\"fieldType\": \"number\",\n\t\t\"fieldDefault\": \"100.99\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 9\n\t}\n}"},{"name":"currency","language":"json","code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample money field\",\n\t\t\"fieldType\": \"currency\",\n\t\t\"fieldDefault\": \"10099\",\n\t\t\"fieldDefaultCurrency\": \"aud\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 10\n\t}\n}"},{"code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"sample datetime field\",\n\t\t\"fieldType\": \"datetime\",\n\t\t\"fieldDefault\": \"2020-05-16T03:15:00-05:00\",\n\t\t\"isFormVisible\": 1,\n\t\t\"isRequired\": 1,\n\t\t\"displayOrder\": 3\n\t}\n}","language":"json","name":"datetime (ISO)"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"dealCustomFieldMetum.fieldLabel","type":"string","enumValues":"","default":"","desc":"Name of the field","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"dealCustomFieldMetum.fieldType","type":"string","enumValues":"","default":"","desc":"Type of field. Possible values are: `text`, `textarea`, `date`, `datetime`, `dropdown`, `multiselect`, `radio`, `checkbox`, `hidden`, `currency`, or `number`.","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ec"},{"name":"dealCustomFieldMetum.fieldOptions","type":"array_string","enumValues":"","default":"","desc":"Options for the field. Only necessary if `field_type` is `dropdown`, `multiselect`, `radio`, or `checkbox`.","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"dealCustomFieldMetum.fieldDefault","type":"string","enumValues":"","default":"","desc":"Default value of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ea"},{"name":"dealCustomFieldMetum.fieldDefaultCurrency","type":"string","enumValues":"","default":"","desc":"The 3-letter currency code of the default currency for the field. Only necessary if `field_type` is `currency`.","required":false,"in":"body","ref":"","_id":"5c8004ef2e306c020a0486d7"},{"name":"dealCustomFieldMetum.isFormVisible","type":"boolean","enumValues":"","default":"","desc":"Whether or not the field is visible on forms","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e9"},{"name":"dealCustomFieldMetum.displayOrder","type":"int","enumValues":"","default":"","desc":"Order for displaying the field on Manage Fields page and deal profiles","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e7"}],"url":"/dealCustomFieldMeta","method":"post"},"isReference":true,"order":0,"slug":"create-custom-deal-field-meta","type":"endpoint","title":"Create a custom field meta","previousSlug":"create-dealcustomfieldmeta-resources","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bccf274615bc4002e49b24a","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf44397cb800028020fe7","createdAt":"2018-10-21T21:41:08.322Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"},{"status":200,"language":"json","code":"{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 1,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field to retrieve","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/dealCustomFieldMeta/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-custom-deal-field-meta","type":"endpoint","title":"Retrieve a custom field","deprecated":false,"previousSlug":"retrieve-a-dealcustomfieldmeta-resource","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bccc225678854002bbe10b5","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf44397cb800028020fe7","createdAt":"2018-10-21T18:15:01.817Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\t\n\t\"dealCustomFieldMetum\": {\n\t\t\"fieldLabel\": \"New Title\",\n\t\t\"fieldDefault\": \"Default Text\",\n\t\t\"isFormVisible\": 1,\n\t\t\"displayOrder\": 1\n\t}\n}","language":"json"}]},"results":{"codes":[{"code":"{\n \"dealCustomFieldMetum\": {\n \"id\": \"1\",\n \"fieldLabel\": \"New Title\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": \"Default Text\",\n \"isFormVisible\": 1,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"createdTimestamp\": \"2018-10-22 19:57:37\",\n \"updatedTimestamp\": \"2018-10-22 20:04:21\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n}","language":"json","status":200},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the custom field to update","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"},{"name":"dealCustomFieldMetum.fieldLabel","type":"string","enumValues":"","default":"","desc":"Name of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"dealCustomFieldMetum.fieldOptions","type":"array_string","enumValues":"","default":"","desc":"Options for the field. Only necessary if field_type is dropdown, multiselect, radio, or checkbox.","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"dealCustomFieldMetum.fieldDefault","type":"string","enumValues":"","default":"","desc":"Default value of the field","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ea"},{"name":"dealCustomFieldMetum.isFormVisible","type":"boolean","enumValues":"","default":"","desc":"Whether or not the field is visible on forms","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e9"},{"name":"dealCustomFieldMetum.displayOrder","type":"int","enumValues":"","default":"","desc":"Order for displaying the field on Manage Fields page and deal profiles","required":false,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845e7"}],"url":"/dealCustomFieldMeta/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-custom-deal-field-meta","type":"endpoint","title":"Update a custom field","previousSlug":"update-a-dealcustomfieldmeta","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5bccf154cda7ec001d5d4de4","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf44397cb800028020fe7","createdAt":"2018-10-21T21:36:20.003Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"DealCustomFieldMeta deleted.\"\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the field to delete","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/dealCustomFieldMeta/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-custom-deal-field-meta","type":"endpoint","title":"Delete a custom field","deprecated":false,"previousSlug":"delete-a-dealcustomfieldmeta-resource","isBodyEmpty":false,"children":[]},{"_id":"5bcce57ad1807c005b65bd07","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf44397cb800028020fe7","createdAt":"2018-10-21T20:45:46.787Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealCustomFieldMeta\": [\n {\n \"id\": \"1\",\n \"fieldLabel\": \"Text Example\",\n \"fieldType\": \"text\",\n \"fieldOptions\": null,\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 1,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n },\n {\n \"id\": \"2\",\n \"fieldLabel\": \"Multiple Choice Example\",\n \"fieldType\": \"multiselect\",\n \"fieldOptions\": [\n \t\"Option 1\",\n \t\"Option 2\",\n \t\"Option 3\"\n ],\n \"fieldDefault\": 1,\n \"fieldDefaultCurrency\": null,\n \"isFormVisible\": 0,\n \"isRequired\": 0,\n \"displayOrder\": 2,\n \"personalization\": \"\",\n \"knownFieldId\": null,\n \"hideFieldFlag\": 0,\n \"createdTimestamp\": \"2019-04-23 15:34:00\",\n \"updatedTimestamp\": \"2019-05-03 15:16:51\",\n \"links\": {\n \"dealCustomFieldData\": \"https://:account.api-us1.com/api/:version/dealCustomFieldMeta/1/dealCustomFieldData\"\n }\n }\n ]\n}"}]},"auth":"required","params":[{"name":"limit","type":"int","enumValues":"","default":"100","desc":"The number of fields returned per request.","required":false,"in":"query","ref":"","_id":"5fdc042c19addc004957fb6d"}],"url":"/dealCustomFieldMeta","method":"get"},"isReference":true,"order":4,"slug":"retrieve-all-custom-deal-field-meta","type":"endpoint","title":"List all custom fields","previousSlug":"retrieve-all-dealcustomfielddata-resources","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]}]},{"_id":"5bccf388cda7ec001d5d4de6","category":"58b5ee57e31a610f003a59b5","createdAt":"2018-10-21T21:45:44.674Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":4,"slug":"dealcustomfielddata","type":"basic","title":"Custom Deal Field Values","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5bccf55ec8ea7a0043a54fc9","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","createdAt":"2018-10-21T21:53:34.030Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"2\",\n\t\t\"customFieldId\": \"1\",\n\t\t\"fieldValue\": \"test title\"\n\t}\n}\n","language":"json","name":"text/textarea/hidden"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"2\",\n\t\t\"customFieldId\": \"2\",\n\t\t\"fieldValue\": \"||option 1||option 2||option 3||\"\n\t}\n}","language":"json","name":"dropdown/radio"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"2\",\n\t\t\"customFieldId\": \"3\",\n\t\t\"fieldValue\": [\n\t\t\t\"option 1\",\n\t\t\t\"option 3\",\n\t\t\t\"option 4\"\n\t\t]\n\t}\n}","language":"json","name":"multiselect/checkbox (multiple)"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"1\",\n\t\t\"customFieldId\": \"4\",\n\t\t\"fieldValue\": 9999,\n\t\t\"fieldCurrency\": \"cad\"\n\t}\n}","language":"json","name":"currency"},{"name":"number","language":"json","code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"1\",\n\t\t\"customFieldId\": \"5\",\n\t\t\"fieldValue\": \"100.99\"\n\t}\n}"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"1\",\n\t\t\"customFieldId\": \"6\",\n\t\t\"fieldValue\": \"2018-12-31\"\n\t}\n}","language":"json","name":"date"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"1\",\n\t\t\"customFieldId\": \"6\",\n\t\t\"fieldValue\": \"2020-05-19T02:45:00-05:00\"\n\t}\n}","language":"json","name":"datetime"},{"code":"{\n\t\"dealCustomFieldDatum\": {\n\t\t\"dealId\": \"2\",\n\t\t\"customFieldId\": \"3\",\n\t\t\"fieldValue\": [\n\t\t\t\"option 1\"\n\t\t]\n\t}\n}","language":"json","name":"multiselect/checkbox (single)"}]},"results":{"codes":[{"code":"{\n \"dealCustomFieldDatum\": {\n \"id\": \"5\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum\"\n }\n }\n}","language":"json","status":200},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": \"422\",\n \"title\": \"The given data was invalid.\",\n \"detail\": \"The deal id field is required.\"\n },\n {\n \"status\": \"422\",\n \"title\": \"The given data was invalid.\",\n \"detail\": \"The custom field id field is required.\"\n }\n ]\n}"},{"code":"{\n \"errors\": [\n {\n \"detail\": \"A related deal was not found.\"\n }\n ]\n}","language":"json","status":422},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"detail\": \"A custom field value must be provided.\"\n }\n ]\n}"},{"status":422,"code":"{\n \"errors\": [\n {\n \"detail\": \"The custom field value `abc` could not be saved to the custom field of type `date`.\"\n }\n ]\n}","language":"json"}]},"auth":"required","params":[{"name":"dealCustomFieldDatum.dealId","type":"int","enumValues":"","default":"","desc":"The ID of the deal this field value relates to","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ed"},{"name":"dealCustomFieldDatum.customFieldId","type":"int","enumValues":"","default":"","desc":"The ID of the custom field metum this field value relates to","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845ec"},{"name":"dealCustomFieldDatum.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For `currency` field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5bcccf5c37401e000dd845eb"},{"name":"dealCustomFieldDatum.fieldCurrency","type":"string","enumValues":"","default":"Default Currency for Field","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5c80244e3b18a4005789e164"}],"url":"/dealCustomFieldData","method":"post"},"isReference":true,"order":0,"slug":"create-custom-deal-field-value","type":"endpoint","title":"Create a custom field value","deprecated":false,"previousSlug":"create-dealcustomfielddata-resource","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5cdc421c0c875a00398c273a","createdAt":"2019-05-15T16:45:16.802Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"the bulk insert was successful\"\n}"}]},"examples":{"codes":[{"code":"[\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"1\",\n \"fieldValue\": \"test title\"\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"2\",\n \"fieldValue\": \"test title\"\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"3\",\n \"fieldValue\": [\n \"option 1\",\n \"option 3\",\n \"option 4\"\n ]\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"4\",\n \"fieldValue\": 9999,\n \"fieldCurrency\": \"cad\"\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"5\",\n \"fieldValue\": \"100.99\"\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"6\",\n \"fieldValue\": \"2018-12-31\"\n },\n {\n \"dealId\": \"1\",\n \"customFieldId\": \"7\",\n \"fieldValue\": \"2020-05-19T02:45:00-05:00\" //ISO format\n }\n]","language":"json","name":null}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"array","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42d"},{"name":"array.dealId","type":"int","enumValues":"","default":"","desc":"The ID of the deal this field value relates to","required":true,"in":"body","ref":"","_id":"5cdc54a56780d700452ffa4d"},{"name":"array.customFieldId","type":"int","enumValues":"","default":"","desc":"The ID of the custom field metum this field value relates to","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42c"},{"name":"array.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42b"},{"name":"array.fieldCurrency","type":"string","enumValues":"","default":"","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42a"}],"url":"/dealCustomFieldData/bulkCreate","method":"post"},"isReference":true,"order":1,"slug":"bulk-create-a-custom-deal-field-value","type":"endpoint","title":"Bulk create a custom deal field value","deprecated":false,"previousSlug":"bulk-create-a-custom-field-value","isBodyEmpty":false,"children":[]},{"_id":"5bccc6ec27f78e000d4b7652","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","createdAt":"2018-10-21T18:35:24.338Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the dealCustomFieldData to retrieve","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/dealCustomFieldData/:id","method":"get"},"isReference":true,"order":2,"slug":"retrieve-a-custom-deal-field-value","type":"endpoint","title":"Retrieve a custom field value","deprecated":false,"previousSlug":"retrieve-a-dealcustomfielddata","isBodyEmpty":false,"children":[]},{"_id":"5bcd16882397ef0012470139","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","createdAt":"2018-10-22T00:15:04.020Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n}"},{"status":404,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"detail\": \"The custom field value could not be saved to the custom field of type `number`.\"\n }\n ]\n}"}]},"examples":{"codes":[{"name":"text/textarea/hidden","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": \"New title\"\n }\n}"},{"name":"dropdown/radio","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": \"option 1\"\n }\n}"},{"name":"multiselect/checkbox (multiple)","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": [\n \t \"option 1\",\n \t \"option 3\",\n \t \"option 4\"\n \t]\n }\n}"},{"name":"currency","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": 9999,\n \t\"fieldCurrency\": \"cad\"\n }\n}"},{"name":"number","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": \"100.99\"\n }\n}"},{"name":"date","language":"json","code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": \"2018-12-31 00:00:00\"\n }\n}"},{"code":"{\n \"dealCustomFieldDatum\" {\n \t\"fieldValue\": \"2020-05-19T02:45:00-05:00\"\n }\n}","language":"json","name":"datetime (ISO)"},{"code":"{\n \"dealCustomFieldDatum\": {\n \t\"fieldValue\": [\n \t\"option 1\"\n \t]\n }\n}","language":"json","name":"multiselect/checkbox (single)"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the custom fields value to update","required":false,"in":"path","ref":"","_id":"5bcde79d4a06de00550e66cb"},{"name":"dealCustomFieldDatum.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for text","required":false,"in":"body","ref":"","_id":"5be1006949b055001dcf68aa"},{"name":"dealCustomFieldDatum.fieldCurrency","type":"string","enumValues":"","default":"Default Currency for Field","desc":"Currency code for the `currency` value","required":false,"in":"body","ref":"","_id":"5c8045a67c748500622c75d0"}],"url":"/dealCustomFieldData/:id","method":"put"},"isReference":true,"order":3,"slug":"update-a-custom-deal-field-value","type":"endpoint","title":"Update a custom field value","deprecated":false,"previousSlug":"update-a-dealcustomfielddata-resource","isBodyEmpty":false,"children":[]},{"_id":"5cdc5fc2372c2500513a2a9a","createdAt":"2019-05-15T18:51:46.445Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"name":null,"language":"json","code":"[\n {\n \"id\": \"1\",\n \"fieldValue\": \"test title\"\n },\n {\n \"id\": \"2\",\n \"fieldValue\": [\n \"option 1\",\n \"option 3\",\n \"option 4\"\n ]\n },\n {\n \"id\": \"3\",\n \"fieldValue\": 9999,\n \"fieldCurrency\": \"cad\"\n },\n {\n \"id\": \"4\",\n \"fieldValue\": \"100.99\"\n },\n {\n \"id\": \"5\",\n \"fieldValue\": \"2018-12-31\"\n },\n {\n \"id\": \"6\",\n \"fieldValue\": \"2020-05-19T02:45:00-05:00\" //ISO format\n }\n]"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"DealCustomFieldDatas with ID(s): 1, 2, 3, 4, 5 successfully bulk updated.\"\n}"}]},"auth":"required","params":[{"name":"array","type":"array_object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42d"},{"name":"array.id","type":"int","enumValues":"","default":"","desc":"ID of the dealCustomFieldData to update","required":true,"in":"body","ref":"","_id":"5cdc54a56780d700452ffa4d"},{"name":"array.fieldValue","type":"string","enumValues":"","default":"","desc":"Values for the field. (For currency field only, this needs to be in cents: eg, 10050 = 100.5)","required":true,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42b"},{"name":"array.fieldCurrency","type":"string","enumValues":"","default":"","desc":"Currency code for the money value","required":false,"in":"body","ref":"","_id":"5cdc56df0b579a0303afc42a"}],"url":"/dealCustomFieldData/bulkUpdate","method":"patch"},"isReference":true,"order":4,"slug":"bulk-update-a-custom-field-value","type":"endpoint","title":"Bulk update a custom field value","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bccfafd9b2b5700502abb3e","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","createdAt":"2018-10-21T22:17:33.810Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"message\": \"DealCustomFieldData deleted.\"\n}"},{"status":404,"language":"text","code":"{\n \"errors\": [\n {\n \"status\": 404,\n \"title\": \"Not Found\"\n }\n ]\n}"}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the dealCustomFieldData to retrieve","required":false,"in":"path","ref":"","_id":"58b5f08ce31a610f003a5a17"}],"url":"/dealCustomFieldData/:id","method":"delete"},"isReference":true,"order":5,"slug":"delete-a-custom-deal-field-data","type":"endpoint","title":"Delete a custom field value","deprecated":false,"previousSlug":"retrieve-a-custom-deal-field-data","isBodyEmpty":false,"children":[]},{"_id":"5be104800cee27000d242efb","category":"58b5ee57e31a610f003a59b5","parentDoc":"5bccf388cda7ec001d5d4de6","createdAt":"2018-11-06T03:03:28.671Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealCustomFieldData\": [\n {\n \"id\": \"3\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 1,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:07\",\n \"updatedTimestamp\": \"2018-11-06 02:26:07\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/3/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/3/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"4\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 3,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:26:51\",\n \"updatedTimestamp\": \"2018-11-06 02:26:51\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/4/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/4/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"5\",\n \"dealCustomFieldMetumId\": 1,\n \"dealId\": 2,\n \"customFieldId\": 1,\n \"createdTimestamp\": \"2018-11-06 02:27:05\",\n \"updatedTimestamp\": \"2018-11-06 02:27:05\",\n \"fieldValue\": \"test title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/5/dealCustomFieldMetum\"\n }\n },\n {\n \"id\": \"1\",\n \"dealCustomFieldMetumId\": 5,\n \"dealId\": 2,\n \"customFieldId\": 5,\n \"createdTimestamp\": \"2018-10-29 20:40:38\",\n \"updatedTimestamp\": \"2018-11-06 02:21:36\",\n \"fieldValue\": \"New title\",\n \"links\": {\n \"deal\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/deal\",\n \"dealCustomFieldMetum\": \"https://:account.api-us1.com/api/:version/dealCustomFieldData/1/dealCustomFieldMetum\"\n }\n }\n ]\n}"}]},"auth":"required","params":[{"name":"filters[dealId]","type":"string","enumValues":"","default":"","desc":"Filter results by a specific deal (note that Id uses a capital I)","required":false,"in":"query","ref":"","_id":"5c057138c1c413018cb2376e"}],"url":"/dealCustomFieldData","method":"get"},"isReference":true,"order":6,"slug":"list-all-custom-fielddata-field-values","type":"endpoint","title":"List all custom field values","deprecated":false,"previousSlug":"list-all-custom-field-values","isBodyEmpty":false,"children":[]}]},{"_id":"5c73fd32e8fdc000572a4c36","createdAt":"2019-02-25T14:35:30.348Z","category":"58b5ee57e31a610f003a59b5","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":5,"slug":"secondary-contacts","type":"basic","title":"Secondary Contacts","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5c740394dcf02a00572aae41","createdAt":"2019-02-25T15:02:44.634Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5c73fd32e8fdc000572a4c36","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"contactDeal\": {\n\t\t\"contact\": 1,\n\t\t\"deal\": 2\n\t}\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"deals\": [\n {\n \"hash\": \"c7b5a271\",\n \"owner\": \"1\",\n \"contact\": \"2\",\n \"organization\": null,\n \"group\": \"1\",\n \"stage\": \"1\",\n \"title\": \"deal1\",\n \"description\": \"\",\n \"percent\": \"0\",\n \"cdate\": \"2018-10-31T13:33:09-05:00\",\n \"mdate\": \"2018-10-31T13:33:09-05:00\",\n \"nexttaskid\": null,\n \"value\": \"10000\",\n \"currency\": \"usd\",\n \"winProbability\": null,\n \"winProbabilityMdate\": \"2018-10-31T13:33:09-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"2\",\n \"edate\": null,\n \"links\": {\n \"dealActivities\": \"/api/3/deals/2/dealActivities\",\n \"contact\": \"/api/3/deals/2/contact\",\n \"contactDeals\": \"/api/3/deals/2/contactDeals\",\n \"group\": \"/api/3/deals/2/group\",\n \"nextTask\": \"/api/3/deals/2/nextTask\",\n \"notes\": \"/api/3/deals/2/notes\",\n \"organization\": \"/api/3/deals/2/organization\",\n \"owner\": \"/api/3/deals/2/owner\",\n \"scoreValues\": \"/api/3/deals/2/scoreValues\",\n \"stage\": \"/api/3/deals/2/stage\",\n \"tasks\": \"/api/3/deals/2/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/2/dealCustomFieldData\"\n },\n \"id\": \"2\",\n \"isDisabled\": false\n }\n ],\n \"contactDeal\": {\n \"contact\": 3,\n \"deal\": 2,\n \"cdate\": \"2019-02-25T09:00:02-06:00\",\n \"links\": {\n \"deal\": \"/api/3/contactDeals/3/deal\",\n \"contact\": \"/api/3/contactDeals/3/contact\"\n },\n \"id\": \"3\"\n }\n}","name":""},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The given contact is already associated to the deal\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"source\": {\n \"pointer\": \"/data/attributes/contact\"\n }\n }\n ]\n}","name":"already exists"},{"name":"required field missing","status":422,"language":"text","code":"{\n \"errors\": [\n {\n \"title\": \"The contactDeal contact was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"source\": {\n \"pointer\": \"/data/attributes/contact\"\n }\n }\n ]\n}"}]},"auth":"required","params":[{"name":"contactDeal.deal","type":"string","enumValues":"","default":"","desc":"Deal's id","required":true,"in":"body","ref":"","_id":"5c740394dcf02a00572aae43"},{"name":"contactDeal.contact","type":"string","enumValues":"","default":"","desc":"Contact's id","required":true,"in":"body","ref":"","_id":"5c740394dcf02a00572aae42"}],"url":"/contactDeals","method":"post"},"isReference":true,"order":0,"slug":"create-a-secondary-contact","type":"endpoint","title":"Create a secondary contact","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5c73feda541a2c0019367705","createdAt":"2019-02-25T14:42:34.489Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5c73fd32e8fdc000572a4c36","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactDeal\": {\n \"deal\": \"2\",\n \"contact\": \"1\",\n \"cdate\": \"2019-02-25T08:16:56-06:00\",\n \"links\": {\n \"deal\": \"/api/3/contactDeals/1/deal\",\n \"contact\": \"/api/3/contactDeals/1/contact\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for SubscriberDeal with id 100\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Secondary Contact's id","required":false,"in":"path","ref":"","_id":"5c73feda541a2c0019367706"}],"url":"/contactDeals/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-secondary-contact","type":"endpoint","title":"Retrieve a secondary contact","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5c741493c09d9a000f05f07a","createdAt":"2019-02-25T16:15:15.628Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5c73fd32e8fdc000572a4c36","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"contactDeal\": {\n\t\t\"contact\": 4,\n\t\t\"deal\": 1,\n \"role\": 1\n\t}\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"deals\": [\n {\n \"hash\": \"c7b5a271\",\n \"owner\": \"1\",\n \"contact\": \"2\",\n \"organization\": null,\n \"group\": \"1\",\n \"stage\": \"1\",\n \"title\": \"deal1\",\n \"description\": \"\",\n \"percent\": \"0\",\n \"cdate\": \"2018-10-31T13:33:09-05:00\",\n \"mdate\": \"2018-10-31T13:33:09-05:00\",\n \"nexttaskid\": null,\n \"value\": \"10000\",\n \"currency\": \"usd\",\n \"winProbability\": null,\n \"winProbabilityMdate\": \"2018-10-31T13:33:09-05:00\",\n \"status\": \"0\",\n \"activitycount\": \"1\",\n \"nextdealid\": \"2\",\n \"edate\": null,\n \"links\": {\n \"dealActivities\": \"/api/3/deals/2/dealActivities\",\n \"contact\": \"/api/3/deals/2/contact\",\n \"contactDeals\": \"/api/3/deals/2/contactDeals\",\n \"group\": \"/api/3/deals/2/group\",\n \"nextTask\": \"/api/3/deals/2/nextTask\",\n \"notes\": \"/api/3/deals/2/notes\",\n \"organization\": \"/api/3/deals/2/organization\",\n \"owner\": \"/api/3/deals/2/owner\",\n \"scoreValues\": \"/api/3/deals/2/scoreValues\",\n \"stage\": \"/api/3/deals/2/stage\",\n \"tasks\": \"/api/3/deals/2/tasks\",\n \"dealCustomFieldData\": \"/api/3/deals/2/dealCustomFieldData\"\n },\n \"id\": \"2\",\n \"isDisabled\": false\n }\n ],\n \"contactDeal\": {\n \"deal\": \"2\",\n \"contact\": 4,\n \"role\": 1,\n \"cdate\": \"2019-02-25T08:16:56-06:00\",\n \"links\": {\n \"deal\": \"/api/3/contactDeals/1/deal\",\n \"contact\": \"/api/3/contactDeals/1/contact\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The given contact is already associated to the deal\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"source\": {\n \"pointer\": \"/data/attributes/contact\"\n }\n }\n ]\n}","name":"already exists"},{"name":"relation does not exist","status":422,"language":"text","code":"{\n \"errors\": [\n {\n \"title\": \"The related contact does not exist.\",\n \"detail\": \"\",\n \"code\": \"related_missing\",\n \"source\": {\n \"pointer\": \"/data/attributes/contact\"\n }\n }\n ]\n}"},{"status":404,"language":"text","code":"{\n \"message\": \"No Result found for SubscriberDeal with id 100\"\n}"}]},"auth":"required","params":[{"name":"contactDeal.deal","type":"string","enumValues":"","default":"","desc":"Deal's id","required":false,"in":"body","ref":"","_id":"5c741493c09d9a000f05f07c"},{"name":"contactDeal.contact","type":"string","enumValues":"","default":"","desc":"Contact's id","required":false,"in":"body","ref":"","_id":"5c741493c09d9a000f05f07b"},{"name":"id","type":"int","enumValues":"","default":"","desc":"Secondary Contact's id","required":false,"in":"path","ref":"","_id":"5c741593d47363002024c45b"},{"name":"contactDeal.role","type":"int","enumValues":"","default":"","desc":"role id to associate with the contact","required":false,"in":"body","ref":"","_id":"6077a548c315f1006b8215dc"}],"url":"/contactDeals/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-secondary-contact","type":"endpoint","title":"Update a secondary contact","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5c7415cec09d9a000f05f1ff","createdAt":"2019-02-25T16:20:30.343Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5c73fd32e8fdc000572a4c36","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":""}]},"results":{"codes":[{"name":"","code":"{ }","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for SubscriberDeal with id 100\"\n}","language":"json","status":404}]},"auth":"required","params":[{"_id":"5c7415cec09d9a000f05f200","ref":"","in":"path","required":false,"desc":"Secondary Contact's id","default":"","type":"int","name":"id"}],"url":"/contactDeals/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-secondary-contact","type":"endpoint","title":"Delete a secondary contact","isBodyEmpty":false,"children":[]},{"_id":"5c740178419e95004b584f3c","createdAt":"2019-02-25T14:53:44.421Z","category":"58b5ee57e31a610f003a59b5","parentDoc":"5c73fd32e8fdc000572a4c36","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":""}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"contactDeals\": [\n {\n \"deal\": \"2\",\n \"contact\": \"1\",\n \"cdate\": \"2019-02-25T08:16:56-06:00\",\n \"links\": {\n \"deal\": \"/api/3/contactDeals/1/deal\",\n \"contact\": \"/api/3/contactDeals/1/contact\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"/contactDeals","method":"get"},"isReference":true,"order":4,"slug":"list-all-secondary-contacts","type":"endpoint","title":"List all secondary contacts","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5f3376c3b2d74e0030ba3d05","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Deal Roles","type":"basic","slug":"deal-roles","order":6,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"new-create-deal","createdAt":"2020-08-12T04:57:39.801Z","category":"58b5ee57e31a610f003a59b5","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6077a2a31dd3de007b783bfa","api":{"method":"get","url":"/dealRoles","auth":"required","results":{"codes":[{"name":"","code":"{\n \"dealRoles\":[\n {\n \"title\":\"Contributor\",\n \"created_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"updated_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"links\":{\n \"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/2/contactDeals\"\n },\n \"id\":\"2\"\n },\n {\n \"title\":\"Decision Maker\",\n \"created_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"updated_timestamp\":\"2019-09-10T13:01:49-05:00\",\n \"links\":{\n \"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/1/contactDeals\"\n },\n \"id\":\"1\"\n }\n ],\n \"meta\":{\n \"total\":\"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"search","type":"string","enumValues":"","default":"","desc":"(optional string used to search for matching titles)","required":false,"in":"query","ref":"","_id":"6077a38fa7f117002adad4f1"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List all deal roles","type":"endpoint","slug":"list-all-deal-roles","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-15T02:19:15.129Z","parentDoc":"5f3376c3b2d74e0030ba3d05","category":"58b5ee57e31a610f003a59b5","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6077a5ec9f2d50007122f237","api":{"method":"post","url":"/dealRoles","auth":"required","results":{"codes":[{"name":"","code":"{\n \"dealRole\":{\n \"title\":\"Finance\",\n \"created_timestamp\":\"2021-04-14T21:34:55-05:00\",\n \"updated_timestamp\":\"2021-04-14T21:34:55-05:00\",\n \"links\":{\"contactDeals\":\"https://example.activehosted.com/api/3/dealRoles/3/contactDeals\"},\n \"id\":\"3\"\n }\n}\n","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"title","type":"string","enumValues":"","default":"","desc":"Title for the new deal role","required":false,"in":"body","ref":"","_id":"625477eba3d7e600868d872f"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a deal role","type":"endpoint","slug":"create-a-deal-role","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-15T02:33:16.248Z","parentDoc":"5f3376c3b2d74e0030ba3d05","category":"58b5ee57e31a610f003a59b5","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"6077a7100664d70018cce1af","api":{"method":"delete","url":"/dealRoles/:id","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Deal role's id","required":false,"in":"path","ref":"","_id":"622a69584a5d00009130041b"}],"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a deal role","type":"endpoint","slug":"delete-a-deal-role","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-04-15T02:38:08.151Z","parentDoc":"5f3376c3b2d74e0030ba3d05","category":"58b5ee57e31a610f003a59b5","deprecated":false,"isBodyEmpty":true,"children":[]}]}]},{"_id":"5849d43a3bcfb30f00dde73b","__v":0,"createdAt":"2016-12-08T21:44:26.228Z","slug":"deep-data","title":"DeepData Integrations","from_sync":false,"order":12,"project":"57b6f40e480bae1900ce4e21","reference":true,"sync":{"url":"","isSync":false},"version":"57b6f40e480bae1900ce4e24","pages":[{"_id":"584ecf61bc5c7f1b00f039e7","createdAt":"2016-12-12T16:25:05.259Z","isReference":true,"title":"Connections","type":"basic","link_url":"","category":"5849d43a3bcfb30f00dde73b","api":{"params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required","method":"get"},"order":0,"slug":"connections","sync_unique":"","hidden":false,"link_external":false,"parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5898aaa85196950f00e79528","hidden":false,"link_external":false,"type":"endpoint","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"connection\": {\n \"isInternal\": 0,\n \"service\": \"fooCommerce\",\n \"externalid\": \"toystore123\",\n \"name\": \"Toystore, Inc.\",\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-02T14:56:05-06:00\",\n \"links\": {\n \"customers\": \"/connections/1/customers\"\n },\n \"id\": \"1\"\n }\n}","name":""}]},"settings":"","url":"/connections","auth":"required","examples":{"codes":[{"code":"{\n \"connection\": {\n \"service\": \"fooCommerce\",\n \"externalid\": \"toystore123\",\n \"name\": \"Toystore, Inc.\",\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\"\n }\n}","name":"JSON","language":"json"}]},"method":"post","params":[{"name":"connection.service","type":"string","enumValues":"","default":"","desc":"The name of the service.","required":true,"in":"body","ref":"","_id":"5898aaa85196950f00e7952d"},{"name":"connection.externalid","type":"string","enumValues":"","default":"","desc":"The id of the account in the external service.","required":true,"in":"body","ref":"","_id":"5898aaa85196950f00e7952c"},{"name":"connection.name","type":"string","enumValues":"","default":"","desc":"The name associated with the account in the external service. Often this will be a company name (e.g., 'My Toystore, Inc.').","required":true,"in":"body","ref":"","_id":"5898aaa85196950f00e7952b"},{"name":"connection.logoUrl","type":"string","enumValues":"","default":"","desc":"The URL to a logo image for the external service.","required":true,"in":"body","ref":"","_id":"5898aaa85196950f00e7952a"},{"name":"connection.linkUrl","type":"string","enumValues":"","default":"","desc":"The URL to a page where the integration with the external service can be managed in the third-party's website.","required":true,"in":"body","ref":"","_id":"5898aaa85196950f00e79529"}],"apiSetting":"58b53c301065f9c438aa1f77"},"slug":"create-connection","sync_unique":"","link_url":"","parentDoc":"584ecf61bc5c7f1b00f039e7","order":0,"title":"Create a connection","category":"5849d43a3bcfb30f00dde73b","createdAt":"2017-02-06T16:56:08.181Z","isReference":true,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"584ed0d385373a1b00143de3","type":"endpoint","isReference":true,"link_external":false,"slug":"get-connection","order":1,"sync_unique":"","api":{"examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The id of the connection to retrieve","required":false,"in":"path","ref":"","_id":"5894f6dc4d9c7e27002e433c"}],"results":{"codes":[{"name":"","code":"{\n \"connection\": {\n \"isInternal\": 0,\n \"service\": \"fooCommerce\",\n \"externalid\": \"toystore123\",\n \"name\": \"Toystore, Inc.\",\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-02T14:56:05-06:00\",\n \"links\": {\n \"customers\": \"/connections/1/customers\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200},{"language":"json","status":400,"name":"","code":"{}"}]},"settings":"","url":"/connections/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"link_url":"","parentDoc":"584ecf61bc5c7f1b00f039e7","title":"Retrieve a connection","category":"5849d43a3bcfb30f00dde73b","createdAt":"2016-12-12T16:31:15.605Z","hidden":false,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5893902da7a53c3b00299d31","sync_unique":"","api":{"examples":{"codes":[{"name":"JSON","language":"json","code":"{\n \"connection\": {\n \"externalid\": \"johndoe@example.com\",\n \"name\": \"Acme, Inc.\"\n }\n}"}]},"method":"put","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The id of the connection to update","required":false,"in":"path","ref":"","_id":"5894f91a98ca870f00e3f243"},{"name":"connection.service","type":"string","enumValues":"","default":"","desc":"The name of the service.","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db9031"},{"name":"connection.externalid","type":"string","enumValues":"","default":"","desc":"The id of the account in the external service.","required":false,"in":"body","ref":"","_id":"5894f91a98ca870f00e3f242"},{"name":"connection.name","type":"string","enumValues":"","default":"","desc":"The name associated with the account in the external service.","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db9030"},{"name":"connection.logoUrl","type":"string","enumValues":"","default":"","desc":"The URL to a logo image for the third-party service.","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db902f"},{"name":"connection.linkUrl","type":"string","enumValues":"","default":"","desc":"The link to the third-party integrator's site.","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db902e"},{"name":"connection.status","type":"int","enumValues":"","default":"","desc":"The status of the connection (0 = error; 1 = connected)","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db902d"},{"name":"connection.syncStatus","type":"int","enumValues":"","default":"","desc":"The status of a sync triggered on the connection (0 = sync stopped; 1 = sync running).","required":false,"in":"body","ref":"","_id":"5894fc5e3d33222700db902c"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"connection\": {\n \"service\": \"fooCommerce\",\n \"externalid\": \"johndoe@example.com\",\n \"name\": \"Acme, Inc.\",\n \"isInternal\": \"0\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"logoUrl\": \"http://foocorp.net/i/path3523.png\",\n \"linkUrl\": \"http://example.com/\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-03T15:54:51-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/2/customers\"\n },\n \"id\": \"2\"\n }\n}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/connections/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"category":"5849d43a3bcfb30f00dde73b","createdAt":"2017-02-02T20:01:49.532Z","hidden":false,"link_url":"","title":"Update a connection","link_external":false,"order":2,"parentDoc":"584ecf61bc5c7f1b00f039e7","slug":"update-connection","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"584ed0e8a627aa1b0035ca4b","isReference":true,"sync_unique":"","hidden":false,"link_external":false,"parentDoc":"584ecf61bc5c7f1b00f039e7","slug":"delete-connection","type":"endpoint","createdAt":"2016-12-12T16:31:36.840Z","link_url":"","order":3,"api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"_id":"589503423191370f0060dc9d","ref":"","in":"path","required":false,"desc":"The id of the connection to delete.","default":"","type":"string","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/connections/:id","apiSetting":"58b53c301065f9c438aa1f77"},"category":"5849d43a3bcfb30f00dde73b","title":"Delete a connection","isBodyEmpty":true,"children":[]},{"_id":"5893907fa7a53c3b00299d32","order":4,"slug":"list-all-connections","type":"endpoint","createdAt":"2017-02-02T20:03:11.948Z","category":"5849d43a3bcfb30f00dde73b","isReference":true,"title":"List all connections","api":{"settings":"","url":"/connections","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"filters[service]","type":"string","enumValues":"","default":"","desc":"Filter by the external service name.","required":false,"in":"query","ref":"","_id":"589a35ca79a27e1b00dedb42"},{"name":"filters[externalid]","type":"string","enumValues":"","default":"","desc":"Filter by the external id associated with a connection.","required":false,"in":"query","ref":"","_id":"589a3717d775872500985ace"}],"results":{"codes":[{"language":"json","code":"{\n \"connections\": [\n {\n \"service\": \"shopify\",\n \"externalid\": \"foo.myshopify.com\",\n \"name\": \"Foo, Inc.\",\n \"isInternal\": \"1\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"lastSync\": \"2017-02-02T13:09:07-06:00\",\n \"logoUrl\": \"\",\n \"linkUrl\": \"\",\n \"cdate\": \"2017-02-02T13:09:07-06:00\",\n \"udate\": \"2017-02-02T13:09:12-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/1/customers\"\n },\n \"id\": \"1\"\n },\n {\n \"service\": \"fooCommerce\",\n \"externalid\": \"johndoe@example.com\",\n \"name\": \"Acme, Inc.\",\n \"isInternal\": \"0\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"lastSync\": null,\n \"logoUrl\": \"http://example.com/i/foo.png\",\n \"linkUrl\": \"http://example.com/foo/\",\n \"cdate\": \"2017-02-02T14:56:05-06:00\",\n \"udate\": \"2017-02-03T15:54:51-06:00\",\n \"links\": {\n \"customers\": \"/api/3/connections/2/customers\"\n },\n \"id\": \"2\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"link_external":false,"parentDoc":"584ecf61bc5c7f1b00f039e7","sync_unique":"","link_url":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"584ecf5aa627aa1b0035ca48","category":"5849d43a3bcfb30f00dde73b","hidden":false,"sync_unique":"","link_url":"","parentDoc":null,"isReference":true,"link_external":false,"order":1,"slug":"customers","title":"E-Commerce Customers","type":"basic","api":{"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","auth":"required"},"createdAt":"2016-12-12T16:24:58.123Z","isBodyEmpty":false,"children":[{"_id":"584ed58a1cf4bd25005895d1","type":"endpoint","hidden":false,"title":"Create a customer","parentDoc":"584ecf5aa627aa1b0035ca48","api":{"results":{"codes":[{"name":"","code":"{\n \"ecomCustomer\": {\n \"connectionid\": \"1\",\n \"externalid\": \"56789\",\n \"email\": \"alice@example.com\",\n \"links\": {\n \"connection\": \"/api/3/ecomCustomers/1/connection\",\n \"orders\": \"/api/3/ecomCustomers/1/orders\"\n },\n \"id\": \"1\",\n \"connection\": \"1\"\n }\n}","language":"json","status":201},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/ecomCustomers","auth":"required","examples":{"codes":[{"code":"{\n \"ecomCustomer\": {\n \"connectionid\": \"1\",\n \"externalid\": \"56789\",\n \"email\": \"alice@example.com\",\n \"acceptsMarketing\": \"1\"\n }\n}","language":"json","name":"JSON"}]},"method":"post","params":[{"name":"ecomCustomer.connectionid","type":"string","enumValues":"","default":"","desc":"The id of the connection object for the service where the customer originates.","required":true,"in":"body","ref":"","_id":"5898ce6d7c5f330f00910a91"},{"name":"ecomCustomer.externalid","type":"string","enumValues":"","default":"","desc":"The id of the customer in the external service.","required":true,"in":"body","ref":"","_id":"5898ce6d7c5f330f00910a90"},{"name":"ecomCustomer.email","type":"string","enumValues":"","default":"","desc":"The email address of the customer.","required":true,"in":"body","ref":"","_id":"5898d00a7c5f330f00910a96"},{"name":"ecomCustomer.acceptsMarketing","type":"string","enumValues":"","default":"","desc":"Indication of whether customer has opt-ed in to marketing communications. 0 = not opted-in, 1 = opted-in. A value of 0 means the contact will match the \"Has not opted in to marketing\" segment condition and a value of 1 means the contact will match the \"Has opted in to marketing\" segment condition.","required":false,"in":"body","ref":"","_id":"5c82b24cbf3cd30056027375"}],"apiSetting":"58b53c301065f9c438aa1f77"},"category":"5849d43a3bcfb30f00dde73b","createdAt":"2016-12-12T16:51:22.044Z","link_url":"","slug":"create-customer","sync_unique":"","isReference":true,"order":0,"link_external":false,"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"584ed5921cf4bd25005895d2","link_external":false,"parentDoc":"584ecf5aa627aa1b0035ca48","category":"5849d43a3bcfb30f00dde73b","sync_unique":"","title":"Retrieve a customer","createdAt":"2016-12-12T16:51:30.544Z","isReference":true,"link_url":"","slug":"get-customer","hidden":false,"order":1,"type":"endpoint","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomCustomer\": {\n \"connectionid\": \"3\",\n \"externalid\": \"1440117293120\",\n \"email\": \"john.doe@example.com\",\n \"totalRevenue\": \"150761\",\n \"totalOrders\": \"1\",\n \"totalProducts\": \"3\",\n \"avgRevenuePerOrder\": \"150761\",\n \"avgProductCategory\": \"Musical Instrument\",\n \"tstamp\": \"2019-01-01T10:23:22-06:00\",\n \"acceptsMarketing\": \"0\",\n \"links\": {\n \"connection\": \"https://:account.api-us1.com/api/:version/ecomCustomers/15/connection\",\n \"orders\": \"https://:account.api-us1.com/api/:version/ecomCustomers/15/orders\"\n },\n \"id\": \"15\",\n \"connection\": \"3\"\n }\n}","name":null},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/ecomCustomers/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The id of the customer to retrieve","required":false,"in":"path","ref":"","_id":"5898b2de5196950f00e79552"}],"apiSetting":"58b53c301065f9c438aa1f77"},"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"584ed59da627aa1b0035ca5b","createdAt":"2016-12-12T16:51:41.093Z","isReference":true,"order":2,"parentDoc":"584ecf5aa627aa1b0035ca48","slug":"update-customer","hidden":false,"link_external":false,"sync_unique":"","title":"Update a customer","category":"5849d43a3bcfb30f00dde73b","link_url":"","api":{"auth":"required","examples":{"codes":[{"name":"JSON","language":"json","code":"{\n \"ecomCustomer\": {\n \"externalid\": \"98765\"\n }\n}"}]},"method":"put","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The id of the customer to update","required":false,"in":"path","ref":"","_id":"5898b3707c5f330f009109f5"},{"name":"ecomCustomer.externalid","type":"string","enumValues":"","default":"","desc":"The id of the customer in the external service.","required":false,"in":"body","ref":"","_id":"5898edd5372db21b008cb13b"},{"name":"ecomCustomer.connectionid","type":"string","enumValues":"","default":"","desc":"The id of the connection object for the service where the customer originates.","required":false,"in":"body","ref":"","_id":"5898edd5372db21b008cb13a"},{"name":"ecomCustomer.email","type":"string","enumValues":"","default":"","desc":"The email address of the customer.","required":false,"in":"body","ref":"","_id":"5898edd5372db21b008cb139"},{"name":"ecomCustomer.acceptsMarketing","type":"string","enumValues":"","default":"","desc":"Indication of whether customer has opt-ed in to marketing communications. 0 = not opted-in, 1 = opted-in. A value of 0 means the contact will match the \"Has not opted in to marketing\" segment condition and a value of 1 means the contact will match the \"Has opted in to marketing\" segment condition.","required":false,"in":"body","ref":"","_id":"5c82b1e55e2b30001fad973a"}],"results":{"codes":[{"status":200,"name":"","code":"{\n \"ecomCustomer\": {\n \"connectionid\": \"1\",\n \"externalid\": \"98765\",\n \"email\": \"alice@example.com\",\n \"totalRevenue\": \"3280\",\n \"totalOrders\": \"2\",\n \"totalProducts\": \"2\",\n \"avgRevenuePerOrder\": \"2285\",\n \"avgProductCategory\": \"Electronics\",\n \"tstamp\": \"2017-02-06T14:05:31-06:00\",\n \"links\": {\n \"connection\": \"/api/3/ecomCustomers/1/connection\",\n \"orders\": \"/api/3/ecomCustomers/1/orders\"\n },\n \"id\": \"1\",\n \"connection\": \"1\"\n }\n}","language":"json"}]},"settings":"","url":"/ecomCustomers/:id","apiSetting":"58b53c301065f9c438aa1f77"},"type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"584ed5ae85373a1b00143dea","isReference":true,"order":3,"category":"5849d43a3bcfb30f00dde73b","link_url":"","slug":"delete-customer","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"_id":"5898b3305196950f00e79555","ref":"","in":"path","required":false,"desc":"The id of the customer to delete.","default":"","type":"string","name":"id"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/ecomCustomers/:id","apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"link_external":false,"parentDoc":"584ecf5aa627aa1b0035ca48","title":"Delete a customer","type":"endpoint","createdAt":"2016-12-12T16:51:58.166Z","sync_unique":"","isBodyEmpty":true,"children":[]},{"_id":"584ed5c01318690f009c7adf","parentDoc":"584ecf5aa627aa1b0035ca48","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"filters[email]","type":"string","enumValues":"","default":"","desc":"Filter by the email address of a customer.","required":false,"in":"query","ref":"","_id":"589a37a03857222f001e48f9"},{"name":"filters[externalid]","type":"string","enumValues":"","default":"","desc":"Filter by the id of the customer in the external service.","required":false,"in":"query","ref":"","_id":"589a37a03857222f001e48f8"},{"name":"filters[connectionid]","type":"string","enumValues":"","default":"","desc":"Filter by the id of the connection object for the service where the customer originates.","required":false,"in":"query","ref":"","_id":"589a37a03857222f001e48f7"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomCustomers\": [\n {\n \"connectionid\": \"1\",\n \"externalid\": \"56789\",\n \"email\": \"alice@example.com\",\n \"totalRevenue\": \"3280\",\n \"totalOrders\": \"2\",\n \"totalProducts\": \"2\",\n \"avgRevenuePerOrder\": \"2285\",\n \"avgProductCategory\": \"Electronics\",\n \"tstamp\": \"2017-02-06T14:05:31-06:00\",\n \"links\": {\n \"connection\": \"/api/3/ecomCustomers/1/connection\",\n \"orders\": \"/api/3/ecomCustomers/1/orders\"\n },\n \"id\": \"1\",\n \"connection\": \"1\"\n },\n {\n \"connectionid\": \"2\",\n \"externalid\": \"44322\",\n \"email\": \"alice@example.com\",\n \"totalRevenue\": \"7599\",\n \"totalOrders\": \"1\",\n \"totalProducts\": \"1\",\n \"avgRevenuePerOrder\": \"7599\",\n \"avgProductCategory\": \"Books\",\n \"tstamp\": \"2016-12-13T18:02:07-06:00\",\n \"links\": {\n \"connection\": \"/api/3/ecomCustomers/3/connection\",\n \"orders\": \"/api/3/ecomCustomers/3/orders\"\n },\n \"id\": \"3\",\n \"connection\": \"2\"\n },\n {\n \"connectionid\": \"0\",\n \"externalid\": \"0\",\n \"email\": \"alice@example.com\",\n \"totalRevenue\": \"10879\",\n \"totalOrders\": \"3\",\n \"totalProducts\": \"3\",\n \"avgRevenuePerOrder\": \"3626\",\n \"avgProductCategory\": \"Electronics\",\n \"tstamp\": \"2017-02-06T14:05:31-06:00\",\n \"links\": {\n \"connection\": \"/api/3/ecomCustomers/2/connection\",\n \"orders\": \"/api/3/ecomCustomers/2/orders\"\n },\n \"id\": \"2\",\n \"connection\": null\n }\n ],\n \"meta\": {\n \"total\": \"3\"\n }\n}","name":"GET /ecomCustomers (Example RESPONSE)"}]},"settings":"","url":"/ecomCustomers","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2016-12-12T16:52:16.344Z","link_external":false,"link_url":"","order":4,"title":"List all customers","slug":"list-all-customers","sync_unique":"","category":"5849d43a3bcfb30f00dde73b","hidden":false,"isReference":true,"type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5849d44e8c6aef0f00617a47","createdAt":"2016-12-08T21:44:46.399Z","type":"basic","category":"5849d43a3bcfb30f00dde73b","isReference":true,"link_external":false,"parentDoc":null,"slug":"orders","sync_unique":"","api":{"auth":"required","method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":""},"hidden":false,"link_url":"","order":2,"title":"E-Commerce Orders","previousSlug":"","isBodyEmpty":false,"children":[{"_id":"5849d46e0e1b5e0f008540a0","api":{"examples":{"codes":[{"code":"{\n \"ecomOrder\": {\n \"externalid\": \"3246315233\",\n \"source\": \"1\",\n \"email\": \"alice@example.com\",\n \"orderProducts\": [\n {\n \"externalid\": \"PROD12345\",\n \"name\": \"Pogo Stick\",\n \"price\": 4900,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"POGO-12\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product12345\"\n },\n {\n \"externalid\": \"PROD23456\",\n \"name\": \"Skateboard\",\n \"price\": 3000,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"SK8BOARD145\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product45678\"\n }\n ],\n \"orderDiscounts\": [\n {\n \"name\": \"1OFF\",\n \"type\": \"order\",\n \"discountAmount\": 100\n }\n ],\n \"orderUrl\": \"https://example.com/orders/3246315233\",\n \"externalCreatedDate\": \"2016-09-13T17:41:39-04:00\",\n \"externalUpdatedDate\": \"2016-09-14T17:41:39-04:00\",\n \"shippingMethod\": \"UPS Ground\",\n \"totalPrice\": 9111,\n \"shippingAmount\": 200,\n \"taxAmount\": 500,\n \"discountAmount\": 100,\n \"currency\": \"USD\",\n \"orderNumber\": \"myorder-123\",\n \"connectionid\": \"1\",\n \"customerid\": \"1\"\n }\n}","language":"json"}]},"method":"post","params":[{"name":"ecomOrder.externalid","type":"string","enumValues":"","default":"","desc":"The id of the order in the external service. ONLY REQUIRED IF EXTERNALCHECKOUTID NOT INCLUDED.","required":true,"in":"body","ref":"","_id":"5899ffc479a27e1b00deda56"},{"name":"ecomOrder.externalcheckoutid","type":"string","enumValues":"","default":"","desc":"The id of the cart in the external service. ONLY REQUIRED IF EXTERNALID IS NOT INCLUDED.","required":true,"in":"body","ref":"","_id":"5d714a4a6ddc62059a355523"},{"name":"ecomOrder.source","type":"int","enumValues":"","default":"","desc":"The order source code. 0 - historical, 1 - real-time. Only real-time orders (source = 1) will show up on your Ecommerce Dashboard and trigger the “Makes a purchase” automation start, abandoned cart actions, customer conversions, or revenue attributions.","required":true,"in":"body","ref":"","_id":"5942c1c4b442cb002fb7b6d3"},{"name":"ecomOrder.email","type":"string","enumValues":"","default":"","desc":"The email address of the customer who placed the order.","required":true,"in":"body","ref":"","_id":"5899ffc479a27e1b00deda55"},{"name":"ecomOrder.orderProducts","type":"array_object","enumValues":"","default":"","desc":"An array of EcomOrderProducts.","required":false,"in":"body","ref":"EcomOrderProduct","_id":"5d715216f94cfa0034983c3c"},{"name":"ecomOrder.orderProducts.name","type":"string","enumValues":"","default":"","desc":"The name of the product","required":true,"in":"body","ref":"","_id":"589a03c3e94a202500fa2ddd"},{"name":"ecomOrder.orderProducts.price","type":"int","enumValues":"","default":"","desc":"The price of the product, in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":true,"in":"body","ref":"","_id":"589a04f479a27e1b00deda75"},{"name":"ecomOrder.orderProducts.quantity","type":"int","enumValues":"","default":"","desc":"The quantity ordered.","required":true,"in":"body","ref":"","_id":"589a03c3e94a202500fa2ddc"},{"name":"ecomOrder.orderProducts.externalid","type":"string","enumValues":"","default":"","desc":"The id of the product in the external service.","required":true,"in":"body","ref":"","_id":"589a04f479a27e1b00deda74"},{"name":"ecomOrder.orderProducts.category","type":"string","enumValues":"","default":"","desc":"The category of the product.","required":false,"in":"body","ref":"","_id":"5aaa949f9765de0081c92c91"},{"name":"ecomOrder.orderProducts.sku","type":"string","enumValues":"","default":"","desc":"The SKU for the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313d"},{"name":"ecomOrder.orderProducts.description","type":"string","enumValues":"","default":"","desc":"The description of the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313c"},{"name":"ecomOrder.orderProducts.imageUrl","type":"string","enumValues":"","default":"","desc":"An Image URL that displays an image of the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313b"},{"name":"ecomOrder.orderProducts.productUrl","type":"string","enumValues":"","default":"","desc":"A URL linking to the product in your store","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313a"},{"name":"ecomOrder.totalPrice","type":"int","enumValues":"","default":"","desc":"The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":true,"in":"body","ref":"","_id":"589a01a4d7758725009859ca"},{"name":"ecomOrder.shippingAmount","type":"int","enumValues":"","default":"","desc":"The total shipping amount in cents for the order","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03139"},{"name":"ecomOrder.taxAmount","type":"int","enumValues":"","default":"","desc":"The total tax amount for the order in cents","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03138"},{"name":"ecomOrder.discountAmount","type":"int","enumValues":"","default":"","desc":"The total discount amount for the order in cents","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03137"},{"name":"ecomOrder.currency","type":"string","enumValues":"","default":"","desc":"The currency of the order (3-digit ISO code, e.g., 'USD').","required":true,"in":"body","ref":"","_id":"589a01a4d7758725009859c9"},{"name":"ecomOrder.connectionid","type":"int","enumValues":"","default":"","desc":"The id of the connection from which this order originated.","required":true,"in":"body","ref":"","_id":"589a01a4d7758725009859c8"},{"name":"ecomOrder.customerid","type":"int","enumValues":"","default":"","desc":"The id of the customer associated with this order.","required":true,"in":"body","ref":"","_id":"589a01a4d7758725009859c7"},{"name":"ecomOrder.orderUrl","type":"string","enumValues":"","default":"","desc":"The URL for the order in the external service.","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859cd"},{"name":"ecomOrder.externalCreatedDate","type":"datetime","enumValues":"","default":"","desc":"The date the order was placed.","required":true,"in":"body","ref":"","_id":"589a01a4d7758725009859cc"},{"name":"ecomOrder.externalUpdatedDate","type":"string","enumValues":"","default":"","desc":"The date the order was updated.","required":false,"in":"body","ref":"","_id":"5d714b7a268deb0275e6cc9d"},{"name":"ecomOrder.abandonedDate","type":"string","enumValues":"","default":"","desc":"The date the cart was abandoned. REQUIRED ONLY IF INCLUDING EXTERNALCHECKOUTID.","required":true,"in":"body","ref":"","_id":"5d714b7a268deb0275e6cc9c"},{"name":"ecomOrder.shippingMethod","type":"string","enumValues":"","default":"","desc":"The shipping method of the order.","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859cb"},{"name":"ecomOrder.orderNumber","type":"string","enumValues":"","default":"","desc":"The order number. This can be different than the externalid.","required":false,"in":"body","ref":"","_id":"5d715c9228249400375b4036"},{"name":"ecomOrder.orderDiscounts","type":"array_object","enumValues":"","default":"","desc":"Array of discounts for the order","required":false,"in":"body","ref":"","_id":"5e21e732a7f6441c0a17ef02"},{"name":"ecomOrder.orderDiscounts.name","type":"string","enumValues":"","default":"","desc":"The discount code or name of the discount","required":false,"in":"body","ref":"","_id":"5e21e732a7f6441c0a17ef01"},{"name":"ecomOrder.orderDiscounts.type","type":"string","enumValues":"","default":"","desc":"The type of discount, either 'order' for discount on the order, or 'shipping' for free shipping.","required":false,"in":"body","ref":"","_id":"5e21e732a7f6441c0a17ef00"},{"name":"ecomOrder.orderDiscounts.discountAmount","type":"int","enumValues":"","default":"","desc":"The amount of the discount in cents.","required":false,"in":"body","ref":"","_id":"5e21e732a7f6441c0a17eeff"}],"results":{"codes":[{"language":"json","code":"{\n \"connections\": [\n {\n \"service\": \"example\",\n \"externalid\": \"examplestore\",\n \"name\": \"My Example Store\",\n \"isInternal\": \"0\",\n \"connectionType\": \"ecommerce\",\n \"status\": \"1\",\n \"syncStatus\": \"0\",\n \"sync_request_time\": null,\n \"sync_start_time\": null,\n \"lastSync\": null,\n \"logoUrl\": \"https://myexamplestore.com/images/logo.jpg\",\n \"linkUrl\": \"https://myexamplestore.com\",\n \"cdate\": \"2018-01-12T13:13:53-06:00\",\n \"udate\": \"2018-01-12T13:13:53-06:00\",\n \"credentialExpiration\": null,\n \"links\": {\n \"options\": \"https://exampleaccount.api-us1.com/api/3/connections/1/options\",\n \"customers\": \"https://exampleaccount.api-us1.com.api-us1.com/api/3/connections/1/customers\"\n },\n \"id\": \"1\",\n \"serviceName\": \"shopify\"\n }\n ],\n \"ecomOrderProducts\": [\n {\n \"externalid\": \"PROD12345\",\n \"name\": \"Pogo Stick\",\n \"price\": 4900,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"POGO-12\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product12345\"\n },\n {\n \"externalid\": \"PROD23456\",\n \"name\": \"Skateboard\",\n \"price\": 3000,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"SK8BOARD145\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product45678\"\n }\n ],\n \"ecomOrderDiscounts\": [\n {\n \"name\": \"1OFF\",\n \"type\": \"order\",\n \"orderid\": \"5355\",\n \"discountAmount\": \"100\",\n \"id\": \"1\",\n \"createdDate\": \"2019-09-05T12:16:18-05:00\",\n \"updatedDate\": \"2019-09-05T12:16:18-05:00\"\n }\n ],\n \"ecomOrder\": {\n \"externalid\": \"3246315234\",\n \"source\": \"1\",\n \"email\": \"alice@example.com\",\n \"currency\": \"USD\",\n \"connectionid\": \"1\",\n \"customerid\": \"1\",\n \"orderUrl\": \"https://example.com/orders/3246315233\",\n \"shippingMethod\": \"UPS Ground\",\n \"totalPrice\": 9111,\n \"shippingAmount\": 200,\n \"taxAmount\": 500,\n \"discountAmount\": 100,\n \"externalCreatedDate\": \"2016-09-13T16:41:39-05:00\",\n \"totalProducts\": 2,\n \"createdDate\": \"2019-09-05T12:16:18-05:00\",\n \"updatedDate\": \"2019-09-05T12:16:18-05:00\",\n \"state\": 1,\n \"connection\": \"1\",\n \"orderProducts\": [\n \"1\",\n \"2\"\n ],\n \"orderDiscounts\": [\n \"1\"\n ],\n \"customer\": \"1\",\n \"orderDate\": \"2016-09-13T16:41:39-05:00\",\n \"tstamp\": \"2019-09-05T12:16:18-05:00\",\n \"links\": {\n \"connection\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/connection\",\n \"customer\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/customer\",\n \"orderProducts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderProducts\",\n \"orderDiscounts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts\",\n \"orderActivities\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderActivities\"\n },\n \"id\": \"1\"\n }\n}","name":"","status":201}]},"settings":"","url":"/ecomOrders","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2016-12-08T21:45:18.832Z","hidden":false,"link_external":false,"parentDoc":"5849d44e8c6aef0f00617a47","sync_unique":"","category":"5849d43a3bcfb30f00dde73b","isReference":true,"order":0,"title":"Create an order","type":"endpoint","link_url":"","slug":"create-order","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"584b1150b1174525005ecfef","hidden":false,"link_url":"","parentDoc":"5849d44e8c6aef0f00617a47","sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomOrder\": {\n \"customerid\": \"1\",\n \"connectionid\": \"1\",\n \"state\": \"1\",\n \"source\": \"1\",\n \"externalid\": \"1233456789\",\n \"externalcheckoutid\": null,\n \"orderNumber\": \"123456789\",\n \"email\": \"alice@example.com\",\n \"totalPrice\": \"1000\",\n \"discountAmount\": \"100\",\n \"shippingAmount\": \"120\",\n \"taxAmount\": \"120\",\n \"totalProducts\": \"1\",\n \"currency\": \"usd\",\n \"shippingMethod\": \"ground shipping\",\n \"orderUrl\": \"https://examplestore.com/orders/123456789\",\n \"externalCreatedDate\": \"2019-06-29T14:44:49-05:00\",\n \"externalUpdatedDate\": \"2019-06-29T14:44:49-05:00\",\n \"abandonedDate\": null,\n \"createdDate\": \"2019-06-29T14:44:51-05:00\",\n \"updatedDate\": \"2019-06-29T14:44:51-05:00\",\n \"orderDate\": \"2019-06-29T14:44:49-05:00\",\n \"tstamp\": \"2019-06-29T14:44:51-05:00\",\n \"links\": {\n \"connection\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/connection\",\n \"customer\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/customer\",\n \"orderProducts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderProducts\",\n \"orderDiscounts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts\",\n \"orderActivities\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderActivities\"\n },\n \"id\": \"1\",\n \"connection\": \"1\",\n \"customer\": \"1\"\n }\n}","name":""}]},"settings":"","url":"/ecomOrders/:ecomOrderId","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"ecomOrderId","type":"int","enumValues":"","default":"","desc":"The id of the order to retrieve.","required":false,"in":"path","ref":"","_id":"584b30e796f59f0f006157ba"}],"apiSetting":"58b53c301065f9c438aa1f77"},"link_external":false,"title":"Retrieve an order","createdAt":"2016-12-09T20:17:20.803Z","isReference":true,"slug":"get-order","category":"5849d43a3bcfb30f00dde73b","order":1,"type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d715b7a567d330037a39e75","createdAt":"2019-09-05T19:01:14.060Z","parentDoc":"5849d44e8c6aef0f00617a47","category":"5849d43a3bcfb30f00dde73b","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","settings":"","results":{"codes":[{"status":200,"name":"","code":"{\n \"ecomOrderProducts\": [\n {\n \"orderid\": \"1\",\n \"connectionid\": \"1\",\n \"externalid\": \"PROD12345\",\n \"sku\": \"POGO-12\",\n \"name\": \"Pogo Stick\",\n \"description\": \"lorem ipsum...\",\n \"price\": \"4900\",\n \"quantity\": \"1\",\n \"category\": \"Toys\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product12345\",\n \"createdDate\": \"2019-09-05T13:55:37-05:00\",\n \"updatedDate\": \"2019-09-05T13:55:37-05:00\",\n \"tstamp\": \"2019-09-05T13:55:37-05:00\",\n \"links\": {\n \"ecomOrder\": \"https://youraccounthere.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder\"\n },\n \"id\": \"3\",\n \"ecomOrder\": \"1\"\n },\n {\n \"orderid\": \"1\",\n \"connectionid\": \"1\",\n \"externalid\": \"PROD23456\",\n \"sku\": \"SK8BOARD145\",\n \"name\": \"Skateboard\",\n \"description\": \"lorem ipsum...\",\n \"price\": \"3000\",\n \"quantity\": \"1\",\n \"category\": \"Toys\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product45678\",\n \"createdDate\": \"2019-09-05T13:55:37-05:00\",\n \"updatedDate\": \"2019-09-05T13:55:37-05:00\",\n \"tstamp\": \"2019-09-05T13:55:37-05:00\",\n \"links\": {\n \"ecomOrder\": \"https://youraccounthere.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder\"\n },\n \"id\": \"4\",\n \"ecomOrder\": \"1\"\n }\n ],\n \"ecomOrderDiscounts\": [\n {\n \"name\": \"1OFF\",\n \"type\": \"order\",\n \"orderid\": \"5355\",\n \"discountAmount\": \"100\",\n \"id\": \"1\",\n \"createdDate\": \"2019-09-05T12:16:18-05:00\",\n \"updatedDate\": \"2019-09-05T12:16:18-05:00\"\n }\n ],\n \"ecomOrder\": {\n \"customerid\": \"1\",\n \"connectionid\": \"1\",\n \"state\": \"1\",\n \"source\": \"1\",\n \"externalid\": \"3246315237\",\n \"orderNumber\": \"\",\n \"email\": \"alice@example.com\",\n \"totalPrice\": 9111,\n \"discountAmount\": 100,\n \"shippingAmount\": 200,\n \"taxAmount\": 500,\n \"totalProducts\": 2,\n \"currency\": \"USD\",\n \"shippingMethod\": \"UPS Ground\",\n \"orderUrl\": \"https://example.com/orders/3246315233\",\n \"externalCreatedDate\": \"2016-09-13T16:41:39-05:00\",\n \"externalUpdatedDate\": \"2016-09-15T16:41:39-05:00\",\n \"createdDate\": \"2019-09-05T12:52:13-05:00\",\n \"updatedDate\": \"2019-09-05T13:55:37-05:00\",\n \"orderProducts\": [\n \"3\",\n \"4\"\n ],\n \"orderDiscounts\": [\n \"1\"\n ],\n \"customer\": \"1\",\n \"orderDate\": \"2016-09-13T16:41:39-05:00\",\n \"tstamp\": \"2019-09-05T13:55:37-05:00\",\n \"links\": {\n \"connection\": \"https://youraccounthere.api-us1.com/api/3/ecomOrders/1/connection\",\n \"customer\": \"https://youraccounthere.api-us1.com/api/3/ecomOrders/1/customer\",\n \"orderProducts\": \"https://youraccounthere.api-us1.com/api/3/ecomOrders/1/orderProducts\",\n \"orderDiscounts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts\",\n \"orderActivities\": \"https://youraccounthere.api-us1.com/api/3/ecomOrders/1/orderActivities\"\n },\n \"id\": \"1\",\n \"connection\": \"1\"\n }\n}","language":"json"}]},"examples":{"codes":[{"language":"json","code":"{\n \"ecomOrder\": {\n \"externalid\": \"3246315237\",\n \"email\": \"alice@example.com\",\n \"orderProducts\": [\n {\n \"externalid\": \"PROD12345\",\n \"name\": \"Pogo Stick\",\n \"price\": 4900,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"POGO-12\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product12345\"\n },\n {\n \"externalid\": \"PROD23456\",\n \"name\": \"Skateboard\",\n \"price\": 3000,\n \"quantity\": 1,\n \"category\": \"Toys\",\n \"sku\": \"SK8BOARD145\",\n \"description\": \"lorem ipsum...\",\n \"imageUrl\": \"https://example.com/product.jpg\",\n \"productUrl\": \"https://store.example.com/product45678\"\n }\n ],\n \"orderDiscounts\": [\n {\n \"name\": \"1OFF\",\n \"type\": \"order\",\n \"discountAmount\": 100\n }\n ],\n \"externalUpdatedDate\": \"2016-09-15T17:41:39-04:00\",\n \"shippingMethod\": \"UPS Ground\",\n \"totalPrice\": 9111,\n \"shippingAmount\": 200,\n \"taxAmount\": 500,\n \"discountAmount\": 100,\n \"currency\": \"USD\",\n \"orderNumber\":\"12345-1\"\n }\n}"}]},"auth":"required","params":[{"name":"ecomOrder.externalid","type":"string","enumValues":"","default":"","desc":"The id of the order in the external service. ONLY REQUIRED IF EXTERNALCHECKOUTID NOT INCLUDED.","required":false,"in":"body","ref":"","_id":"5899ffc479a27e1b00deda56"},{"name":"ecomOrder.externalcheckoutid","type":"string","enumValues":"","default":"","desc":"The id of the cart in the external service. ONLY REQUIRED IF EXTERNALID IS NOT INCLUDED.","required":false,"in":"body","ref":"","_id":"5d714a4a6ddc62059a355523"},{"name":"ecomOrder.email","type":"string","enumValues":"","default":"","desc":"The email address of the customer who placed the order.","required":false,"in":"body","ref":"","_id":"5899ffc479a27e1b00deda55"},{"name":"ecomOrder.orderProducts","type":"array_object","enumValues":"","default":"","desc":"An array of EcomOrderProducts.","required":false,"in":"body","ref":"EcomOrderProduct","_id":"5d715216f94cfa0034983c3c"},{"name":"ecomOrder.orderProducts.name","type":"string","enumValues":"","default":"","desc":"The name of the product","required":false,"in":"body","ref":"","_id":"589a03c3e94a202500fa2ddd"},{"name":"ecomOrder.orderProducts.price","type":"int","enumValues":"","default":"","desc":"The price of the product, in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":false,"in":"body","ref":"","_id":"589a04f479a27e1b00deda75"},{"name":"ecomOrder.orderProducts.quantity","type":"int","enumValues":"","default":"","desc":"The quantity ordered.","required":false,"in":"body","ref":"","_id":"589a03c3e94a202500fa2ddc"},{"name":"ecomOrder.orderProducts.externalid","type":"string","enumValues":"","default":"","desc":"The id of the product in the external service.","required":false,"in":"body","ref":"","_id":"589a04f479a27e1b00deda74"},{"name":"ecomOrder.orderProducts.category","type":"string","enumValues":"","default":"","desc":"The category of the product.","required":false,"in":"body","ref":"","_id":"5aaa949f9765de0081c92c91"},{"name":"ecomOrder.orderProducts.sku","type":"string","enumValues":"","default":"","desc":"The SKU for the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313d"},{"name":"ecomOrder.orderProducts.description","type":"string","enumValues":"","default":"","desc":"The description of the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313c"},{"name":"ecomOrder.orderProducts.imageUrl","type":"string","enumValues":"","default":"","desc":"An Image URL that displays an image of the product","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313b"},{"name":"ecomOrder.orderProducts.productUrl","type":"string","enumValues":"","default":"","desc":"A URL linking to the product in your store","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b0313a"},{"name":"ecomOrder.totalPrice","type":"int","enumValues":"","default":"","desc":"The total price of the order in cents, including tax and shipping charges. (i.e. $456.78 => 45678). Must be greater than or equal to zero.","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859ca"},{"name":"ecomOrder.shippingAmount","type":"int","enumValues":"","default":"","desc":"The total shipping amount in cents for the order","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03139"},{"name":"ecomOrder.taxAmount","type":"int","enumValues":"","default":"","desc":"The total tax amount for the order in cents","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03138"},{"name":"ecomOrder.discountAmount","type":"int","enumValues":"","default":"","desc":"The total discount amount for the order in cents","required":false,"in":"body","ref":"","_id":"5d7145333b1bdc0044b03137"},{"name":"ecomOrder.currency","type":"string","enumValues":"","default":"","desc":"The currency of the order (3-digit ISO code, e.g., 'USD').","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859c9"},{"name":"ecomOrder.orderUrl","type":"string","enumValues":"","default":"","desc":"The URL for the order in the external service.","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859cd"},{"name":"ecomOrder.externalUpdatedDate","type":"string","enumValues":"","default":"","desc":"The date the order was updated.","required":false,"in":"body","ref":"","_id":"5d714b7a268deb0275e6cc9d"},{"name":"ecomOrder.abandonedDate","type":"string","enumValues":"","default":"","desc":"The date the cart was abandoned. REQUIRED ONLY IF INCLUDING EXTERNALCHECKOUTID.","required":false,"in":"body","ref":"","_id":"5d714b7a268deb0275e6cc9c"},{"name":"ecomOrder.shippingMethod","type":"string","enumValues":"","default":"","desc":"The shipping method of the order.","required":false,"in":"body","ref":"","_id":"589a01a4d7758725009859cb"},{"name":"ecomOrder.orderNumber","type":"string","enumValues":"","default":"","desc":"The order number in your system. This can be different than the external ID.","required":false,"in":"body","ref":"","_id":"5d715c66a627c5002525f008"},{"name":"id","type":"string","enumValues":"","default":"","desc":"The ID of the order to update","required":false,"in":"path","ref":"","_id":"5d716be71289f50029e7f69c"},{"name":"ecomOrder.orderDiscounts","type":"array_object","enumValues":"","default":"","desc":"Array of discounts for the order","required":false,"in":"body","ref":"","_id":"5e21ea73c3ee01006aa8cd73"},{"name":"ecomOrder.orderDiscounts.name","type":"string","enumValues":"","default":"","desc":"The discount code or name of the discount","required":false,"in":"body","ref":"","_id":"5e21ea73c3ee01006aa8cd72"},{"name":"ecomOrder.orderDiscounts.type","type":"string","enumValues":"","default":"","desc":"The type of discount, either 'order' for discount on the order, or 'shipping' for free shipping.","required":false,"in":"body","ref":"","_id":"5e21ea73c3ee01006aa8cd71"},{"name":"ecomOrder.orderDiscounts.discountAmount","type":"string","enumValues":"","default":"","desc":"The amount of the discount in cents.","required":false,"in":"body","ref":"","_id":"5e21ea73c3ee01006aa8cd70"}],"url":"/ecomOrders/:id","method":"put"},"isReference":true,"order":2,"slug":"update-order","type":"endpoint","title":"Update an order","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"584b30b6e3c3141b00b4481c","sync_unique":"","isReference":true,"link_external":false,"order":3,"slug":"delete-order","title":"Delete an order","createdAt":"2016-12-09T22:31:18.058Z","hidden":false,"type":"endpoint","api":{"method":"delete","params":[{"name":"ecomOrderId","type":"int","enumValues":"","default":"","desc":"The id of the order to delete.","required":false,"in":"path","ref":"","_id":"584b30d6e5f3a42300df6eeb"}],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""}]},"settings":"","url":"/ecomOrders/:ecomOrderId","auth":"required","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"category":"5849d43a3bcfb30f00dde73b","link_url":"","parentDoc":"5849d44e8c6aef0f00617a47","deprecated":false,"previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"584b03ebbcecc91b0062eb8c","category":"5849d43a3bcfb30f00dde73b","parentDoc":"5849d44e8c6aef0f00617a47","createdAt":"2016-12-09T19:20:11.551Z","link_url":"","order":4,"slug":"list-all-orders","api":{"method":"get","params":[{"name":"filters[connectionid]","type":"int","enumValues":"","default":"","desc":"Filter by the connection id. Must be greater than 0.","required":false,"in":"query","ref":"","_id":"584b047dd1ce5b0f004382d5"},{"name":"filters[externalid]","type":"int","enumValues":"","default":"","desc":"Filter by the external id of the order.","required":false,"in":"query","ref":"","_id":"584b047dd1ce5b0f004382d4"},{"name":"filters[externalcheckoutid]","type":"string","enumValues":"","default":"","desc":"Filter by the external checkout id","required":false,"in":"query","ref":"","_id":"5d716a60d7bddc00130ec72a"},{"name":"filters[email]","type":"string","enumValues":"","default":"","desc":"Filter by the customer email address.","required":false,"in":"query","ref":"","_id":"584ec5821318690f009c7abe"},{"name":"filters[state]","type":"int","enumValues":"","default":"","desc":"Filter by the state of the order. 0 = Pending, 1 = Completed, 2 = Abandoned, 3 = Recovered, 4 = Waiting (Customer checked out but payment is not yet completed)","required":false,"in":"query","ref":"","_id":"5d716a60d7bddc00130ec729"},{"name":"filters[customerid]","type":"string","enumValues":"","default":"","desc":"Filter by the customer id","required":false,"in":"query","ref":"","_id":"5d716a60d7bddc00130ec728"},{"name":"filters[external_created_date]","type":"datetime","enumValues":"","default":"","desc":"Filter by the external created date","required":false,"in":"query","ref":"","_id":"5d716a60d7bddc00130ec727"},{"name":"orders[connectionid]","type":"int","enumValues":"","default":"","desc":"Order by connection ID. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffd4"},{"name":"orders[externalid]","type":"int","enumValues":"","default":"","desc":"Order by external ID. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffd3"},{"name":"orders[externalcheckoutid]","type":"string","enumValues":"","default":"","desc":"Order by external checkout ID. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffd2"},{"name":"orders[email]","type":"string","enumValues":"","default":"","desc":"Order by email. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffd1"},{"name":"orders[state]","type":"int","enumValues":"","default":"","desc":"Order by state. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffd0"},{"name":"orders[customerid]","type":"string","enumValues":"","default":"","desc":"Order by customer ID. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffcf"},{"name":"orders[external_created_date]","type":"datetime","enumValues":"","default":"","desc":"Order by external created date. Accepted values are ASC or DESC.","required":false,"in":"query","ref":"","_id":"5d850d92734d3200637cffce"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomOrders\": [\n {\n \"externalid\": \"3246315234\",\n \"source\": \"1\",\n \"email\": \"alice@example.com\",\n \"currency\": \"USD\",\n \"connectionid\": \"1\",\n \"customerid\": \"1\",\n \"orderUrl\": \"https://example.com/orders/3246315233\",\n \"shippingMethod\": \"UPS Ground\",\n \"totalPrice\": 9111,\n \"shippingAmount\": 200,\n \"taxAmount\": 500,\n \"discountAmount\": 100,\n \"externalCreatedDate\": \"2016-09-13T16:41:39-05:00\",\n \"totalProducts\": 2,\n \"createdDate\": \"2019-09-05T12:16:18-05:00\",\n \"updatedDate\": \"2019-09-05T12:16:18-05:00\",\n \"state\": 1,\n \"connection\": \"1\",\n \"orderProducts\": [\n \"1\",\n \"2\"\n ],\n \"customer\": \"1\",\n \"orderDate\": \"2016-09-13T16:41:39-05:00\",\n \"tstamp\": \"2019-09-05T12:16:18-05:00\",\n \"links\": {\n \"connection\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/connection\",\n \"customer\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/customer\",\n \"orderProducts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderProducts\",\n \"orderDiscounts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderDiscounts\",\n \"orderActivities\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/1/orderActivities\"\n },\n \"id\": \"1\"\n },\n {\n \"externalid\": \"47856739866\",\n \"source\": \"1\",\n \"email\": \"example@example.com\",\n \"currency\": \"USD\",\n \"connectionid\": \"1\",\n \"customerid\": \"2\",\n \"orderUrl\": \"https://example.com/orders/47856739866\",\n \"shippingMethod\": \"UPS Ground\",\n \"totalPrice\": 3450,\n \"shippingAmount\": 100,\n \"taxAmount\": 0,\n \"discountAmount\": 0,\n \"externalCreatedDate\": \"2019-09-06T2:10:00-05:00\",\n \"totalProducts\": 2,\n \"createdDate\": \"2019-09-06T2:10:00-05:00\",\n \"updatedDate\": \"2019-09-06T2:10:00-05:00\",\n \"state\": 1,\n \"connection\": \"1\",\n \"orderProducts\": [\n \"3\"\n ],\n \"customer\": \"2\",\n \"orderDate\": \"2019-09-06T2:10:00-05:00\",\n \"tstamp\": \"2019-09-06T2:10:00-05:00\",\n \"links\": {\n \"connection\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/2/connection\",\n \"customer\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/2/customer\",\n \"orderProducts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderProducts\",\n \"orderDiscounts\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderDiscounts\",\n \"orderActivities\": \"https://exampleaccount.api-us1.com/api/3/ecomOrders/2/orderActivities\"\n },\n \"id\": \"2\"\n },\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","name":""},{"status":422,"language":"json","code":"{}","name":""}]},"settings":"","url":"/ecomOrders","auth":"required","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"type":"endpoint","hidden":false,"isReference":true,"link_external":false,"sync_unique":"","title":"List all orders","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5b804afc2ff2bf00034428cb","category":"5849d43a3bcfb30f00dde73b","createdAt":"2018-08-24T18:14:20.775Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":3,"slug":"e-commerce-abandoned-carts","type":"basic","title":"E-Commerce Abandoned Carts","parentDoc":null,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d716dc0a5fedf00181519b6","createdAt":"2019-09-05T20:19:12.305Z","category":"5849d43a3bcfb30f00dde73b","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":4,"slug":"e-commerce-order-products","type":"basic","title":"E-Commerce Order Products","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5d716e9347c96700358d5b75","createdAt":"2019-09-05T20:22:43.290Z","parentDoc":"5d716dc0a5fedf00181519b6","category":"5849d43a3bcfb30f00dde73b","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomOrderProducts\": [\n {\n \"orderid\": \"1\",\n \"connectionid\": \"1\",\n \"externalid\": \"1269385775\",\n \"sku\": \"SKATE-8\",\n \"name\": \"My Cool Skateboard\",\n \"description\": \"This skateboard is so cool, it rides itself\",\n \"price\": \"5000\",\n \"quantity\": \"1\",\n \"category\": \"skateboards\",\n \"imageUrl\": \"https://example.com/images/skateboard.jpg\",\n \"productUrl\": \"http://example.com/products/skate-8\",\n \"createdDate\": \"2019-06-28T18:04:19-05:00\",\n \"updatedDate\": \"2019-06-28T18:04:19-05:00\",\n \"tstamp\": \"2019-06-28T18:04:19-05:00\",\n \"links\": {\n \"ecomOrder\": \"https://commissiontheatre.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder\"\n },\n \"id\": \"1\",\n \"ecomOrder\": \"2\"\n }\n ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[],"url":"/ecomOrderProducts","method":"get"},"isReference":true,"order":0,"slug":"list-ecomorderproducts","type":"endpoint","title":"List EcomOrderProducts","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d716e3d2ed60c0056f60bef","createdAt":"2019-09-05T20:21:17.937Z","parentDoc":"5d716dc0a5fedf00181519b6","category":"5849d43a3bcfb30f00dde73b","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomOrderProducts\": [\n {\n \"orderid\": \"1\",\n \"connectionid\": \"1\",\n \"externalid\": \"1269385775\",\n \"sku\": \"SKATE-8\",\n \"name\": \"My Cool Skateboard\",\n \"description\": \"This skateboard is so cool, it rides itself\",\n \"price\": \"5000\",\n \"quantity\": \"1\",\n \"category\": \"skateboards\",\n \"imageUrl\": \"https://example.com/images/skateboard.jpg\",\n \"productUrl\": \"http://example.com/products/skate-8\",\n \"createdDate\": \"2019-06-28T18:04:19-05:00\",\n \"updatedDate\": \"2019-06-28T18:04:19-05:00\",\n \"tstamp\": \"2019-06-28T18:04:19-05:00\",\n \"links\": {\n \"ecomOrder\": \"https://commissiontheatre.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder\"\n },\n \"id\": \"1\",\n \"ecomOrder\": \"2\"\n }\n ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The ID of the order whose products you'd like returned.","required":false,"in":"path","ref":"","_id":"5d716e3d2ed60c0056f60bf0"}],"url":"/ecomOrders/:id/orderProducts","method":"get"},"isReference":true,"order":1,"slug":"list-products-for-order","type":"endpoint","title":"List EcomOrderProducts for a Specific EcomOrder","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5d716ef30d129e0066bbfafe","createdAt":"2019-09-05T20:24:19.026Z","parentDoc":"5d716dc0a5fedf00181519b6","category":"5849d43a3bcfb30f00dde73b","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"ecomOrderProduct\": {\n \"orderid\": \"1\",\n \"connectionid\": \"1\",\n \"externalid\": \"1269385775\",\n \"sku\": \"SKATE-8\",\n \"name\": \"My Cool Skateboard\",\n \"description\": \"This skateboard is so cool, it rides itself\",\n \"price\": \"5000\",\n \"quantity\": \"1\",\n \"category\": \"skateboards\",\n \"imageUrl\": \"https://example.com/images/skateboard.jpg\",\n \"productUrl\": \"http://example.com/products/skate-8\",\n \"createdDate\": \"2019-06-28T18:04:19-05:00\",\n \"updatedDate\": \"2019-06-28T18:04:19-05:00\",\n \"tstamp\": \"2019-06-28T18:04:19-05:00\",\n \"links\": {\n \"ecomOrder\": \"https://commissiontheatre.api-us1.com/api/3/ecomOrderProducts/1/ecomOrder\"\n },\n \"id\": \"1\",\n \"ecomOrder\": \"2\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""},{"status":404,"language":"text","code":"{\n \"message\": \"No Result found for EcomOrderProduct with id {the id requested}\"\n}"}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"The ID of the product you'd like returned.","required":false,"in":"path","ref":"","_id":"5d716ef30d129e0066bbfaff"}],"url":"/ecomOrderProducts/:id","method":"get"},"isReference":true,"order":2,"slug":"retrieve-an-ecomorderproduct","type":"endpoint","title":"Retrieve an EcomOrderProduct","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"6564c6f3d898bd0050f74cca","title":"EcomMerce graphQl api","slug":"ecom-graphql-api","order":13,"reference":true,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2023-11-27T16:42:27.376Z","__v":0,"pages":[{"_id":"6564c722f1a103002dcb2e60","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Overview","icon":"","type":"basic","slug":"graphql-overview","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"overview-1","category":"6564c6f3d898bd0050f74cca","createdAt":"2023-11-27T16:43:14.407Z","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"6564c748684ea70032347129","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"About the GraphQL API","icon":"","type":"basic","slug":"about-the-graphql-api","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6564c722f1a103002dcb2e60","category":"6564c6f3d898bd0050f74cca","createdAt":"2023-11-27T16:43:52.437Z","isBodyEmpty":false,"children":[]}]},{"_id":"6564c7658703540011524176","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Reference","icon":"","type":"basic","slug":"reference","order":1,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","category":"6564c6f3d898bd0050f74cca","createdAt":"2023-11-27T16:44:21.642Z","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"65d92dc56cc9330025a5b42b","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Searches","icon":"","type":"basic","slug":"searches","order":2,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6564c7658703540011524176","category":"6564c6f3d898bd0050f74cca","createdAt":"2024-02-23T23:44:05.627Z","isBodyEmpty":false,"children":[]},{"_id":"65d647a6ec38da0017a5c8f0","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Orders","icon":"","type":"basic","slug":"orders-1","order":3,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6564c7658703540011524176","category":"6564c6f3d898bd0050f74cca","createdAt":"2024-02-21T18:57:42.683Z","isBodyEmpty":false,"children":[]},{"_id":"65d647b444d986002084933c","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Recurring Payments","icon":"","type":"basic","slug":"recurring-payments","order":4,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6564c7658703540011524176","category":"6564c6f3d898bd0050f74cca","createdAt":"2024-02-21T18:57:56.471Z","isBodyEmpty":false,"children":[]},{"_id":"65dd30548009390045e9c209","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[],"examples":{"codes":[]}},"title":"Shared Objects","icon":"","type":"basic","slug":"shared-objects","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6564c7658703540011524176","category":"6564c6f3d898bd0050f74cca","createdAt":"2024-02-27T00:44:04.905Z","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9aa0c0ea73db0003e33345","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-13T17:39:12.120Z","from_sync":false,"order":14,"slug":"forms","title":"Forms","__v":0,"pages":[{"_id":"5b9aa0dbea73db0003e3334f","category":"5b9aa0c0ea73db0003e33345","createdAt":"2018-09-13T17:39:39.569Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"forms","type":"basic","title":"Forms","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b9aa38fea73db0003e333a7","category":"5b9aa0c0ea73db0003e33345","parentDoc":"5b9aa0dbea73db0003e3334f","createdAt":"2018-09-13T17:51:11.206Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"form\": {\n \"name\": \"Test Form\",\n \"action\": \"\",\n \"actiondata\": {\n \"actions\": [\n {\n \"type\": \"email-results\",\n \"email\": \"johndoe@example.com\",\n \"fromname\": \"John Doe\",\n \"fromemail\": \"johndoe@example.com\",\n \"subject\": \"Form submission results\"\n }\n ]\n },\n \"submit\": \"show-thank-you\",\n \"submitdata\": {\n \"url\": \"\"\n },\n \"url\": \"\",\n \"layout\": \"inline-form\",\n \"title\": \"\",\n \"body\": \"\",\n \"button\": \"Submit\",\n \"thanks\": \"Thanks for signing up!\",\n \"style\": {\n \"background\": \"FFFFFF\",\n \"dark\": true,\n \"fontcolor\": \"000000\",\n \"layout\": \"normal\",\n \"border\": {\n \"width\": 0,\n \"style\": \"solid\",\n \"color\": \"B0B0B0\",\n \"radius\": 0\n },\n \"width\": 500,\n \"ac_branding\": true,\n \"button\": {\n \"padding\": 10,\n \"background\": \"333333\",\n \"fontcolor\": \"FFFFFF\",\n \"border\": {\n \"radius\": 4,\n \"color\": \"333333\",\n \"style\": \"solid\",\n \"width\": 0\n }\n },\n \"customcss\": \"\"\n },\n \"options\": {\n \"blanks_overwrite\": true,\n \"confaction\": \"show-message\"\n },\n \"cfields\": [\n {\n \"type\": \"header\",\n \"header\": \"Contact Us\",\n \"class\": \"_x29498744\",\n \"required_options\": {}\n },\n {\n \"type\": \"html\",\n \"html\": \"<p>Please provide the information below and we'll be in touch soon.</p>\",\n \"class\": \"_x14271862\",\n \"required_options\": {}\n },\n {\n \"header\": \"Full Name\",\n \"type\": \"fullname\",\n \"default_text\": \"\",\n \"class\": \"_x13100531\",\n \"required_options\": {},\n \"required\": true\n },\n {\n \"header\": \"Email\",\n \"type\": \"email\",\n \"default_text\": \"\",\n \"required\": true,\n \"class\": \"_x37378733\",\n \"required_options\": {}\n },\n {\n \"type\": \"organization\",\n \"header\": \"Company\",\n \"default_text\": \"\",\n \"class\": \"_x16906569\",\n \"required_options\": {},\n \"required\": false\n },\n {\n \"id\": \"13\",\n \"header\": \"Role in Company\",\n \"required\": true,\n \"class\": \"_field13\",\n \"required_options\": {}\n },\n {\n \"id\": \"46\",\n \"header\": \"What do you need help with?\",\n \"required\": true,\n \"class\": \"_field46\",\n \"required_options\": {}\n }\n ],\n \"parentformid\": \"0\",\n \"userid\": \"1\",\n \"addressid\": \"0\",\n \"cdate\": \"2018-10-07T09:12:46-06:00\",\n \"udate\": \"2018-10-12T11:18:52-06:00\",\n \"entries\": \"0\",\n \"aid\": null,\n \"links\": {\n \"address\": \"https://:account.api-us1.com/api/3/forms/13/address\"\n },\n \"id\": \"13\",\n \"address\": null\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for Form with id 7\"\n}","language":"json","status":403}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the form to retrieve","required":false,"in":"path","ref":"","_id":"5b9aa42cd989900003e98cb3"}],"url":"/forms/:id","method":"get"},"isReference":true,"order":0,"slug":"retrieve-forms","type":"endpoint","title":"Retrieve a form","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9aa23ad989900003e98c8f","category":"5b9aa0c0ea73db0003e33345","parentDoc":"5b9aa0dbea73db0003e3334f","createdAt":"2018-09-13T17:45:30.751Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"forms\": [\n {\n \"name\": \"Testing\",\n \"action\": \"\",\n \"actiondata\": {\n \"actions\": [\n {\n \"type\": \"subscribe-to-list\",\n \"email\": \"johndoe@example.com\",\n \"list\": \"1\"\n }\n ]\n },\n \"submit\": \"show-thank-you\",\n \"submitdata\": {\n \"url\": \"\"\n },\n \"url\": \"\",\n \"layout\": \"inline-form\",\n \"title\": \"\",\n \"body\": \"\",\n \"button\": \"Submit\",\n \"thanks\": \"Thanks for signing up!\",\n \"style\": {\n \"background\": \"FFFFFF\",\n \"dark\": true,\n \"fontcolor\": \"000000\",\n \"layout\": \"normal\",\n \"border\": {\n \"width\": 0,\n \"style\": \"solid\",\n \"color\": \"B0B0B0\",\n \"radius\": 0\n },\n \"width\": 500,\n \"ac_branding\": true,\n \"button\": {\n \"padding\": 10,\n \"background\": \"333333\",\n \"fontcolor\": \"FFFFFF\",\n \"border\": {\n \"radius\": 4,\n \"color\": \"333333\",\n \"style\": \"solid\",\n \"width\": 0\n }\n }\n },\n \"options\": {\n \"blanks_overwrite\": true,\n \"confaction\": \"show-message\",\n \"sendoptin\": true,\n \"optin_id\": 1,\n \"optin_created\": true,\n \"confform\": \"2\"\n },\n \"cfields\": [\n {\n \"type\": \"header\",\n \"header\": \"Subscribe for Email Updates\",\n \"class\": \"_x41699710\"\n },\n {\n \"type\": \"html\",\n \"html\": \"<p>Add a descriptive message telling what your visitor is signing up for here.</p>\",\n \"class\": \"_x50329289\"\n },\n {\n \"header\": \"Full Name\",\n \"type\": \"fullname\",\n \"default_text\": \"Type your name\",\n \"class\": \"_x67999677\"\n },\n {\n \"header\": \"Email\",\n \"type\": \"email\",\n \"default_text\": \"Type your email\",\n \"required\": true,\n \"class\": \"_x68140262\"\n }\n ],\n \"parentformid\": \"0\",\n \"userid\": \"1\",\n \"addressid\": \"0\",\n \"cdate\": \"2018-08-17T13:47:31-05:00\",\n \"udate\": \"2018-08-17T13:47:38-05:00\",\n \"entries\": \"0\",\n \"aid\": \"0\",\n \"defaultscreenshot\": \"http://img-us1.com/default-form.gif\",\n \"recent\": [],\n \"contacts\": 0,\n \"deals\": 0,\n \"links\": {\n \"address\": \"https://:account.api-us1.com/api/3/forms/1/address\"\n },\n \"id\": \"1\",\n \"address\": null\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"/forms","method":"get"},"isReference":true,"order":1,"slug":"forms-1","type":"endpoint","title":"List all forms","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9ac09f30f1ec000393414a","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-13T19:55:11.292Z","from_sync":false,"order":15,"slug":"lists","title":"Lists","__v":0,"pages":[{"_id":"5b9ac0b062645c0003d0b276","category":"5b9ac09f30f1ec000393414a","createdAt":"2018-09-13T19:55:28.388Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"lists","type":"basic","title":"Lists","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b9ac13962645c0003d0b281","category":"5b9ac09f30f1ec000393414a","parentDoc":"5b9ac0b062645c0003d0b276","createdAt":"2018-09-13T19:57:45.493Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"list\": {\n\t\t\"name\": \"Name of List\",\n\t\t\"stringid\": \"Name-of-list\",\n\t\t\"sender_url\": \"http://activecampaign.com\",\n\t\t\"sender_reminder\": \"You are receiving this email as you subscribed to a newsletter when making an order on our site.\",\n\t\t\"send_last_broadcast\": 0,\n\t\t\"carboncopy\": \"\",\n\t\t\"subscription_notify\": \"\",\n\t\t\"unsubscription_notify\": \"\",\n\t\t\"user\": 1\n\t}\n}"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"list\": {\n \"name\": \"Name of List\",\n \"stringid\": \"Name-of-list\",\n \"cdate\": \"2019-02-27T19:06:23-05:00\",\n \"udate\": \"2019-02-27T19:06:23-05:00\",\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/:version/lists/6/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/:version/lists/6/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/:version/lists/6/addressLists\"\n },\n \"id\": \"6\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""},{"status":403,"language":"text","code":"{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to create lists.\"\n }\n ]\n}"}]},"auth":"required","params":[{"name":"list.name","type":"string","enumValues":"","default":"","desc":"Name of the list to create","required":true,"in":"body","ref":"","_id":"5baec398cfaf8d00035799d5"},{"name":"list.stringid","type":"string","enumValues":"","default":"","desc":"URL-safe list name. Example: 'list-name-sample'","required":true,"in":"body","ref":"","_id":"5baec398cfaf8d00035799d4"},{"name":"list.sender_url","type":"string","enumValues":"","default":"","desc":"The website URL this list is for.","required":true,"in":"body","ref":"","_id":"5c8440abb1a4870013177736"},{"name":"list.sender_reminder","type":"string","enumValues":"","default":"","desc":"A reminder for your contacts as to why they are on this list and you are messaging them.","required":true,"in":"body","ref":"","_id":"5c8440abb1a4870013177735"},{"name":"list.send_last_broadcast","type":"boolean","enumValues":"","default":"0","desc":"Boolean value indicating whether or not to send the last sent campaign to this list to a new subscriber upon subscribing. 1 = yes, 0 = no","required":false,"in":"body","ref":"","_id":"5c84594d3c9cf90051c4d170"},{"name":"list.carboncopy","type":"string","enumValues":"","default":"","desc":"Comma-separated list of email addresses to send a copy of all mailings to upon send","required":false,"in":"body","ref":"","_id":"5c8452c746aed400332ef147"},{"name":"list.subscription_notify","type":"string","enumValues":"","default":"","desc":"Comma-separated list of email addresses to notify when a new subscriber joins this list.","required":false,"in":"body","ref":"","_id":"5c845573446b3600198e5104"},{"name":"list.unsubscription_notify","type":"string","enumValues":"","default":"","desc":"Comma-separated list of email addresses to notify when a subscriber unsubscribes from this list.","required":false,"in":"body","ref":"","_id":"5c845573446b3600198e5103"},{"name":"list.user","type":"int","enumValues":"","default":"","desc":"User Id of the list owner. A list owner is able to control campaign branding. A property of list.userid also exists on this object; both properties map to the same list owner field and are being maintained in the response object for backward compatibility. If you post values for both list.user and list.userid, the value of list.user will be used.","required":false,"in":"body","ref":"","_id":"5c845d66ff4e47001ab15b8e"},{"name":"list.channel","type":"string","enumValues":"","default":"email","desc":"Type of channel for the list. Possible values are `email` or `sms`.","required":false,"in":"body","ref":"","_id":"67409422b7281e001044fed4"}],"url":"/lists","method":"post"},"isReference":true,"order":0,"slug":"create-new-list","type":"endpoint","title":"Create a list","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5b9aca9411e6a400036d2d23","category":"5b9ac09f30f1ec000393414a","parentDoc":"5b9ac0b062645c0003d0b276","createdAt":"2018-09-13T20:37:40.303Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"list\": {\n \"stringid\": \"email-subscription\",\n \"userid\": \"1\",\n \"name\": \"Email Subscription\",\n \"cdate\": \"2018-08-06T16:30:41-05:00\",\n \"p_use_tracking\": \"1\",\n \"p_use_analytics_read\": \"0\",\n \"p_use_analytics_link\": \"0\",\n \"p_use_twitter\": \"0\",\n \"p_use_facebook\": \"0\",\n \"p_embed_image\": \"1\",\n \"p_use_captcha\": \"1\",\n \"send_last_broadcast\": \"0\",\n \"private\": \"0\",\n \"analytics_domains\": null,\n \"analytics_source\": \"\",\n \"analytics_ua\": \"\",\n \"twitter_token\": \"\",\n \"twitter_token_secret\": \"\",\n \"facebook_session\": null,\n \"carboncopy\": null,\n \"subscription_notify\": null,\n \"unsubscription_notify\": null,\n \"require_name\": \"0\",\n \"get_unsubscribe_reason\": \"0\",\n \"to_name\": \"Subscriber\",\n \"optinoptout\": \"1\",\n \"sender_name\": \"\",\n \"sender_addr1\": \"\",\n \"sender_addr2\": \"\",\n \"sender_city\": \"\",\n \"sender_state\": \"\",\n \"sender_zip\": \"\",\n \"sender_country\": \"\",\n \"sender_phone\": \"\",\n \"sender_url\": \"http://www.activecampaign.com\",\n \"sender_reminder\": \"You signed up for my mailing list.\",\n \"fulladdress\": \"\",\n \"optinmessageid\": \"0\",\n \"optoutconf\": \"0\",\n \"deletestamp\": null,\n \"udate\": null,\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/lists/1/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/3/lists/1/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/3/lists/1/addressLists\"\n },\n \"id\": \"1\",\n \"user\": \"1\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to view lists.\"\n }\n ]\n}"},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for _List with id 7\"\n}"}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the lists to retrieve","required":false,"in":"path","ref":"","_id":"5b9aca9411e6a400036d2d24"}],"url":"/lists/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-list","type":"endpoint","title":"Retrieve a list","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9ac3e530f1ec00039341f8","category":"5b9ac09f30f1ec000393414a","parentDoc":"5b9ac0b062645c0003d0b276","createdAt":"2018-09-13T20:09:09.516Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for _List with id 3\"\n}","language":"json","status":403}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"_id":"5b9ac3e530f1ec00039341f9","ref":"","in":"path","required":false,"desc":"ID of the list to delete","default":"","type":"int","name":"id"}],"url":"/lists/:id","method":"delete"},"isReference":true,"order":2,"slug":"delete-a-list","type":"endpoint","title":"Delete a list","isBodyEmpty":true,"children":[]},{"_id":"5b9ac9a33acc1d0003c40032","category":"5b9ac09f30f1ec000393414a","parentDoc":"5b9ac0b062645c0003d0b276","createdAt":"2018-09-13T20:33:39.291Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"lists\": [\n {\n \"stringid\": \"email-subscription\",\n \"userid\": \"1\",\n \"name\": \"Email Subscription\",\n \"cdate\": \"2018-08-06T16:30:41-05:00\",\n \"p_use_tracking\": \"1\",\n \"p_use_analytics_read\": \"0\",\n \"p_use_analytics_link\": \"0\",\n \"p_use_twitter\": \"0\",\n \"p_use_facebook\": \"0\",\n \"p_embed_image\": \"1\",\n \"p_use_captcha\": \"1\",\n \"send_last_broadcast\": \"0\",\n \"private\": \"0\",\n \"analytics_domains\": null,\n \"analytics_source\": \"\",\n \"analytics_ua\": \"\",\n \"twitter_token\": \"\",\n \"twitter_token_secret\": \"\",\n \"facebook_session\": null,\n \"carboncopy\": null,\n \"subscription_notify\": null,\n \"unsubscription_notify\": null,\n \"require_name\": \"0\",\n \"get_unsubscribe_reason\": \"0\",\n \"to_name\": \"Subscriber\",\n \"optinoptout\": \"1\",\n \"sender_name\": \"\",\n \"sender_addr1\": \"\",\n \"sender_addr2\": \"\",\n \"sender_city\": \"\",\n \"sender_state\": \"\",\n \"sender_zip\": \"\",\n \"sender_country\": \"\",\n \"sender_phone\": \"\",\n \"sender_url\": \"http://www.ilankreimont.com\",\n \"sender_reminder\": \"You signed up for my mailing list.\",\n \"fulladdress\": \"\",\n \"optinmessageid\": \"0\",\n \"optoutconf\": \"0\",\n \"deletestamp\": null,\n \"udate\": null,\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/lists/1/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/3/lists/1/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/3/lists/1/addressLists\"\n },\n \"id\": \"1\",\n \"user\": \"1\"\n },\n {\n \"stringid\": \"robert-list\",\n \"userid\": \"1\",\n \"name\": \"Robert List\",\n \"cdate\": \"2018-09-07T08:56:49-05:00\",\n \"p_use_tracking\": \"1\",\n \"p_use_analytics_read\": \"0\",\n \"p_use_analytics_link\": \"0\",\n \"p_use_twitter\": \"0\",\n \"p_use_facebook\": \"0\",\n \"p_embed_image\": \"1\",\n \"p_use_captcha\": \"1\",\n \"send_last_broadcast\": \"0\",\n \"private\": \"0\",\n \"analytics_domains\": null,\n \"analytics_source\": \"\",\n \"analytics_ua\": \"\",\n \"twitter_token\": \"\",\n \"twitter_token_secret\": \"\",\n \"facebook_session\": null,\n \"carboncopy\": null,\n \"subscription_notify\": null,\n \"unsubscription_notify\": null,\n \"require_name\": \"0\",\n \"get_unsubscribe_reason\": \"0\",\n \"to_name\": \"Subscriber\",\n \"optinoptout\": \"1\",\n \"sender_name\": \"\",\n \"sender_addr1\": \"\",\n \"sender_addr2\": \"\",\n \"sender_city\": \"\",\n \"sender_state\": \"\",\n \"sender_zip\": \"\",\n \"sender_country\": \"\",\n \"sender_phone\": \"\",\n \"sender_url\": \"http://www.activecampaign.com\",\n \"sender_reminder\": \"Test\",\n \"fulladdress\": \"\",\n \"optinmessageid\": \"0\",\n \"optoutconf\": \"0\",\n \"deletestamp\": null,\n \"udate\": null,\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/lists/2/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/3/lists/2/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/3/lists/2/addressLists\"\n },\n \"id\": \"2\",\n \"user\": \"1\"\n },\n {\n \"stringid\": \"mark-list\",\n \"userid\": \"1\",\n \"name\": \"Mark List\",\n \"cdate\": \"2018-09-14T08:53:28-05:00\",\n \"p_use_tracking\": \"1\",\n \"p_use_analytics_read\": \"0\",\n \"p_use_analytics_link\": \"0\",\n \"p_use_twitter\": \"0\",\n \"p_use_facebook\": \"0\",\n \"p_embed_image\": \"1\",\n \"p_use_captcha\": \"1\",\n \"send_last_broadcast\": \"0\",\n \"private\": \"0\",\n \"analytics_domains\": null,\n \"analytics_source\": \"\",\n \"analytics_ua\": \"\",\n \"twitter_token\": \"\",\n \"twitter_token_secret\": \"\",\n \"facebook_session\": null,\n \"carboncopy\": null,\n \"subscription_notify\": null,\n \"unsubscription_notify\": null,\n \"require_name\": \"0\",\n \"get_unsubscribe_reason\": \"0\",\n \"to_name\": \"Subscriber\",\n \"optinoptout\": \"1\",\n \"sender_name\": \"\",\n \"sender_addr1\": \"\",\n \"sender_addr2\": \"\",\n \"sender_city\": \"\",\n \"sender_state\": \"\",\n \"sender_zip\": \"\",\n \"sender_country\": \"\",\n \"sender_phone\": \"\",\n \"sender_url\": \"http://www.activecampaign.com\",\n \"sender_reminder\": \"testing.\",\n \"fulladdress\": \"\",\n \"optinmessageid\": \"0\",\n \"optoutconf\": \"0\",\n \"deletestamp\": null,\n \"udate\": null,\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/lists/3/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/3/lists/3/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/3/lists/3/addressLists\"\n },\n \"id\": \"3\",\n \"user\": \"1\"\n },\n {\n \"stringid\": \"\",\n \"userid\": \"0\",\n \"name\": \"\",\n \"cdate\": \"2018-09-25T15:24:37-05:00\",\n \"p_use_tracking\": \"1\",\n \"p_use_analytics_read\": \"0\",\n \"p_use_analytics_link\": \"0\",\n \"p_use_twitter\": \"0\",\n \"p_use_facebook\": \"0\",\n \"p_embed_image\": \"1\",\n \"p_use_captcha\": \"1\",\n \"send_last_broadcast\": \"0\",\n \"private\": \"0\",\n \"analytics_domains\": null,\n \"analytics_source\": \"\",\n \"analytics_ua\": \"\",\n \"twitter_token\": \"\",\n \"twitter_token_secret\": \"\",\n \"facebook_session\": null,\n \"carboncopy\": null,\n \"subscription_notify\": null,\n \"unsubscription_notify\": null,\n \"require_name\": \"0\",\n \"get_unsubscribe_reason\": \"0\",\n \"to_name\": \"Subscriber\",\n \"optinoptout\": \"1\",\n \"sender_name\": \"\",\n \"sender_addr1\": \"\",\n \"sender_addr2\": \"\",\n \"sender_city\": \"\",\n \"sender_state\": \"\",\n \"sender_zip\": \"\",\n \"sender_country\": \"\",\n \"sender_phone\": \"\",\n \"sender_url\": null,\n \"sender_reminder\": null,\n \"fulladdress\": null,\n \"optinmessageid\": \"0\",\n \"optoutconf\": \"0\",\n \"deletestamp\": null,\n \"udate\": \"2018-09-25T15:24:37-05:00\",\n \"links\": {\n \"contactGoalLists\": \"https://:account.api-us1.com/api/3/lists/4/contactGoalLists\",\n \"user\": \"https://:account.api-us1.com/api/3/lists/4/user\",\n \"addressLists\": \"https://:account.api-us1.com/api/3/lists/4/addressLists\"\n },\n \"id\": \"4\",\n \"user\": null\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}","language":"json","status":200},{"code":"{\n \"errors\": [\n {\n \"status\": 403,\n \"title\": \"Forbidden\",\n \"detail\": \"You do not have permission to view lists.\"\n }\n ]\n}","language":"text","status":403}]},"auth":"required","params":[{"name":"filters[name]","type":"string","enumValues":"","default":"","desc":"Filter by the name of the list","required":false,"in":"query","ref":"","_id":"5d791dd677b40a02383b2f04"},{"name":"limit","type":"int","enumValues":"","default":"","desc":"Limit the number of returned results","required":false,"in":"query","ref":"","_id":"629a1cc5cad068023f1a5ac5"},{"name":"filters[name][<operator>]","type":"string","enumValues":"","default":"","desc":"Filters lists by list name according to the operator specified. (See supported operators below)","required":false,"in":"query","ref":"","_id":"63cb02f053f14e003929320e"},{"name":"orders[name]","type":"string","enumValues":"","default":"","desc":"Orders filtered results by weight, ascending order, or descending order. If weight is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results.","required":false,"in":"query","ref":"","_id":"63cb02f053f14e003929320f"}],"url":"/lists","method":"get"},"isReference":true,"order":3,"slug":"retrieve-all-lists","type":"endpoint","title":"Retrieve all lists","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"5c5463c5fd2bff00bea92bf8","category":"5b9ac09f30f1ec000393414a","parentDoc":"5b9ac0b062645c0003d0b276","createdAt":"2019-02-01T15:20:37.269Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"listGroup\": {\n\t\t\"listid\": 19,\n\t\t\"groupid\": 1\n\t}\n}"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"listGroup\": {\n \"list\": 19,\n \"group\": 1,\n \"links\": {\n \"list\": \"https://account.api-us1.com/api/3/listGroups/55/list\",\n \"group\": \"https://account.api-us1.com/api/3/listGroups/55/group\"\n },\n \"id\": \"55\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"Forbidden\"\n}","name":""}]},"auth":"required","params":[{"name":"listGroup","type":"object","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5c54651832c2560057df12fd"},{"name":"listGroup.listid","type":"int","enumValues":"","default":"","desc":"ID of the list","required":true,"in":"body","ref":"","_id":"5c54651832c2560057df12fc"},{"name":"listGroup.groupid","type":"int","enumValues":"","default":"","desc":"ID of the group that list should be associated with","required":true,"in":"body","ref":"","_id":"5c54651832c2560057df12fb"}],"url":"/listGroups","method":"post"},"isReference":true,"order":4,"slug":"create-a-list-group-permission","type":"endpoint","title":"Create a list group permission","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b99eca243d76f000384cb35","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-13T04:50:42.654Z","from_sync":false,"order":16,"slug":"notes","title":"Notes","__v":0,"pages":[{"_id":"5b99ecbac15fdb0003af80ca","category":"5b99eca243d76f000384cb35","createdAt":"2018-09-13T04:51:06.149Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"notes","type":"basic","title":"Notes","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b99eeed1520990003293bd1","category":"5b99eca243d76f000384cb35","parentDoc":"5b99ecbac15fdb0003af80ca","createdAt":"2018-09-13T05:00:29.728Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"contacts\": [\n {\n \"cdate\": \"2018-08-06T16:26:04-05:00\",\n \"email\": \"ikreimont+2@activecampaign.com\",\n \"phone\": \"\",\n \"firstName\": \"\",\n \"lastName\": \"\",\n \"orgid\": \"0\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": null,\n \"ip\": \"0\",\n \"ua\": null,\n \"hash\": \"14d8c4418ae944c68e9dde4a975854cc\",\n \"socialdata_lastcheck\": null,\n \"email_local\": \"\",\n \"email_domain\": \"\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": null,\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": null,\n \"udate\": \"2018-09-28T17:45:11-05:00\",\n \"edate\": null,\n \"deleted_at\": null,\n \"created_utc_timestamp\": \"2018-09-21 12:04:40\",\n \"updated_utc_timestamp\": \"2018-09-28 17:45:11\",\n \"links\": {\n \"bounceLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/bounceLogs\",\n \"contactAutomations\": \"https://:account.api-us1.com/api/:version/contacts/2/contactAutomations\",\n \"contactData\": \"https://:account.api-us1.com/api/:version/contacts/2/contactData\",\n \"contactGoals\": \"https://:account.api-us1.com/api/:version/contacts/2/contactGoals\",\n \"contactLists\": \"https://:account.api-us1.com/api/:version/contacts/2/contactLists\",\n \"contactLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/contactLogs\",\n \"contactTags\": \"https://:account.api-us1.com/api/:version/contacts/2/contactTags\",\n \"contactDeals\": \"https://:account.api-us1.com/api/:version/contacts/2/contactDeals\",\n \"deals\": \"https://:account.api-us1.com/api/:version/contacts/2/deals\",\n \"fieldValues\": \"https://:account.api-us1.com/api/:version/contacts/2/fieldValues\",\n \"geoIps\": \"https://:account.api-us1.com/api/:version/contacts/2/geoIps\",\n \"notes\": \"https://:account.api-us1.com/api/:version/contacts/2/notes\",\n \"organization\": \"https://:account.api-us1.com/api/:version/contacts/2/organization\",\n \"plusAppend\": \"https://:account.api-us1.com/api/:version/contacts/2/plusAppend\",\n \"trackingLogs\": \"https://:account.api-us1.com/api/:version/contacts/2/trackingLogs\",\n \"scoreValues\": \"https://:account.api-us1.com/api/:version/contacts/2/scoreValues\"\n },\n \"id\": \"2\",\n \"organization\": null\n }\n ],\n \"note\": {\n \"note\": \"This is the text of the note\",\n \"cdate\": \"2018-09-28T17:45:11-05:00\",\n \"mdate\": \"2018-09-28T17:45:11-05:00\",\n \"reltype\": \"Subscriber\",\n \"relid\": 2,\n \"userid\": \"1\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/:version/notes/2/activities\",\n \"user\": \"https://:account.api-us1.com/api/:version/notes/2/user\",\n \"mentions\": \"https://:account.api-us1.com/api/:version/notes/2/mentions\",\n \"notes\": \"https://:account.api-us1.com/api/:version/notes/2/notes\",\n \"owner\": \"https://:account.api-us1.com/api/:version/notes/2/owner\"\n },\n \"owner\": {\n \"type\": \"contact\",\n \"id\": 2\n },\n \"id\": \"2\",\n \"user\": \"1\"\n }\n}","language":"json","status":201},{"name":"","code":"{}","language":"json","status":400}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"note\": {\n\t\t\"note\": \"This is the text of the note\",\n\t\t\"relid\": 2,\n\t\t\"reltype\": \"Subscriber\"\n\t}\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbea"},{"name":"note.reltype","type":"string","enumValues":"","default":"","desc":"Possible Values: Activity, Deal, DealTask, Subscriber, CustomerAccount","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbe9"},{"name":"note.relid","type":"int","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbe8"}],"url":"/notes","method":"post"},"isReference":true,"order":0,"slug":"create-a-note","type":"endpoint","title":"Create a note","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"5bae65c285f2960003bd01f5","category":"5b99eca243d76f000384cb35","parentDoc":"5b99ecbac15fdb0003af80ca","createdAt":"2018-09-28T17:32:50.617Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"note\": {\n \"relid\": \"2\",\n \"reltype\": \"Subscriber\",\n \"userid\": \"1\",\n \"cdate\": \"2018-09-12T17:20:20-05:00\",\n \"mdate\": \"2018-09-20T09:10:06-05:00\",\n \"note\": \"TEST NOTE\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/:version/notes/2/activities\",\n \"user\": \"https://:account.api-us1.com/api/:version/notes/2/user\",\n \"mentions\": \"https://:account.api-us1.com/api/:version/notes/2/mentions\",\n \"notes\": \"https://:account.api-us1.com/api/:version/notes/2/notes\",\n \"owner\": \"https://:account.api-us1.com/api/:version/notes/2/owner\"\n },\n \"id\": \"2\",\n \"user\": \"1\",\n \"owner\": {\n \"type\": \"contact\",\n \"id\": \"2\"\n }\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the note to retrieve","required":false,"in":"path","ref":"","_id":"5c1d415bef05050050f4b7f6"}],"url":"/notes/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-note","type":"endpoint","title":"Retrieve a note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9a8a97d6214700037f4370","category":"5b99eca243d76f000384cb35","parentDoc":"5b99ecbac15fdb0003af80ca","createdAt":"2018-09-13T16:04:39.646Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"note\": {\n\t\t\"note\": \"This is the text of the note\",\n\t\t\"relid\": 2,\n\t\t\"reltype\": \"Subscriber\"\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"note\": {\n \"relid\": \"107\",\n \"reltype\": \"Subscriber\",\n \"userid\": \"1\",\n \"cdate\": \"2018-09-21T11:52:41-05:00\",\n \"mdate\": \"2018-09-28T18:39:44-05:00\",\n \"note\": \"This is the text of the note\",\n \"links\": {\n \"activities\": \"https://:account.api-us1.com/api/:version/notes/1/activities\",\n \"user\": \"https://:account.api-us1.com/api/:version/notes/1/user\",\n \"mentions\": \"https://:account.api-us1.com/api/:version/notes/1/mentions\",\n \"notes\": \"https://:account.api-us1.com/api/:version/notes/1/notes\",\n \"owner\": \"https://:account.api-us1.com/api/:version/notes/1/owner\"\n },\n \"id\": \"1\",\n \"user\": \"1\",\n \"owner\": {\n \"type\": \"contact\",\n \"id\": \"107\"\n }\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for Subscriber with id 1\"\n}","name":""}]},"auth":"required","params":[{"name":"note.note","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbea"},{"name":"note.reltype","type":"string","enumValues":"","default":"","desc":"Possible Values: Activity, Deal, DealTask, Subscriber, CustomerAccount","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbe9"},{"name":"note.relid","type":"string","enumValues":"","default":"","desc":"","required":true,"in":"body","ref":"","_id":"5b99f15643d76f000384cbe8"},{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the note to update","required":false,"in":"path","ref":"","_id":"5c4887a9f721b514ce9513dc"}],"url":"/notes/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-note","type":"endpoint","title":"Update a note","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b99ee041520990003293aca","category":"5b99eca243d76f000384cb35","createdAt":"2018-09-13T04:56:36.945Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for Note with id 1\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the note to delete","required":false,"in":"path","ref":"","_id":"5b99ee041520990003293acb"}],"url":"/notes/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-note","type":"endpoint","title":"Delete a note","parentDoc":"5b99ecbac15fdb0003af80ca","deprecated":false,"previousSlug":"","isBodyEmpty":true,"children":[]}]}]},{"_id":"5bee81df54e56600185c31fd","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-11-16T08:37:51.437Z","order":17,"slug":"saved-responses","title":"Saved Responses","__v":0,"pages":[{"_id":"5bee853fe35e900229ce5f53","category":"5bee81df54e56600185c31fd","createdAt":"2018-11-16T08:52:15.507Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"saved-responses-1","type":"basic","title":"Saved Responses","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5bee852d20783c0206d40104","category":"5bee81df54e56600185c31fd","createdAt":"2018-11-16T08:51:57.973Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"savedResponse\": {\n\t\t\"title\": \"Response Title\",\n\t\t\"subject\": \"Response Subject\",\n\t\t\"body\": \"Response Body\"\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"savedResponse\": {\n \"title\": \"Response title\",\n \"subject\": \"Response subject\",\n \"body\": \"Response body\",\n \"cdate\": \"2018-11-16T02:50:54-06:00\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/:version/savedResponses/1/user\",\n \"savedResponseCategorySavedResponse\": \"https://:account.api-us1.com/api/:version/savedResponses/1/savedResponseCategorySavedResponse\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"This field is required.\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Either a subject or a body needs to be provided.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"source\": {\n \"pointer\": \"/data/attributes/subject\"\n }\n },\n {\n \"title\": \"Either a subject or a body needs to be provided.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"source\": {\n \"pointer\": \"/data/attributes/body\"\n }\n }\n ]\n}","name":""}]},"auth":"required","params":[{"name":"savedResponse.title","type":"string","enumValues":"","default":"","desc":"Title of the saved response being created","required":true,"in":"body","ref":"","_id":"5beefe14ec824f01c53b7732"},{"name":"savedResponse.subject","type":"string","enumValues":"","default":"","desc":"Subject of the saved response being created","required":true,"in":"body","ref":"","_id":"5beefe14ec824f01c53b7731"},{"name":"savedResponse.body","type":"string","enumValues":"","default":"","desc":"Body of the saved response being created","required":true,"in":"body","ref":"","_id":"5beefe14ec824f01c53b7730"}],"url":"/savedResponses","method":"post"},"isReference":true,"order":0,"slug":"saved-responses","type":"endpoint","title":"Create a saved response","parentDoc":"5bee853fe35e900229ce5f53","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bee86c37810790299ae70f9","category":"5bee81df54e56600185c31fd","createdAt":"2018-11-16T08:58:43.497Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"savedResponse\": {\n \"title\": \"Response title\",\n \"subject\": \"Response subject\",\n \"body\": \"Response body\",\n \"ldate\": null,\n \"last_sent_user_id\": null,\n \"cdate\": \"2018-11-16T02:50:54-06:00\",\n \"mdate\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/:version/savedResponses/1/user\",\n \"savedResponseCategorySavedResponse\": \"https://:account.api-us1.com/api/:version/savedResponses/1/savedResponseCategorySavedResponse\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the saved Response to recieve","required":false,"in":"path","ref":"","_id":"5bee86c37810790299ae70fa"}],"url":"/savedResponses/:id","method":"get"},"isReference":true,"order":1,"slug":"get-a-savedresponse","type":"endpoint","title":"Retrieve a saved response","parentDoc":"5bee853fe35e900229ce5f53","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5beefa5265096801173e87ea","category":"5bee81df54e56600185c31fd","parentDoc":"5bee853fe35e900229ce5f53","createdAt":"2018-11-16T17:11:46.242Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"savedResponse\": {\n \"title\": \"New Response Title\",\n \"subject\": \"New Response Subject\",\n \"body\": \"New Response Body\",\n \"ldate\": null,\n \"last_sent_user_id\": null,\n \"cdate\": \"2018-11-16T02:50:54-06:00\",\n \"mdate\": \"2018-11-16T11:19:30-06:00\",\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/:version/savedResponses/1/user\",\n \"savedResponseCategorySavedResponse\": \"https://:account.api-us1.com/api/:version/savedResponses/1/savedResponseCategorySavedResponse\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"status":422,"language":"json","code":"{\n \"message\": \"No Result found for SavedResponse with id 0\"\n}","name":""}]},"examples":{"codes":[{"language":"json","code":"{\n\t\"savedResponse\": {\n\t\t\"title\": \"Response title\",\n\t\t\"subject\": \"Response subject\",\n\t\t\"body\": \"Response body\"\n\t}\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"savedResponse.title","type":"string","enumValues":"","default":"","desc":"Title of the saved response being updated","required":false,"in":"body","ref":"","_id":"5beefa5265096801173e87ed"},{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the saved response to update","required":false,"in":"path","ref":"","_id":"5beefa5265096801173e87ec"},{"name":"savedResponse.subject","type":"string","enumValues":"","default":"","desc":"Subject of the saved response being updated","required":false,"in":"body","ref":"","_id":"5beefa5265096801173e87eb"},{"name":"savedResponse.body","type":"string","enumValues":"","default":"","desc":"Body of the saved response being updated","required":false,"in":"body","ref":"","_id":"5beefc0aae07be0119a1190a"}],"url":"/savedResponses/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-saved-response","type":"endpoint","title":"Update a saved response","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5beeff68ae07be0119a11d3c","category":"5bee81df54e56600185c31fd","parentDoc":"5bee853fe35e900229ce5f53","createdAt":"2018-11-16T17:33:28.613Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"status":404,"language":"text","code":"{\n \"message\": \"No Result found for SavedResponse with id 1\"\n}"}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the saved response to remove","required":false,"in":"path","ref":"","_id":"5bee86c37810790299ae70fa"}],"url":"/savedResponses/:id","method":"delete"},"isReference":true,"order":3,"slug":"retrieve-a-savedresponse","type":"endpoint","title":"Delete a saved response","deprecated":false,"previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5bee866b994ccc02464c34a8","category":"5bee81df54e56600185c31fd","parentDoc":"5bee853fe35e900229ce5f53","createdAt":"2018-11-16T08:57:15.946Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"savedResponses\": [\n {\n \"title\": \"Response title\",\n \"subject\": \"Response subject\",\n \"body\": \"Response body\",\n \"ldate\": null,\n \"last_sent_user_id\": null,\n \"cdate\": \"2018-11-16T02:50:54-06:00\",\n \"mdate\": null,\n \"links\": {\n \"user\": \"https://:account.api-us1.com/api/:version/savedResponses/1/user\",\n \"savedResponseCategorySavedResponse\": \"https://:account.api-us1.com/api/:version/savedResponses/1/savedResponseCategorySavedResponse\"\n },\n \"id\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"1\"\n }\n}","name":""}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[],"url":"/savedResponses","method":"get"},"isReference":true,"order":4,"slug":"list-all-saved-responses","type":"endpoint","title":"List all saved responses","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5bef7a2dc032320012296403","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-11-17T02:17:17.387Z","order":18,"slug":"scores","title":"Scores","__v":0,"pages":[{"_id":"5bef7a3a64975b000d81524a","category":"5bef7a2dc032320012296403","createdAt":"2018-11-17T02:17:30.993Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"scores","type":"basic","title":"Scores","parentDoc":null,"isBodyEmpty":false,"children":[{"_id":"5bef7dd7f95d82011c6f946d","category":"5bef7a2dc032320012296403","parentDoc":"5bef7a3a64975b000d81524a","createdAt":"2018-11-17T02:32:55.817Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"score\": {\n \"reltype\": \"contact\",\n \"name\": \"Link Engagement Score\",\n \"descript\": \"+50 points when user clicks any link sent\",\n \"status\": \"1\",\n \"cdate\": \"2018-12-13T15:05:42-06:00\",\n \"mdate\": \"2018-12-13T16:23:07-06:00\",\n \"links\": [],\n \"id\": \"2\"\n }\n}","language":"json","status":200},{"code":"{\n \"message\": \"No Result found for Score with id 1\"\n}","language":"json","status":404}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the score to retrieve","required":false,"in":"path","ref":"","_id":"5bff490db79ad0000e55ac19"}],"url":"/scores/:id","method":"get"},"isReference":true,"order":0,"slug":"retrieve-a-score","type":"endpoint","title":"Retrieve a score","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bef7be7b256c70227cf965b","category":"5bef7a2dc032320012296403","parentDoc":"5bef7a3a64975b000d81524a","createdAt":"2018-11-17T02:24:39.662Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"name":"","code":"{\n \"scores\": [\n {\n \"reltype\": \"contact\",\n \"name\": \"Link Engagement Score\",\n \"descript\": \"+50 points when user clicks any link sent\",\n \"status\": \"1\",\n \"cdate\": \"2018-12-13T15:05:42-06:00\",\n \"mdate\": \"2018-12-13T16:23:07-06:00\",\n \"links\": [],\n \"id\": \"2\"\n },\n {\n \"reltype\": \"contact\",\n \"name\": \"Easy Targets\",\n \"descript\": \"+10 for replying to any campaign email\",\n \"status\": \"1\",\n \"cdate\": \"2018-12-18T19:00:13-06:00\",\n \"mdate\": \"2018-12-18T19:01:15-06:00\",\n \"links\": [],\n \"id\": \"6\"\n },\n {\n \"reltype\": \"deal\",\n \"name\": \"Is John Smith\",\n \"descript\": \"+10 If contacts first name is John and the last name is Smith\",\n \"status\": \"1\",\n \"cdate\": \"2018-12-18T19:15:02-06:00\",\n \"mdate\": \"2018-12-18T19:15:10-06:00\",\n \"links\": [],\n \"id\": \"7\"\n },\n {\n \"reltype\": \"deal\",\n \"name\": \"Country Is USA\",\n \"descript\": \"+20 if contact resides in the United States\",\n \"status\": \"1\",\n \"cdate\": \"2018-12-19T00:37:38-06:00\",\n \"mdate\": \"2018-12-19T00:37:42-06:00\",\n \"links\": [],\n \"id\": \"9\"\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}","language":"json","status":200}]},"auth":"required","params":[],"url":"/scores","method":"get"},"isReference":true,"order":1,"slug":"list-all-scores","type":"endpoint","title":"List all scores","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9afbb7be532f00037e75d5","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-14T00:07:19.678Z","from_sync":false,"order":19,"slug":"segments","title":"Segments","__v":0,"pages":[{"_id":"5b9afbc7cd7ed60003494496","category":"5b9afbb7be532f00037e75d5","createdAt":"2018-09-14T00:07:35.972Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"segments","type":"basic","title":"Segments","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5bef7f59c063760104bbfaa1","category":"5b9afbb7be532f00037e75d5","createdAt":"2018-11-17T02:39:21.504Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"segment\": {\n \"name\": \"Segment of test\",\n \"logic\": \"and\",\n \"hidden\": \"0\",\n \"seriesid\": \"0\",\n \"links\": [],\n \"id\": \"1\"\n }\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the segment to be retrieved","required":false,"in":"path","ref":"","_id":"5bef822b57d81400f458b091"}],"url":"/segments/:id","method":"get"},"isReference":true,"order":0,"slug":"retrieve-a-segment","type":"endpoint","title":"Retrieve a segment","parentDoc":"5b9afbc7cd7ed60003494496","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9afe06cf6a7e000348cf0f","category":"5b9afbb7be532f00037e75d5","parentDoc":"5b9afbc7cd7ed60003494496","createdAt":"2018-09-14T00:17:10.456Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"segments\": [\n {\n \"name\": \"Segment of Automation 1\",\n \"logic\": \"and\",\n \"hidden\": \"0\",\n \"seriesid\": \"1\",\n \"links\": [],\n \"id\": \"1\"\n },\n {\n \"name\": \"Segment of Email Subscription\",\n \"logic\": \"and\",\n \"hidden\": \"0\",\n \"seriesid\": \"1\",\n \"links\": [],\n \"id\": \"2\"\n },\n {\n \"name\": \"Segment of daasf\",\n \"logic\": \"and\",\n \"hidden\": \"0\",\n \"seriesid\": \"0\",\n \"links\": [],\n \"id\": \"3\"\n },\n {\n \"name\": \"Segment of Automation 2\",\n \"logic\": \"and\",\n \"hidden\": \"0\",\n \"seriesid\": \"2\",\n \"links\": [],\n \"id\": \"4\"\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"/segments","method":"get"},"isReference":true,"order":1,"slug":"list-all-segments","type":"endpoint","title":"List all segments","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9afefacf6a7e000348cf36","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-14T00:21:14.925Z","from_sync":false,"order":20,"slug":"configs","title":"Settings","__v":0,"pages":[{"_id":"5b9aff0abe532f00037e75e9","category":"5b9afefacf6a7e000348cf36","createdAt":"2018-09-14T00:21:30.313Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"configs","type":"basic","title":"Settings","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b9afff8177e140003c21e27","category":"5b9afefacf6a7e000348cf36","parentDoc":"5b9aff0abe532f00037e75e9","createdAt":"2018-09-14T00:25:28.545Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"config\": {\n \"keyname\": \"pagination.users_index\",\n \"section\": \"\",\n \"item\": \"\",\n \"userid\": \"1\",\n \"val\": \"20\",\n \"cdate\": \"2018-08-08T13:38:38-05:00\",\n \"udate\": \"2018-09-20T14:07:07-05:00\",\n \"links\": {\n \"owner\": \"https://:account.api-us1.com/api/3/configs/6/owner\"\n },\n \"id\": \"6\",\n \"owner\": \"1\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for ConfigResult with id 100\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the config to edit","required":false,"in":"path","ref":"","_id":"5b9afff8177e140003c21e28"}],"url":"/configs/:id","method":"put"},"isReference":true,"order":0,"slug":"set-config","type":"endpoint","title":"Update settings","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"58bdca9a5cbad00f00124aff","reference":true,"createdAt":"2017-03-06T20:46:18.127Z","from_sync":false,"order":21,"version":"57b6f40e480bae1900ce4e24","slug":"site-event-tracking","title":"Site & Event Tracking","__v":0,"project":"57b6f40e480bae1900ce4e21","isAPI":false,"pages":[{"_id":"58d2d7e08310001b0078e94b","order":0,"category":"58bdca9a5cbad00f00124aff","createdAt":"2017-03-22T20:00:32.308Z","isReference":true,"link_url":"","sync_unique":"","type":"basic","link_external":false,"slug":"event-tracking","api":{"method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":""},"hidden":false,"parentDoc":null,"title":"Event Tracking","isBodyEmpty":false,"children":[{"_id":"5bb56ff454d2dc0003988223","category":"58bdca9a5cbad00f00124aff","parentDoc":"58d2d7e08310001b0078e94b","createdAt":"2018-10-04T01:42:12.691Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"success\": 1,\n \"message\": \"Event spawned\"\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"auth":"required","params":[{"name":"key","type":"string","enumValues":"","default":"","desc":"This value is unique to your ActiveCampaign account and can be found named \"Event Key\" on \"Website\" -> \"Site Tracking\" (scroll down to Event tracking) inside your ActiveCampaign account.","required":true,"in":"body","ref":"","_id":"5bb610a7f0e90e000361399a"},{"name":"event","type":"string","enumValues":"","default":"","desc":"The name of the event you wish to track. (Max of 32 Characters)","required":true,"in":"body","ref":"","_id":"5bb610a7f0e90e0003613999"},{"name":"eventdata","type":"string","enumValues":"","default":"","desc":"A value you wish to store for the event.","required":false,"in":"body","ref":"","_id":"5bb610a7f0e90e0003613998"},{"name":"actid","type":"string","enumValues":"","default":"","desc":"This value is unique to your ActiveCampaign account and can be found named \"actid\" on \"Website\" -> \"Site Tracking\" (scroll down to Event tracking) API.","required":true,"in":"body","ref":"","_id":"5bb610a7f0e90e0003613997"},{"name":"visit","type":"json","enumValues":"","default":"","desc":"The json-encoded email address of the contact you wish to track this event for. {\"email\":\"visitor@example.com\"})","required":true,"in":"body","ref":"","_id":"5bb610a7f0e90e0003613996"},{"name":"Content-Type","type":"string","enumValues":"","default":"application/x-www-form-urlencoded","desc":"Value needs to be \"application/x-www-form-urlencoded\"","required":true,"in":"header","ref":"","_id":"5bb6110254d2dc0003989279"}],"url":"/event","method":"post","apiSetting":"5bb57211a1c16c00038041e0","examples":{"codes":[{"language":"csharp","code":"curl --request POST \\\n --url https://trackcmp.net/event \\\n --header 'content-type: application/x-www-form-urlencoded' \\\n --data 'actid={{actid}}&key={{key}}&event={{event}}&eventdata={{eventdata}}&visit=%7B%22email%22%3A%22{{email}}%22%7D'","name":"Raw body"},{"code":"","language":"text","name":null}]}},"isReference":true,"order":0,"slug":"track-event","type":"endpoint","title":"Track event","previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[]},{"_id":"58ebd6de57992c0f005299b9","order":1,"sync_unique":"","createdAt":"2017-04-10T19:02:54.466Z","link_external":false,"title":"Create a new event (name only)","api":{"examples":{"codes":[{"name":"JSON","language":"json","code":"{\n\t\"eventTrackingEvent\": {\n\t\t\"name\": \"my new fab event\"\n\t}\n}"}]},"method":"post","params":[{"name":"eventTrackingEvent.name","type":"string","enumValues":"","default":"","desc":"The name of the event","required":true,"in":"body","ref":"","_id":"58ebd8fa57992c0f00529aa1"}],"results":{"codes":[{"status":201,"name":"","code":"{\n\t\"eventTrackingEvent\": {\n\t\t\"name\": \"my new fab event\"\n\t}\n}","language":"json"}]},"url":"/eventTrackingEvents","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"category":"58bdca9a5cbad00f00124aff","hidden":false,"type":"endpoint","isReference":true,"link_url":"","parentDoc":"58d2d7e08310001b0078e94b","slug":"create-a-new-event-name-only","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58bdcaf55cbad00f00124b00","title":"Retrieve Event Tracking Status","type":"endpoint","api":{"results":{"codes":[{"name":"","code":"{\n \"eventTracking\" {\n \"enabled\": true\n }\n}","language":"json","status":200}]},"url":"/eventTracking","auth":"required","examples":{"codes":[]},"method":"get","params":[],"apiSetting":"58b53c301065f9c438aa1f77"},"parentDoc":"58d2d7e08310001b0078e94b","slug":"retrieve-event-tracking-status","sync_unique":"","category":"58bdca9a5cbad00f00124aff","hidden":false,"link_external":false,"createdAt":"2017-03-06T20:47:49.080Z","isReference":true,"link_url":"","order":2,"deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58d029ff08bcac23006e68b4","isReference":true,"order":3,"slug":"enable-disable-event-tracking","hidden":false,"category":"58bdca9a5cbad00f00124aff","createdAt":"2017-03-20T19:14:07.011Z","link_url":"","sync_unique":"","title":"Enable/disable","type":"endpoint","link_external":false,"parentDoc":"58d2d7e08310001b0078e94b","api":{"params":[{"name":"eventTracking.enabled","type":"boolean","enumValues":"","default":"","desc":"Whether event tracking should be enabled","required":true,"in":"body","ref":"","_id":"58d02ad108bcac23006e68b8"}],"results":{"codes":[{"status":200,"name":"","code":"{\n \"eventTracking\" {\n \"enabled\": true\n }\n}","language":"json"},{"name":"","code":"{}","language":"json","status":400}]},"url":"/eventTracking","auth":"required","examples":{"codes":[{"name":"Enable","language":"json","code":"{\n \"eventTracking\": {\n \"enabled\": true\n }\n}"},{"name":"Disable","language":"json","code":"{\n \"eventTracking\": {\n \"enabled\": false\n }\n}"}]},"method":"put","apiSetting":"58b53c301065f9c438aa1f77"},"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58d02e972cb80d1b00548f8d","createdAt":"2017-03-20T19:33:43.064Z","isReference":true,"link_external":false,"type":"endpoint","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/eventTrackingEvents/:eventName","auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"eventName","type":"string","enumValues":"","default":"","desc":"Name of event to delete. Spaces in names are allowed, but must be encoded (for example, \"my%20event\").","required":false,"in":"path","ref":"","_id":"58d02f952cb80d1b00548faf"}],"apiSetting":"58b53c301065f9c438aa1f77"},"link_url":"","sync_unique":"","title":"Delete event (name only)","category":"58bdca9a5cbad00f00124aff","hidden":false,"order":4,"parentDoc":"58d2d7e08310001b0078e94b","slug":"remove-event-name-only","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58bdcb9cb066580f006d88f9","hidden":false,"isReference":true,"slug":"list-all-event-types","type":"endpoint","category":"58bdca9a5cbad00f00124aff","link_url":"","parentDoc":"58d2d7e08310001b0078e94b","title":"List all events (names only)","createdAt":"2017-03-06T20:50:36.568Z","order":5,"api":{"url":"/eventTrackingEvents","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"code":"{\n \"eventTrackingEvents\": [\n {\n \"name\": \"__pagevisit\"\n },\n {\n \"name\": \"__redir\"\n }\n ],\n \"meta\": {\n \"total\": 2,\n }\n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"link_external":false,"sync_unique":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"633355567aba5100510c4b07","api":{"method":"get","url":"/contacts/:contactId/trackingLogs","auth":"required","results":{"codes":[{"name":"","code":"{\n \"trackingLogs\": [\n {\n \"subscriberid\": \"112\",\n \"type\": \"Another event\",\n \"value\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure do\",\n \"tstamp\": \"2022-09-27T12:39:59-05:00\",\n \"hash\": \"358a9a13d85efb7b888014ec57790efb6c13ab3a\",\n \"links\": {\n \"contact\": \"https://yourAccountName.api-us1.com/api/3/trackingLogs/12/contact\"\n },\n \"id\": \"12\",\n \"contact\": \"112\"\n },\n {\n \"subscriberid\": \"112\",\n \"type\": \"Yet Another Event\",\n \"value\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure do\",\n \"tstamp\": \"2022-09-27T13:35:01-05:00\",\n \"hash\": \"abc4307d06ff83df6869c24e86552dfada77277d\",\n \"links\": {\n \"contact\": \"https://yourAccountName.api-us1.com/api/3/trackingLogs/15/contact\"\n },\n \"id\": \"15\",\n \"contact\": \"112\"\n }\n ]\n}","language":"json","status":200}]},"examples":{"codes":[]},"params":[{"name":"contactId","type":"string","enumValues":"","default":"","desc":"The Contact's ID","required":false,"in":"path","ref":"","_id":"63335588b2cc8d0043411ab6"}],"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Get Contact's Tracking Logs/Events","icon":"","type":"endpoint","slug":"get-contacts-tracking-logsevents","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58d2d7e08310001b0078e94b","createdAt":"2022-09-27T19:56:06.558Z","category":"58bdca9a5cbad00f00124aff","isBodyEmpty":false,"children":[]},{"_id":"6333567bf86d2200aaf50733","api":{"method":"get","url":"/trackingLogs/:eventId/contact","auth":"required","results":{"codes":[{"name":"","code":"{\n \"contact\": {\n \"cdate\": \"2022-09-22T12:36:33-05:00\",\n \"email\": \"jd@example.com\",\n \"phone\": \"555-555-5555\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"orgid\": \"0\",\n \"orgname\": \"\",\n \"segmentio_id\": \"\",\n \"bounced_hard\": \"0\",\n \"bounced_soft\": \"0\",\n \"bounced_date\": \"0000-00-00\",\n \"ip\": \"0\",\n \"ua\": \"\",\n \"hash\": \"ef73fe360240b8bf171744f7f341524f\",\n \"socialdata_lastcheck\": \"0000-00-00 00:00:00\",\n \"email_local\": \"\",\n \"email_domain\": \"example.com\",\n \"sentcnt\": \"0\",\n \"rating_tstamp\": \"0000-00-00\",\n \"gravatar\": \"0\",\n \"deleted\": \"0\",\n \"anonymized\": \"0\",\n \"adate\": \"2022-09-27T14:57:35-05:00\",\n \"udate\": \"2022-09-22T12:36:33-05:00\",\n \"edate\": \"2022-09-27T13:36:04-05:00\",\n \"deleted_at\": \"0000-00-00 00:00:00\",\n \"created_utc_timestamp\": \"2022-09-22 12:36:33\",\n \"updated_utc_timestamp\": \"2022-09-27 13:36:04\",\n \"created_timestamp\": \"2022-09-22 12:36:33\",\n \"updated_timestamp\": \"2022-09-27 13:36:04\",\n \"created_by\": \"0\",\n \"updated_by\": \"0\",\n \"email_empty\": false,\n \"mpp_tracking\": \"0\",\n \"links\": {\n \"bounceLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/bounceLogs\",\n \"contactAutomations\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactAutomations?limit=1000&orders%5Blastdate%5D=DESC\",\n \"contactData\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactData\",\n \"contactGoals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactGoals\",\n \"contactLists\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactLists\",\n \"contactLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactLogs\",\n \"contactTags\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactTags\",\n \"contactDeals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/contactDeals\",\n \"deals\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/deals\",\n \"fieldValues\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/fieldValues\",\n \"geoIps\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/geoIps\",\n \"notes\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/notes\",\n \"organization\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/organization\",\n \"plusAppend\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/plusAppend\",\n \"trackingLogs\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/trackingLogs\",\n \"scoreValues\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/scoreValues\",\n \"accountContacts\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/accountContacts\",\n \"automationEntryCounts\": \"https://yourAccountName.api-us1.com/api/3/contacts/112/automationEntryCounts\"\n },\n \"id\": \"112\",\n \"organization\": null\n }\n}","language":"json","status":200}]},"examples":{"codes":[]},"params":[{"name":"eventId","type":"string","enumValues":"","default":"","desc":"The Event's ID","required":false,"in":"path","ref":"","_id":"63335588b2cc8d0043411ab6"}],"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Get Contact By Event ID","icon":"","type":"endpoint","slug":"get-contact-by-event-id","order":7,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"58d2d7e08310001b0078e94b","createdAt":"2022-09-27T20:00:59.247Z","category":"58bdca9a5cbad00f00124aff","isBodyEmpty":false,"children":[]}]},{"_id":"58ff8b86b2ff030f000d3c11","createdAt":"2017-04-25T17:46:46.689Z","order":1,"parentDoc":null,"hidden":false,"link_external":false,"sync_unique":"","type":"basic","title":"Site Tracking","api":{"auth":"required","params":[],"url":"","method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]}},"category":"58bdca9a5cbad00f00124aff","isReference":true,"link_url":"","slug":"site-tracking","isBodyEmpty":false,"children":[{"_id":"590c826ac96b082300e10c29","isReference":true,"order":0,"title":"Add domain to whitelist","type":"endpoint","category":"58bdca9a5cbad00f00124aff","createdAt":"2017-05-05T13:47:22.382Z","link_url":"","parentDoc":"58ff8b86b2ff030f000d3c11","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"siteTrackingDomain\": {\n \"name\": \"example.com\"\n }\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/siteTrackingDomains","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"siteTrackingDomain\": {\n \"name\": \"example.com\"\n }\n}"}]},"method":"post","params":[{"name":"siteTrackingDomain.name","type":"string","enumValues":"","default":"","desc":"The domain name to add to the whitelist.","required":true,"in":"body","ref":"","_id":"590c82fcb3d6920f009e15ea"}],"apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"link_external":false,"slug":"add-domain-to-whitelist","sync_unique":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5956b5f268a06100155f3966","category":"58bdca9a5cbad00f00124aff","parentDoc":"58ff8b86b2ff030f000d3c11","createdAt":"2017-06-30T20:34:58.798Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"text","code":"<script type=\"text/javascript\">\n (function(e,t,o,n,p,r,i){e.prismGlobalObjectAlias=n;e.pgo=e.pgo||function(){(e.pgo.q=e.pgo.q||[]).push(arguments)};e.pgo.l=(new Date).getTime();r=t.createElement(\"script\");r.src=o;r.async=true;i=t.getElementsByTagName(\"script\")[0];i.parentNode.insertBefore(r,i)})(window,document,\"https://prism.app-us1.com/prism.js\",\"pgo\");\n\n pgo('setAccount', YOUR_ACCOUNT_ID);\n pgo('setTrackByDefault', true);\n\n pgo('process');\n</script>","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"/siteTracking/code","method":"get","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":1,"slug":"retrieve-site-tracking-code","type":"endpoint","title":"Retrieve site tracking code","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58ff8b9fa9691f0f0012f630","link_url":"","hidden":false,"sync_unique":"","title":"Retrieve status","type":"endpoint","category":"58bdca9a5cbad00f00124aff","createdAt":"2017-04-25T17:47:11.381Z","isReference":true,"link_external":false,"order":2,"parentDoc":"58ff8b86b2ff030f000d3c11","slug":"retrieve-site-tracking-status","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"name":"","code":"{\n \"siteTracking\": {\n \"enabled\": true\n }\n}","language":"json","status":200},{"code":"{}","language":"json","status":400,"name":""}]},"url":"/siteTracking","apiSetting":"58b53c301065f9c438aa1f77"},"deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"590c7dad95d6fa1900b64cae","api":{"auth":"required","examples":{"codes":[{"code":"{\n \"siteTracking\": {\n \"enabled\": true\n }\n}","name":"Enable","language":"json"},{"name":"Disable","language":"text","code":"{\n \"siteTracking\": {\n \"enabled\": false\n }\n}"}]},"method":"put","params":[{"name":"siteTracking.enabled","type":"boolean","enumValues":"","default":"","desc":"Whether site tracking should be enabled","required":true,"in":"body","ref":"","_id":"590c7f7b7b7073370034e7a7"}],"results":{"codes":[{"name":"","code":"{\n \"siteTracking\": {\n \"enabled\": true\n }\n}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"url":"/siteTracking","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-05-05T13:27:09.825Z","link_url":"","order":3,"slug":"enable-disable-site-tracking","isReference":true,"link_external":false,"category":"58bdca9a5cbad00f00124aff","hidden":false,"parentDoc":"58ff8b86b2ff030f000d3c11","sync_unique":"","title":"Enable/disable","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"590cc1ea3972770f003dbbb5","category":"58bdca9a5cbad00f00124aff","createdAt":"2017-05-05T18:18:18.770Z","hidden":false,"link_external":false,"parentDoc":"58ff8b86b2ff030f000d3c11","api":{"results":{"codes":[{"name":"","code":"","language":"json","status":204}]},"url":"/siteTrackingDomains/:name","auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"name","type":"string","enumValues":"","default":"","desc":"The domain name to remove from the whitelist","required":false,"in":"path","ref":"","_id":"590cc2a4b0deda0f00c436da"}],"apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":4,"slug":"remove-domain-from-whitelist","sync_unique":"","type":"endpoint","link_url":"","title":"Remove domain from whitelist","previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"5903af32aac1552500a902a5","type":"endpoint","category":"58bdca9a5cbad00f00124aff","parentDoc":"58ff8b86b2ff030f000d3c11","createdAt":"2017-04-28T21:08:02.227Z","hidden":false,"link_external":false,"link_url":"","api":{"url":"/siteTrackingDomains","auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"siteTrackingDomains\": [\n {\n \"name\": \"example.com\"\n }\n ],\n \"meta\": {\n \"total\": 1\n }\n}","name":""}]},"apiSetting":"58b53c301065f9c438aa1f77"},"order":5,"slug":"list-all-whitelisted-domains","isReference":true,"sync_unique":"","title":"List all whitelisted domains","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9b019bcf6a7e000348cf47","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-14T00:32:27.778Z","from_sync":false,"order":22,"slug":"tags","title":"Tags","__v":0,"pages":[{"_id":"5b9b01bb177e140003c21e4a","category":"5b9b019bcf6a7e000348cf47","createdAt":"2018-09-14T00:32:59.052Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"tags","type":"basic","title":"Tags","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5bae535385f2960003bcff0f","category":"5b9b019bcf6a7e000348cf47","parentDoc":"5b9b01bb177e140003c21e4a","createdAt":"2018-09-28T16:14:11.142Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"tag\":{\n\t\t\"tag\": \"My Tag\",\n\t\t\"tagType\": \"contact\",\n\t\t\"description\": \"Description\"\n\t}\n}","language":"json"}]},"results":{"codes":[{"status":201,"language":"json","code":"{\n \"tag\": {\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"tagType\": \"contact\",\n \"cdate\": \"2018-09-29T19:21:25-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/16/contactGoalTags\"\n },\n \"id\": \"16\"\n }\n}","name":""}]},"auth":"required","params":[{"name":"tag.tag","type":"string","enumValues":"","default":"","desc":"Name of the new tag","required":false,"in":"body","ref":"","_id":"5bae5e6c2aa01a00033fcd14"},{"name":"tag.tagType","type":"string","enumValues":"","default":"","desc":"Tag-type of the new tag. Possible Values: template, contact","required":false,"in":"body","ref":"","_id":"5bae5e6c2aa01a00033fcd13"},{"name":"tag.description","type":"string","enumValues":"","default":"","desc":"Description of the new tag","required":false,"in":"body","ref":"","_id":"5bae5e6c2aa01a00033fcd12"}],"url":"/tags","method":"post"},"isReference":true,"order":0,"slug":"create-a-new-tag","type":"endpoint","title":"Create a tag","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"5bef078ded817f00fd2fe19a","category":"5b9b019bcf6a7e000348cf47","parentDoc":"5b9b01bb177e140003c21e4a","createdAt":"2018-11-16T18:08:13.904Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"tag\": {\n \"tagType\": \"contact\",\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"cdate\": \"2018-10-04T14:55:13-05:00\",\n \"subscriber_count\": \"0\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/3/tags/1/contactGoalTags\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200},{"name":"","code":"{\n \"message\": \"No Result found for Tag with id 1\"\n}","language":"json","status":404}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the tag to retrieve","required":false,"in":"path","ref":"","_id":"5bef8c9ca5dcf500e8df1263"}],"url":"/tags/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-tag","type":"endpoint","title":"Retrieve a tag","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bae592eb9539e00039dd882","category":"5b9b019bcf6a7e000348cf47","parentDoc":"5b9b01bb177e140003c21e4a","createdAt":"2018-09-28T16:39:10.333Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"language":"json","code":"{\n\t\"tag\":{\n\t\t\"tag\": \"My Tag\",\n\t\t\"tagType\": \"contact\",\n\t\t\"description\": \"Description\"\n\t}\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"tag\": {\n \"tagType\": \"contact\",\n \"tag\": \"My Tag\",\n \"description\": \"Description\",\n \"cdate\": \"2018-08-17T13:41:16-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/2/contactGoalTags\"\n },\n \"id\": \"2\"\n }\n}","language":"json","status":200}]},"auth":"required","params":[{"name":"tag.tag","type":"string","enumValues":"","default":"","desc":"Name of the tag being updated","required":false,"in":"body","ref":"","_id":"5bb0190ab6fc1000030b06e1"},{"name":"tag.tagType","type":"string","enumValues":"","default":"","desc":"Tag-type of the tag being updated. Possible Values: template, contact","required":false,"in":"body","ref":"","_id":"5bb0190ab6fc1000030b06e0"},{"name":"tag.description","type":"string","enumValues":"","default":"","desc":"Description of the tag being updated","required":false,"in":"body","ref":"","_id":"5bb0190ab6fc1000030b06df"},{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the tag to update","required":false,"in":"path","ref":"","_id":"5bef8cf4f95d82011c6f95e1"}],"url":"/tags/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-tag","type":"endpoint","title":"Update a tag","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5bae5e7c85f2960003bd004f","category":"5b9b019bcf6a7e000348cf47","parentDoc":"5b9b01bb177e140003c21e4a","createdAt":"2018-09-28T17:01:48.014Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Tag with id 1\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the tag to remove","required":false,"in":"path","ref":"","_id":"5bef8cc077f0d40012b11620"}],"url":"/tags/:id","method":"delete","apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]}},"isReference":true,"order":3,"slug":"delete-a-tag","type":"endpoint","title":"Delete a Tag","deprecated":false,"previousSlug":"remove-a-tag","isBodyEmpty":false,"children":[]},{"_id":"5b9b01ef177e140003c21e4c","category":"5b9b019bcf6a7e000348cf47","parentDoc":"5b9b01bb177e140003c21e4a","createdAt":"2018-09-14T00:33:51.743Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"tags\": [\n {\n \"tagType\": \"contact\",\n \"tag\": \"one\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T09:43:15-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/1/contactGoalTags\"\n },\n \"id\": \"1\"\n },\n {\n \"tagType\": \"contact\",\n \"tag\": \"two\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T13:41:16-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/2/contactGoalTags\"\n },\n \"id\": \"2\"\n },\n {\n \"tagType\": \"contact\",\n \"tag\": \"three\",\n \"description\": \"\",\n \"cdate\": \"2018-08-17T13:41:18-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/3/contactGoalTags\"\n },\n \"id\": \"3\"\n },\n {\n \"tagType\": \"template\",\n \"tag\": \"test1\",\n \"description\": \"\",\n \"cdate\": \"2018-08-28T11:54:36-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/4/contactGoalTags\"\n },\n \"id\": \"4\"\n },\n {\n \"tagType\": \"template\",\n \"tag\": \"test2\",\n \"description\": \"\",\n \"cdate\": \"2018-08-28T11:54:38-05:00\",\n \"links\": {\n \"contactGoalTags\": \"https://:account.api-us1.com/api/:version/tags/5/contactGoalTags\"\n },\n \"id\": \"5\"\n }\n ],\n \"meta\": {\n \"total\": \"5\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"search","type":"string","enumValues":"","default":"","desc":"Filter by name of tag(s); \"contains\" operator is assumed.","required":false,"in":"query","ref":"","_id":"5ced3b9a392f790024c12598"},{"name":"filters[search][<operator>]","type":"string","enumValues":"","default":"","desc":"Filters tags by tag name according to the operator specified. Operators currently supported: `eq`, `neq`, `lt`, `lte`, `gt`, `gte`, `contains`, `starts_with`","required":false,"in":"query","ref":"","_id":"63cb00f3363a400047fc329d"},{"name":"orders[search]","type":"enum","enumValues":"weight, asc, desc","default":"","desc":"Orders filtered results by weight, ascending order, or descending order. If `weight` is used, exact matches are returned first, followed by matches starting with what was filtered by, followed by the rest of the results.","required":false,"in":"query","ref":"","_id":"63cb00f3363a400047fc329e"}],"url":"/tags","method":"get"},"isReference":true,"order":4,"slug":"retrieve-all-tags","type":"endpoint","title":"List all tags","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5bad3f41f56aff0003cff86f","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-27T20:36:17.214Z","order":23,"slug":"tasks","title":"Tasks","__v":0,"pages":[{"_id":"58b09a60bf03400f00bf6d2c","api":{"url":"","auth":"required","method":"get","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":""},"type":"basic","createdAt":"2017-02-24T20:41:04.217Z","hidden":false,"isReference":true,"parentDoc":null,"sync_unique":"","link_url":"","slug":"tasks","title":"Tasks","category":"5bad3f41f56aff0003cff86f","link_external":false,"order":0,"deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[{"_id":"58b088aff634c737009157d3","link_external":false,"type":"endpoint","createdAt":"2017-02-24T19:25:35.558Z","slug":"create-task","title":"Create a task","parentDoc":"58b09a60bf03400f00bf6d2c","api":{"results":{"codes":[{"status":201,"language":"json","code":"{\n \"dealTask\": {\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"reltype\":\"Subscriber\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n \"outcomeId\": null,\n\t\t\"outcomeInfo\": null,\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\": \"/1/assignee\",\n }\n }\n}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/dealTasks","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"dealTask\": {\n \"title\":null,\n \"ownerType\":\"contact\",\n \"relid\":\"7\",\n \"status\":0,\n \"note\":\"Testing Task\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"dealTasktype\":\"1\",\n \"assignee\": 2,\n \"triggerAutomationOnCreate\": 100,\n \"doneAutomation\": 101 \n }\n}"}]},"method":"post","params":[{"name":"dealTask.title","type":"string","enumValues":"","default":"","desc":"The title to be assigned to the task","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8ff"},{"name":"dealTask.ownerType","type":"string","enumValues":"","default":"deal","desc":"The name of the relating object. Valid values are `contact` or `deal`. (see relationships table)","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e901"},{"name":"dealTask.relid","type":"int","enumValues":"","default":"","desc":"The id of the relational object for this task","required":true,"in":"body","ref":"","_id":"58ac9e886592a82f0011e902"},{"name":"dealTask.status","type":"int","enumValues":"","default":"","desc":"Task status means complete or incomplete. 1 is complete and 0 is incomplete.","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e900"},{"name":"dealTask.note","type":"string","enumValues":"","default":"","desc":"The content describing the task","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fe"},{"name":"dealTask.duedate","type":"datetime","enumValues":"","default":"","desc":"Due date of the task","required":true,"in":"body","ref":"","_id":"58b090586a9f5c0f00b1853c"},{"name":"dealTask.dealTasktype","type":"int","enumValues":"","default":"","desc":"The type of the task based on the available Task Types in the account","required":true,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fd"},{"name":"dealTask.assignee","type":"int","enumValues":"","default":"","desc":"The id of an user the task will be assigned to","required":false,"in":"body","ref":"","_id":"5d4c40a28372f700121000f6"},{"name":"dealTask.triggerAutomationOnCreate","type":"int","enumValues":"","default":"","desc":"Id of an automation that will be triggered when the task is created.","required":false,"in":"body","ref":"","_id":"60b7bde88929960044f6986f"},{"name":"dealTask.doneAutomation","type":"int","enumValues":"","default":"","desc":"Id of an automation that will be triggered when the task is completed.","required":false,"in":"body","ref":"","_id":"60b7bde88929960044f6986e"}],"apiSetting":"58b53c301065f9c438aa1f77"},"category":"5bad3f41f56aff0003cff86f","hidden":false,"isReference":true,"link_url":"","order":0,"sync_unique":"","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"58b0936c4a13970f0090f25a","slug":"get-task","title":"Retrieve a task","api":{"url":"/dealTasks/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The ID of the task","required":false,"in":"path","ref":"","_id":"58b84e5c9cce072d0084e728"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n \"dealTask\": {\n \"relid\":\"5\",\n \"reltype\":\"Deal\",\n \"dealTasktype\":\"1\",\n \"user\":\"1\",\n \"assignee\": \"2\",\n \"automation\":null,\n \"cdate\":\"2017-02-24T15:01:37-06:00\",\n \"duedate\":\"2017-02-28T12:00:00-06:00\",\n \"edate\":\"2017-02-28T12:15:00-06:00\",\n \"duration\":\"0\",\n \"status\":\"0\",\n \"title\":\"\",\n \"note\":\"Deal task title!\",\n \"donedate\":null,\n \"doneAutomation\":null,\n \"udate\":\"2017-02-24T15:01:37-06:00\",\n \"owner\":{\n \"type\":\"deal\",\n \"id\":\"5\"\n },\n \"id\":\"1\",\n \"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\": \"/1/assignee\"\n }\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","apiSetting":"58b53c301065f9c438aa1f77"},"link_external":false,"order":1,"parentDoc":"58b09a60bf03400f00bf6d2c","hidden":false,"isReference":true,"link_url":"","category":"5bad3f41f56aff0003cff86f","createdAt":"2017-02-24T20:11:24.513Z","sync_unique":"","type":"endpoint","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"58b44a57f2483d0f00dfa3ce","order":2,"slug":"update-task","isReference":true,"link_url":"","parentDoc":"58b09a60bf03400f00bf6d2c","sync_unique":"","type":"endpoint","createdAt":"2017-02-27T15:48:39.764Z","api":{"method":"put","params":[{"name":"dealTask.title","type":"string","enumValues":"","default":"","desc":"The title to be assigned to the task","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8ff"},{"name":"dealTask.ownerType","type":"string","enumValues":"","default":"deal","desc":"The name of the relating object. Valid values are `contact` or `deal`. (see relationships table)","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e901"},{"name":"dealTask.relid","type":"int","enumValues":"","default":"","desc":"The id of the relational object for this task","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e902"},{"name":"dealTask.status","type":"int","enumValues":"","default":"","desc":"Task status means complete or incomplete. 1 is complete and 0 is incomplete.","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e900"},{"name":"dealTask.note","type":"string","enumValues":"","default":"","desc":"The content describing the task","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fe"},{"name":"dealTask.duedate","type":"datetime","enumValues":"","default":"","desc":"Due date of the task","required":false,"in":"body","ref":"","_id":"58b090586a9f5c0f00b1853c"},{"name":"dealTask.dealTasktype","type":"int","enumValues":"","default":"","desc":"The type of the task based on the available Task Types in the account","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fd"},{"name":"id","type":"int","enumValues":"","default":"","desc":"The ID of the task","required":false,"in":"path","ref":"","_id":"58b84ef858927d230065b66c"},{"name":"dealTask.assignee","type":"int","enumValues":"","default":"","desc":"The id of an user the task will be assigned to","required":false,"in":"body","ref":"","_id":"5d4c41731ae0b20050cb161a"},{"name":"dealTask.outcomeId","type":"int","enumValues":"","default":"","desc":"Task outcome's id is required at the time of task being completed.","required":false,"in":"body","ref":"","_id":"609ed771f0414701becea4f7"},{"name":"dealTask.outcomeInfo","type":"string","enumValues":"","default":"","desc":"More information about task completion with the outcome selection.","required":false,"in":"body","ref":"","_id":"609ed771f0414701becea4f6"}],"results":{"codes":[{"name":"","code":"{\n \"dealTask\": {\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"ownerType\":\"contact\",\n \"dealTasktype\":\"1\",\n \"assignee\":\"2\"\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n\t\t\"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/1/user\",\n \"assignee\":\"/1/assignee\"\n }\n }\n}","language":"json","status":201},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","url":"/dealTasks/:id","auth":"required","examples":{"codes":[{"code":"{\n\t\"dealTask\": {\n\t\t\"assignee\":\"2\",\n\t\t\"dealTasktype\":\"1\",\n\t\t\"duedate\":\"2017-02-25T12:00:00-06:00\",\n\t\t\"edate\":\"2017-02-25T12:15:00-06:00\",\n\t\t\"note\":\"Testing Task\",\n\t\t\"ownerType\":\"contact\",\n\t\t\"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n\t\t\"relid\":\"7\",\n\t\t\"status\":0,\n\t\t\"title\":null,\n\t}\n}","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"category":"5bad3f41f56aff0003cff86f","hidden":false,"link_external":false,"title":"Update a task","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"58b091f3bf03400f00bf6d13","sync_unique":"","title":"Delete a task","type":"endpoint","link_url":"","hidden":false,"order":3,"parentDoc":"58b09a60bf03400f00bf6d2c","createdAt":"2017-02-24T20:05:07.675Z","slug":"delete-task","category":"5bad3f41f56aff0003cff86f","isReference":true,"link_external":false,"api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"_id":"5942a8ca5e6b7f000f386c15","ref":"","in":"path","required":false,"desc":"The task id","default":"","type":"int","name":"id"}],"results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","url":"/dealTasks/:id","apiSetting":"58b53c301065f9c438aa1f77"},"isBodyEmpty":true,"children":[]},{"_id":"58b44e182654c60f00997d57","hidden":false,"isReference":true,"link_external":false,"order":4,"parentDoc":"58b09a60bf03400f00bf6d2c","slug":"list-all-tasks","title":"List all tasks","api":{"settings":"","url":"/dealTasks","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"filters[title]","type":"string","enumValues":"","default":"","desc":"The title to be assigned to the task","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e8ff"},{"name":"filters[reltype]","type":"string","enumValues":"","default":"","desc":"The name of the relating object (see relationships table)","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e901"},{"name":"filters[relid]","type":"int","enumValues":"","default":"","desc":"The id of the relational object for this task","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e902"},{"name":"filters[status]","type":"int","enumValues":"","default":"","desc":"Task status means complete or incomplete. 1 is complete and 0 is incomplete.","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e900"},{"name":"filters[note]","type":"string","enumValues":"","default":"","desc":"The content describing the task","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e8fe"},{"name":"filters[duedate]","type":"datetime","enumValues":"","default":"","desc":"Due date of the task","required":false,"in":"query","ref":"","_id":"58b090586a9f5c0f00b1853c"},{"name":"filters[d_tasktypeid]","type":"int","enumValues":"","default":"","desc":"The type of the task based on the available Task Types in the account","required":false,"in":"query","ref":"","_id":"58ac9e886592a82f0011e8fd"},{"name":"filters[userid]","type":"int","enumValues":"","default":"","desc":"User ID this task belongs to","required":false,"in":"query","ref":"","_id":"58b8800a35126719006b6a3c"},{"name":"filters[due_after]","type":"string","enumValues":"","default":"","desc":"Filter deal tasks that are due after a specific date","required":false,"in":"query","ref":"","_id":"5df27635780efc005e5570bf"},{"name":"Fitlers[due_before]","type":"string","enumValues":"","default":"","desc":"Filter deal tasks that are due before a specific date","required":false,"in":"query","ref":"","_id":"5df27635780efc005e5570be"},{"name":"filters[duedate_range]","type":"string","enumValues":"","default":"","desc":"Filter deal tasks that are due between specific date range","required":false,"in":"query","ref":"","_id":"5df27635780efc005e5570bd"},{"name":"filters[assignee_userid]","type":"int","enumValues":"","default":"","desc":"The id of the user a task is assigned to","required":false,"in":"query","ref":"","_id":"5f038397ea155b001d7fe74d"},{"name":"filters[outcome_id]","type":"int","enumValues":"","default":"","desc":"The id of a task outcome that the task belongs to.","required":false,"in":"query","ref":"","_id":"609ed870fc637e002dd20cca"}],"results":{"codes":[{"code":"{\n \"dealTasks\": [{\n \"id\":\"1\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task\",\n \"relid\":\"7\",\n \"reltype\":\"Subscriber\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"contact\",\n \"id\":\"7\"\n },\n \"outcomeId\": null,\n\t\t\"outcomeInfo\": null,\n \"links\": {\n \"activities\":\"/1/activities\",\n \"automation\":\"/1/automation\",\n \"dealTasktype\":\"/1/dealTasktype\",\n \"doneAutomation\":\"/1/doneAutomation\",\n \"notes\":\"/1/notes\",\n \"owner\":\"/1/owner\",\n \"taskNotifications\":\"/1/taskNotifications\",\n \"user\":\"/3/dealTasks/1/user\",\n \"assignee\":\"/1/assignee\"\n }\n },\n {\n \"id\":\"2\",\n \"duedate\":\"2017-02-25T12:00:00-06:00\",\n \"edate\":\"2017-02-25T12:15:00-06:00\",\n \"status\":0,\n \"title\":null,\n \"note\":\"Testing Task 2\",\n \"relid\":\"8\",\n \"reltype\":\"Deal\",\n \"dealTasktype\":\"1\",\n \"cdate\":\"2017-02-24T13:21:56-06:00\",\n \"udate\":\"2017-02-24T13:21:56-06:00\",\n \"automation\":null,\n \"doneAutomation\":null,\n \"user\":\"1\",\n \"assignee\":\"2\",\n \"owner\":{\n \"type\":\"deal\",\n \"id\":\"5\"\n },\n \"outcomeId\": 91,\n\t\t\"outcomeInfo\": \"More details about the outcome\",\n \"links\": {\n \"activities\":\"/2/activities\",\n \"automation\":\"/2/automation\",\n \"dealTasktype\":\"/2/dealTasktype\",\n \"doneAutomation\":\"/2/doneAutomation\",\n \"notes\":\"/2/notes\",\n \"owner\":\"/2/owner\",\n \"taskNotifications\":\"/2/taskNotifications\",\n \"user\":\"/2/user\",\n \"assignee\":\"/1/assignee\"\n }\n }],\n \"meta\":{\n \"total\":\"2\"\n }\n}","name":"","status":201,"language":"json"},{"status":400,"language":"json","code":"{}","name":""}]},"apiSetting":"58b53c301065f9c438aa1f77"},"link_url":"","createdAt":"2017-02-27T16:04:40.312Z","sync_unique":"","type":"endpoint","category":"5bad3f41f56aff0003cff86f","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]}]}]},{"_id":"609d734d2db60f0028e7de3e","title":"Task Outcomes","slug":"task-outcomes","order":24,"reference":true,"isAPI":false,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2021-05-13T18:43:25.593Z","__v":0,"pages":[{"_id":"609d7369a260210080c52774","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Task Outcomes","type":"basic","slug":"task-outcomes","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-13T18:43:53.475Z","category":"609d734d2db60f0028e7de3e","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"609d738907520a006c938159","api":{"method":"post","url":"/taskOutcomes","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"created_by\": \"1\",\n \"disabled\": \"\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"name":"","status":422,"language":"json","code":"{\n \"errors\": [\n {\n \"title\": \"The taskOutcome title was not provided.\",\n \"detail\": \"\",\n \"code\": \"field_missing\",\n \"error\": \"taskOutcome_title_was_not_provided\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}"},{"code":"{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}","language":"text","status":422}]},"examples":{"codes":[{"language":"json","code":"{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"Positive\"\n }\n}"}]},"params":[{"name":"title","type":"string","enumValues":"","default":"","desc":"Title of the outcome","required":true,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"sentiment","type":"enum","enumValues":"Positive, Neutral, or Negative","default":"","desc":"Sentiment of the outcome. Only three values are currently allowed.","required":true,"in":"body","ref":"","_id":"609d75101e96b50067060471"},{"name":"disabled","type":"enum","enumValues":"0 or 1","default":"","desc":"1 is for disabled and 0 is for active outcome.","required":false,"in":"body","ref":"","_id":"609e9b520a75290010cd34f9"}],"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a task outcome","type":"endpoint","slug":"create-a-task-outcome","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"609d7369a260210080c52774","createdAt":"2021-05-13T18:44:25.761Z","category":"609d734d2db60f0028e7de3e","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"609d73b2da916700312c20e8","api":{"method":"get","url":"/taskOutcomes/:id","auth":"required","examples":{"codes":[]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Task outcome's id","required":false,"in":"path","ref":"","_id":"58b877fa0845ce0f007001fa"}],"results":{"codes":[{"language":"json","code":"{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}","name":"","status":200},{"code":"{\n \"message\": \"No Result found for TaskOutcome with id 111\"\n}","name":"","status":404,"language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Retrieve a task outcome","type":"endpoint","slug":"retrieve-a-task-outcome","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"609d7369a260210080c52774","createdAt":"2021-05-13T18:45:06.144Z","category":"609d734d2db60f0028e7de3e","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"609d73d7ac20a400daa1b716","api":{"method":"put","url":"/taskOutccomes/:id","auth":"required","params":[{"name":"title","type":"string","enumValues":"","default":"","desc":"Task outcome's title. The title should be unique among task outcomes.","required":true,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"id","type":"int","enumValues":"","default":"","desc":"Task outcome's id","required":false,"in":"path","ref":"","_id":"58b88177b9f4fc2d0021b05a"},{"name":"sentiment","type":"enum","enumValues":"Positive, Neutral, or Negative","default":"","desc":"Sentiment of the outcome. Only three values are currently allowed.","required":true,"in":"body","ref":"","_id":"609e9bf4f0795200458c3446"},{"name":"disabled","type":"enum","enumValues":"0 or 1","default":"","desc":"1 is for disabled and 0 is for active outcome.","required":false,"in":"body","ref":"","_id":"609e9cc77784d9004530a838"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"taskOutcome\": {\n \"title\": \"Interested\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"code":"{\n \"errors\": [\n {\n \"title\": \"A task outcome with the same title already exists.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/title\"\n }\n },\n {\n \"title\": \"Sentiment value must be one of Positive, Neutral, or Negative.\",\n \"detail\": \"\",\n \"code\": \"field_invalid\",\n \"error\": \"\",\n \"source\": {\n \"pointer\": \"/data/attributes/sentiment\"\n }\n }\n ]\n}","language":"text","status":422}]},"examples":{"codes":[{"language":"json","code":"{\n \"taskOutcome\": {\n \"sentiment\": \"Neutral\"\n }\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Update a task outcome","type":"endpoint","slug":"update-a-task-outcome","order":2,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"609d7369a260210080c52774","createdAt":"2021-05-13T18:45:43.073Z","category":"609d734d2db60f0028e7de3e","isBodyEmpty":true,"children":[]},{"_id":"609d73cb2490bc00793e1e09","api":{"method":"delete","url":"/taskOutccomes/:id","auth":"required","examples":{"codes":[]},"params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"Task outcome's id","required":false,"in":"path","ref":"","_id":"58b877fa0845ce0f007001fa"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"code":"{\n \"message\": \"No Result found for TaskOutcome with id 111\"\n}","language":"text","status":404}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a task outcome","type":"endpoint","slug":"delete-a-task-outcome","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"609d7369a260210080c52774","createdAt":"2021-05-13T18:45:31.178Z","category":"609d734d2db60f0028e7de3e","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"609d844f11107b005441eaae","api":{"method":"get","url":"/taskOutcomes","auth":"required","params":[{"name":"filters[sentiment]","type":"enum","enumValues":"1, 2 or 3","default":"","desc":"1 is for Negative, 2 is for Neutral and 3 is for Positive","required":false,"in":"query","ref":"","_id":"609e9fa593f07c0023350afa"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"taskOutcomes\": [\n {\n \"title\": \"Interested\",\n \"sentiment\": \"POSITIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:26:15-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:56-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/1/dealTasks\"\n },\n \"id\": \"1\"\n },\n {\n \"title\": \"Not Interested\",\n \"sentiment\": \"NEGATIVE\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:27:01-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:01-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/2/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/2/dealTasks\"\n },\n \"id\": \"2\"\n },\n {\n \"title\": \"Left a voicemail\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"0\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:27:13-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:27:13-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/3/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/3/dealTasks\"\n },\n \"id\": \"3\"\n },\n {\n \"title\": \"Disabled outcome\",\n \"sentiment\": \"NEUTRAL\",\n \"disabled\": \"1\",\n \"created_by\": \"1\",\n \"updated_by\": \"1\",\n \"created_utc_timestamp\": \"2021-02-16T12:28:27-06:00\",\n \"updated_utc_timestamp\": \"2021-02-16T12:28:27-06:00\",\n \"dealTasktype_ids\": [],\n \"links\": {\n \"tasktypeOutcomeRels\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/4/tasktypeOutcomeRels\",\n \"dealTasks\": \"https://youraccountname.api-us1.com/api/3/taskOutcomes/4/dealTasks\"\n },\n \"id\": \"4\"\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}"},{"language":"json","code":"{}","name":"","status":400}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List all task outcomes","type":"endpoint","slug":"list-all-task-outcomes","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-all-task-outcomes-1","parentDoc":"609d7369a260210080c52774","createdAt":"2021-05-13T19:55:59.940Z","category":"609d734d2db60f0028e7de3e","isBodyEmpty":true,"children":[]}]}]},{"_id":"5bad3f4f25ecd000036a151f","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-27T20:36:31.008Z","order":25,"slug":"task-types","title":"Task Types","__v":0,"pages":[{"_id":"58b72d13b72a430f007fa053","title":"Task Types","parentDoc":null,"order":0,"slug":"deal-task-types","type":"basic","hidden":false,"createdAt":"2017-03-01T20:20:35.923Z","isReference":true,"category":"5bad3f4f25ecd000036a151f","link_external":false,"link_url":"","sync_unique":"","api":{"params":[],"url":"","method":"get","results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required"},"isBodyEmpty":true,"children":[{"_id":"58b877b80845ce0f007001f7","parentDoc":"58b72d13b72a430f007fa053","type":"endpoint","category":"5bad3f4f25ecd000036a151f","hidden":false,"isReference":true,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:28:53-06:00\",\n \"defduration\": \"0\",\n \"id\": \"7\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Skype\",\n \"udate\": \"2017-03-02T14:28:53-06:00\"\n }\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"url":"/dealTasktypes","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"dealTasktype\": {\n \"title\": \"Skype\",\n \"status\": 0\n }\n}"}]},"method":"post","params":[{"name":"dealTasktype.title","type":"string","enumValues":"","default":"","desc":"Deal task type's title. The title should be unique among deal task types.","required":true,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"dealTasktype.status","type":"enum","enumValues":"0,1","default":"","desc":"0 - Active status, 1 - Disabled status","required":false,"in":"body","ref":"","_id":"60ca77cd0770c1007e71483d"}],"apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-03-02T19:51:20.479Z","order":0,"sync_unique":"","title":"Create a task type","link_url":"","slug":"create-a-deal-task-type","link_external":false,"previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"58b877fa0845ce0f007001f9","link_external":false,"order":1,"slug":"retrieve-a-deal-task-type","hidden":false,"api":{"examples":{"codes":[]},"method":"get","params":[{"_id":"58b877fa0845ce0f007001fa","ref":"","in":"path","required":false,"desc":"Deal task type's id","default":"","type":"int","name":"id"}],"results":{"codes":[{"language":"json","code":"{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:22:51-06:00\",\n \"defduration\": \"0\",\n \"id\": \"5\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Skype\",\n \"udate\": \"2017-03-02T14:22:51-06:00\"\n }\n}","name":"","status":200},{"code":"{}","name":"","status":400,"language":"json"}]},"url":"/dealTasktypes/:id","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"category":"5bad3f4f25ecd000036a151f","createdAt":"2017-03-02T19:52:26.951Z","link_url":"","title":"Retrieve a task type","sync_unique":"","isReference":true,"parentDoc":"58b72d13b72a430f007fa053","type":"endpoint","isBodyEmpty":true,"children":[]},{"_id":"58b88177b9f4fc2d0021b059","parentDoc":"58b72d13b72a430f007fa053","title":"Update a task type","hidden":false,"isReference":true,"order":2,"api":{"params":[{"name":"dealTasktype.title","type":"string","enumValues":"","default":"","desc":"Deal task type's title. The title should be unique among deal task types.","required":false,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal task type's id","required":false,"in":"path","ref":"","_id":"58b88177b9f4fc2d0021b05a"},{"name":"dealTasktype.status","type":"enum","enumValues":"0,1","default":"0","desc":"0 - Active status, 1 - Disabled status","required":false,"in":"body","ref":"","_id":"60ca780d4f155f007e5112c6"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealTasktype\": {\n \"cdate\": \"2017-03-02T14:28:53-06:00\",\n \"defduration\": \"0\",\n \"id\": \"7\",\n \"links\": [],\n \"status\": \"1\",\n \"title\": \"Meet in person\",\n \"udate\": \"2017-03-02T14:32:20-06:00\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"url":"/dealTasktypes/:id","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"dealTasktype\": {\n \"title\": \"Meet in person\",\n \"status\": 1\n }\n}"}]},"method":"put","apiSetting":"58b53c301065f9c438aa1f77"},"category":"5bad3f4f25ecd000036a151f","createdAt":"2017-03-02T20:32:55.914Z","link_external":false,"link_url":"","slug":"update-a-deal-task-type","sync_unique":"","type":"endpoint","previousSlug":"","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"58b8780e0845ce0f007001fd","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal task type's id","required":false,"in":"path","ref":"","_id":"58b877fa0845ce0f007001fa"}],"results":{"codes":[{"name":"","status":403,"language":"json","code":"{}"}]},"url":"/dealTasktypes/:id","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-03-02T19:52:46.530Z","hidden":false,"order":3,"title":"Delete a task type","category":"5bad3f4f25ecd000036a151f","link_url":"","parentDoc":"58b72d13b72a430f007fa053","sync_unique":"","type":"endpoint","isReference":true,"link_external":false,"slug":"delete-a-deal-task-type","deprecated":false,"icon":"","previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58b8782e24d0680f005dd1c1","hidden":false,"link_url":"","slug":"list-all-deal-task-types","sync_unique":"","title":"List all task types","api":{"params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"dealTasktypes\": [\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"1\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Call\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"2\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Email\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"3\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Lunch\",\n \"udate\": null\n },\n {\n \"cdate\": null,\n \"defduration\": \"0\",\n \"id\": \"4\",\n \"links\": [],\n \"status\": \"0\",\n \"title\": \"Meeting\",\n \"udate\": null\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}"},{"language":"json","code":"{}","name":"","status":400}]},"url":"/dealTasktypes","auth":"required","examples":{"codes":[]},"method":"get","apiSetting":"58b53c301065f9c438aa1f77"},"category":"5bad3f4f25ecd000036a151f","link_external":false,"order":4,"isReference":true,"parentDoc":"58b72d13b72a430f007fa053","createdAt":"2017-03-02T19:53:18.336Z","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"59306ae5e88c60001bdf78a8","category":"5bad3f4f25ecd000036a151f","parentDoc":"58b72d13b72a430f007fa053","createdAt":"2017-06-01T19:28:37.431Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[{"code":"{\n \"dealTask\": {\n \"dealTasktype\": \"2\"\n }\n}","language":"json"}]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"dealTasks\": [\n {\n \"automation\": null,\n \"cdate\": \"2017-06-01T15:08:55-05:00\",\n \"dealTasktype\": \"2\",\n \"doneAutomation\": null,\n \"donedate\": null,\n \"duedate\": \"2017-06-02T12:00:00-05:00\",\n \"duration\": \"0\",\n \"edate\": \"2017-06-02T12:15:00-05:00\",\n \"id\": \"1\",\n \"links\": {\n \"activities\": \"/api/3/dealTasks/1/activities\",\n \"automation\": \"/api/3/dealTasks/1/automation\",\n \"dealTasktype\": \"/api/3/dealTasks/1/dealTasktype\",\n \"doneAutomation\": \"/api/3/dealTasks/1/doneAutomation\",\n \"notes\": \"/api/3/dealTasks/1/notes\",\n \"owner\": \"/api/3/dealTasks/1/owner\",\n \"taskNotifications\": \"/api/3/dealTasks/1/taskNotifications\",\n \"user\": \"/api/3/dealTasks/1/user\"\n },\n \"note\": \"Call Steve\",\n \"owner\": {\n \"id\": \"1\",\n \"type\": \"deal\"\n },\n \"relid\": \"1\",\n \"reltype\": \"Deal\",\n \"status\": \"0\",\n \"title\": \"\",\n \"udate\": \"2017-06-01T15:08:55-05:00\",\n \"user\": \"1\"\n }\n ],\n \"deals\": [\n {\n \"activitycount\": \"2\",\n \"cdate\": \"2017-06-01T15:08:41-05:00\",\n \"contact\": \"1\",\n \"currency\": \"usd\",\n \"edate\": \"0000-00-00 00:00:00\",\n \"group\": \"1\",\n \"hash\": \"3abd127b\",\n \"id\": \"1\",\n \"links\": {\n \"activities\": \"/api/3/deals/1/activities\",\n \"contact\": \"/api/3/deals/1/contact\",\n \"contactDeals\": \"/api/3/deals/1/contactDeals\",\n \"group\": \"/api/3/deals/1/group\",\n \"nextTask\": \"/api/3/deals/1/nextTask\",\n \"notes\": \"/api/3/deals/1/notes\",\n \"organization\": \"/api/3/deals/1/organization\",\n \"owner\": \"/api/3/deals/1/owner\",\n \"scoreValues\": \"/api/3/deals/1/scoreValues\",\n \"stage\": \"/api/3/deals/1/stage\",\n \"tasks\": \"/api/3/deals/1/tasks\"\n },\n \"mdate\": \"2017-06-01T15:08:55-05:00\",\n \"nextTask\": \"1\",\n \"nextdate\": \"2017-06-02T12:00:00-05:00\",\n \"nextdealid\": \"1\",\n \"nexttaskid\": \"1\",\n \"organization\": null,\n \"owner\": \"1\",\n \"percent\": \"0\",\n \"stage\": \"1\",\n \"status\": \"0\",\n \"title\": \"New deal\",\n \"value\": \"10000\"\n }\n ]\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"name":"dealTask.dealTasktype","type":"string","enumValues":"","default":"","desc":"Deal task type's id to move deal tasks to","required":false,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"id","type":"int","enumValues":"","default":"","desc":"Deal task type's id","required":false,"in":"path","ref":"","_id":"58b88177b9f4fc2d0021b05a"}],"url":"/dealTasktypes/:id/dealTasks","method":"put","apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"order":5,"slug":"move-deal-tasks-to-another-deal-task-type","type":"endpoint","title":"Move tasks to another task type","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"609d8058fca70d0040bb3111","title":"Task Types and Outcomes Relations","slug":"task-type-outcome-relations","order":26,"reference":true,"isAPI":false,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2021-05-13T19:39:04.932Z","__v":0,"pages":[{"_id":"609d8078daa4f700441a144d","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Task Types and Outcomes Relations","type":"basic","slug":"task-type-outcome-relations","order":0,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2021-05-13T19:39:36.666Z","category":"609d8058fca70d0040bb3111","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"609d824f53ce37002a3d67df","api":{"method":"get","url":"/tasktypeOutcomeRels/:id","auth":"required","examples":{"codes":[]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Task type - outcome relation's id","required":false,"in":"path","ref":"","_id":"58b877fa0845ce0f007001fa"}],"results":{"codes":[{"language":"json","code":"{\n \"tasktypeOutcomeRel\": {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"9\",\n \"display_order\": \"0\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-05T15:19:36-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-05 15:19:36\",\n \"links\": {\n \"tasktype\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/tasktype\",\n \"outcome\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/outcome\",\n \"createdBy\": \"http://hosted.localdev/api/3/tasktypeOutcomeRels/1/createdBy\"\n },\n \"id\": \"1\",\n \"tasktype\": \"1\",\n \"outcome\": \"1\",\n \"createdBy\": \"1\"\n }\n}","name":"","status":200},{"code":"{\n \"message\": \"No Result found for TasktypeOutcomeRel with id 111\"\n}","name":"","status":404,"language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Retrieve a task type - outcome relation","type":"endpoint","slug":"retrieve-a-task-type-outcome-relation","order":1,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-a-task-outcome-1","parentDoc":"609d8078daa4f700441a144d","createdAt":"2021-05-13T19:47:27.216Z","category":"609d8058fca70d0040bb3111","deprecated":false,"isBodyEmpty":false,"children":[]},{"_id":"609d830e1729790048bbe1f1","api":{"method":"delete","url":"/tasktypeOutcomeRels/:id","auth":"required","examples":{"codes":[]},"params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"Task type - outcome relation's id","required":false,"in":"path","ref":"","_id":"58b877fa0845ce0f007001fa"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"code":"{\n \"message\": \"No Result found for TasktypeOutcomeRel with id 111\"\n}","language":"text","status":404}]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Delete a task type - outcome relation","type":"endpoint","slug":"delete-a-task-type-outcome-relation","order":3,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"delete-a-task-outcome-1","parentDoc":"609d8078daa4f700441a144d","createdAt":"2021-05-13T19:50:38.230Z","category":"609d8058fca70d0040bb3111","isBodyEmpty":false,"children":[]},{"_id":"609d73eb38c6fc0016096c90","api":{"method":"get","url":"/tasktypeOutcomeRels","auth":"required","params":[],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"tasktypeOutcomeRels\": [\n {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"9\",\n \"display_order\": \"0\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:06-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:06\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/57/createdBy\"\n },\n \"id\": \"1\",\n \"tasktype\": \"1\",\n \"outcome\": \"9\",\n \"createdBy\": \"1\"\n },\n {\n \"tasktype_id\": \"1\",\n \"outcome_id\": \"10\",\n \"display_order\": \"1\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:06-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:06\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/58/createdBy\"\n },\n \"id\": \"2\",\n \"tasktype\": \"1\",\n \"outcome\": \"10\",\n \"createdBy\": \"1\"\n },\n {\n \"tasktype_id\": \"2\",\n \"outcome_id\": \"9\",\n \"display_order\": \"2\",\n \"created_by\": \"0\",\n \"created_utc_timestamp\": \"2021-04-02T12:06:07-05:00\",\n \"updated_by\": null,\n \"updated_utc_timestamp\": \"2021-04-02 12:06:07\",\n \"links\": {\n \"tasktype\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/tasktype\",\n \"outcome\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/outcome\",\n \"createdBy\": \"https://youraccountname.api-us1.com/api/3/tasktypeOutcomeRels/60/createdBy\"\n },\n \"id\": \"3\",\n \"tasktype\": \"2\",\n \"outcome\": \"9\",\n \"createdBy\": \"1\"\n }\n ],\n \"meta\": {\n \"total\": \"3\"\n }\n}"},{"language":"json","code":"{}","name":"","status":400}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"title":"List all task type - outcome relations","type":"endpoint","slug":"list-all-task-type-outcome-relations","order":4,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"list-all-task-outcomes","parentDoc":"609d8078daa4f700441a144d","createdAt":"2021-05-13T18:46:03.183Z","category":"609d8058fca70d0040bb3111","isBodyEmpty":true,"children":[]}]}]},{"_id":"6283c8636cbbce009dc7e5f8","title":"Task Reminders/Notifications","slug":"task-remindersnotifications","order":27,"reference":true,"project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","createdAt":"2022-05-17T16:08:03.269Z","__v":0,"pages":[{"_id":"6283c87a9137c101716bfb73","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Task Reminders/Notifications","type":"basic","slug":"task-remindersnotifications","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","createdAt":"2022-05-17T16:08:26.832Z","category":"6283c8636cbbce009dc7e5f8","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"6283c90c075b1f00aa074357","api":{"method":"post","url":"/taskNotifications","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"","name":""},{"name":"","status":422,"language":"json","code":""}]},"examples":{"codes":[{"language":"json","code":"{\n \"taskNotification\": {\n \"dealTask\": \"1\",\n \"interval\": \"123\"\n }\n}"}]},"params":[{"name":"dealTask","type":"string","enumValues":"","default":"","desc":"ID of task","required":true,"in":"body","ref":"","_id":"58b8810cf0680c2d0033e87b"},{"name":"interval","type":"int","enumValues":"Positive, Neutral, or Negative","default":"","desc":"Amount of time in minutes that a reminder will be sent to a task assignee ahead of task's due date.","required":true,"in":"body","ref":"","_id":"609d75101e96b50067060471"}],"apiSetting":"58b53c301065f9c438aa1f77"},"title":"Create a task reminder","type":"endpoint","slug":"create-a-task-reminder","order":0,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"","parentDoc":"6283c87a9137c101716bfb73","createdAt":"2022-05-17T16:10:52.587Z","category":"6283c8636cbbce009dc7e5f8","icon":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"5b9af9bccd7ed6000349448f","project":"57b6f40e480bae1900ce4e21","version":"57b6f40e480bae1900ce4e24","isAPI":false,"reference":true,"createdAt":"2018-09-13T23:58:52.983Z","from_sync":false,"order":28,"slug":"templates","title":"Templates","__v":0,"pages":[{"_id":"5b9af9c5be532f00037e75d3","category":"5b9af9bccd7ed6000349448f","createdAt":"2018-09-13T23:59:01.068Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":0,"slug":"templates","type":"basic","title":"Templates","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5b9afa49cf6a7e000348ceed","category":"5b9af9bccd7ed6000349448f","parentDoc":"5b9af9c5be532f00037e75d3","createdAt":"2018-09-14T00:01:13.647Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"template\": {\n \"userid\": \"1\",\n \"ed_instanceid\": \"0\",\n \"ed_version\": \"0\",\n \"name\": \"Test 2\",\n \"subject\": null,\n \"content\": \"sdsf\",\n \"categoryid\": \"1\",\n \"used\": \"1\",\n \"waitpreview\": \"1\",\n \"importnum\": \"0\",\n \"mdate\": \"2018-08-28 11:54:54\",\n \"preview_content\": null,\n \"modified\": \"1\",\n \"hidden\": \"0\",\n \"links\": [],\n \"id\": \"2\"\n }\n}","name":""},{"status":404,"language":"json","code":"{\n \"message\": \"No Result found for Template with id 10\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the template to retrieve","required":false,"in":"path","ref":"","_id":"5b9afa49cf6a7e000348ceee"}],"url":"/templates/:id","method":"get"},"isReference":true,"order":0,"slug":"retrieve-a-template","type":"endpoint","title":"Retrieve a template","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]}]},{"_id":"58ac99cca7906a2f0076ab67","project":"57b6f40e480bae1900ce4e21","createdAt":"2017-02-21T19:49:32.149Z","order":29,"title":"Users","__v":0,"version":"57b6f40e480bae1900ce4e24","sync":{"url":"","isSync":false},"reference":true,"from_sync":false,"slug":"users","pages":[{"_id":"5924a2ecba8cdc0f00c98ffc","slug":"users","sync_unique":"","api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"language":"json","code":"{}","name":"","status":400}]},"auth":"required","params":[],"url":"","method":"get"},"hidden":false,"isReference":true,"parentDoc":null,"createdAt":"2017-05-23T21:00:28.955Z","type":"basic","link_url":"","order":0,"title":"Users","category":"58ac99cca7906a2f0076ab67","link_external":false,"isBodyEmpty":true,"children":[{"_id":"58ac9a301909810f00fda9fe","link_url":"","parentDoc":"5924a2ecba8cdc0f00c98ffc","slug":"create-user","type":"endpoint","createdAt":"2017-02-21T19:51:12.386Z","order":0,"sync_unique":"","title":"Create a user","api":{"auth":"required","examples":{"codes":[{"code":"{\n\t\"user\": {\n\t\t\"username\": \"jdoe\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"password\": \"myPa$$w0rd\",\n \"group\": 4\n\t}\n}","language":"json"}]},"method":"post","params":[{"name":"user.username","type":"string","enumValues":"","default":"","desc":"Username","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e902"},{"name":"user.email","type":"string","enumValues":"","default":"","desc":"Email address","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e901"},{"name":"user.firstName","type":"string","enumValues":"","default":"","desc":"First name","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e900"},{"name":"user.lastName","type":"string","enumValues":"","default":"","desc":"Last name","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8ff"},{"name":"user.group","type":"int","enumValues":"","default":"?","desc":"Group ID","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fe"},{"name":"user.password","type":"string","enumValues":"","default":"","desc":"Plain text password","required":false,"in":"body","ref":"","_id":"58ac9e886592a82f0011e8fd"}],"results":{"codes":[{"status":201,"language":"json","code":"{\n \"user\": {\n \"username\": \"jdoe\",\n \"email\": \"johndoe@example.com\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"lang\": \"english\",\n \"localZoneid\": \"America/New_York\",\n \"cdate\": \"2022-02-02T16:01:44-06:00\",\n \"udate\": \"2022-02-02T16:01:44-06:00\",\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/3/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/3/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/3/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/3/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/3/configs\",\n \"dealConnection\": \"https://:account.api-us1.com/api/3/users/3/dealConnection\",\n \"userConversationsPermission\": \"https://:account.api-us1.com/api/3/users/3/userConversationsPermission\",\n \"seatUser\": \"https://:account.api-us1.com/api/3/users/3/seatUser\"\n },\n \"id\": \"3\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users","apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"isReference":true,"link_external":false,"category":"58ac99cca7906a2f0076ab67","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9a14a7906a2f0076ab68","hidden":false,"parentDoc":"5924a2ecba8cdc0f00c98ffc","order":1,"sync_unique":"","title":"Retrieve a user","link_url":"","category":"58ac99cca7906a2f0076ab67","isReference":true,"link_external":false,"slug":"get-user","api":{"url":"/users/:id","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the user you want to view","required":false,"in":"path","ref":"","_id":"58ac9d342bed2d3b000731ce"}],"results":{"codes":[{"name":"","code":"{\n \"user\": {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-02-21T19:50:44.049Z","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9abe1909810f00fdaa03","slug":"get-user-email","category":"58ac99cca7906a2f0076ab67","link_external":false,"order":2,"hidden":false,"sync_unique":"","api":{"settings":"","url":"/users/email/:email","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"email","type":"string","enumValues":"","default":"","desc":"Email address of the user you want to view","required":false,"in":"path","ref":"","_id":"58aca4506592a82f0011e912"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"user\": {\n \"username\": \"somebody\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}","name":""},{"name":"","status":400,"language":"json","code":"{}"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"isReference":true,"link_url":"","type":"endpoint","createdAt":"2017-02-21T19:53:34.798Z","parentDoc":"5924a2ecba8cdc0f00c98ffc","title":"Retrieve a user by email","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9ace8077f60f00b339b2","parentDoc":"5924a2ecba8cdc0f00c98ffc","type":"endpoint","createdAt":"2017-02-21T19:53:50.292Z","isReference":true,"link_url":"","sync_unique":"","api":{"examples":{"codes":[]},"method":"get","params":[{"name":"username","type":"string","enumValues":"","default":"","desc":"Username of the user you want to view","required":false,"in":"path","ref":"","_id":"58acb02e5303921b007a5cc8"}],"results":{"codes":[{"code":"{\n \"user\": {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}","name":"","status":200,"language":"json"},{"name":"","status":400,"language":"json","code":"{}"}]},"settings":"","url":"/users/username/:username","auth":"required","apiSetting":"58b53c301065f9c438aa1f77"},"link_external":false,"title":"Retrieve a user by username","category":"58ac99cca7906a2f0076ab67","hidden":false,"order":3,"slug":"get-user-username","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9b058077f60f00b339b3","type":"endpoint","hidden":false,"link_external":false,"parentDoc":"5924a2ecba8cdc0f00c98ffc","sync_unique":"","slug":"get-user-loggedin","api":{"results":{"codes":[{"name":"","code":"{\n \"user\": {\n \"username\": \"jdoe\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n }\n}","language":"json","status":200},{"status":400,"name":"","code":"{}","language":"json"}]},"settings":"","url":"/users/me","auth":"required","examples":{"codes":[]},"method":"get","params":[],"apiSetting":"58b53c301065f9c438aa1f77"},"category":"58ac99cca7906a2f0076ab67","createdAt":"2017-02-21T19:54:45.061Z","isReference":true,"order":4,"link_url":"","title":"Retrieve logged-in user","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9a411909810f00fda9ff","api":{"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the user","required":false,"in":"path","ref":"","_id":"58aca26c20ff190f0059c0ae"},{"name":"user.username","type":"string","enumValues":"","default":"","desc":"Username. Username cannot be changed!","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0ad"},{"name":"user.password","type":"string","enumValues":"","default":"","desc":"Password. Example: 'newpassword'","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0ac"},{"name":"user.email","type":"string","enumValues":"","default":"","desc":"Email address of the user. Example: 'test@example.com'","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0ab"},{"name":"user.firstName","type":"string","enumValues":"","default":"","desc":"First name of the user. Example: 'FirstName'","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0aa"},{"name":"user.lastName","type":"string","enumValues":"","default":"","desc":"Last name of the user. Example: 'LastName'","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0a9"},{"name":"user.group","type":"int","enumValues":"","default":"","desc":"Assign to Groups","required":false,"in":"body","ref":"","_id":"58aca26c20ff190f0059c0a8"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"userGroups\": [\n {\n \"userid\": \"3\",\n \"groupid\": \"3\",\n \"links\": {\n \"group\": \"https://:account.api-us1.com/api/3/userGroups/3/group\",\n \"user\": \"https://:account.api-us1.com/api/3/userGroups/3/user\"\n },\n \"id\": \"3\",\n \"group\": \"3\",\n \"user\": \"3\"\n }\n ],\n \"user\": {\n \"username\": \"user\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@example.com\",\n \"phone\": \"\",\n \"signature\": \"\",\n \"userGroup\": \"3\",\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/3/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/3/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/3/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/3/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/3/configs\"\n },\n \"id\": \"3\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/users/:id","auth":"required","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-02-21T19:51:29.969Z","hidden":false,"link_url":"","order":5,"category":"58ac99cca7906a2f0076ab67","isReference":true,"parentDoc":"5924a2ecba8cdc0f00c98ffc","title":"Update a user","type":"endpoint","link_external":false,"slug":"update-user","sync_unique":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"58ac9aa81909810f00fdaa02","slug":"delete-user","sync_unique":"","link_external":false,"link_url":"","parentDoc":"5924a2ecba8cdc0f00c98ffc","api":{"auth":"required","examples":{"codes":[]},"method":"delete","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the user you wish to delete","required":false,"in":"path","ref":"","_id":"58aca3345303921b007a5c97"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"},{"language":"json","code":"{}","name":"","status":400}]},"settings":"","url":"/users/:id","apiSetting":"58b53c301065f9c438aa1f77"},"category":"58ac99cca7906a2f0076ab67","order":6,"hidden":false,"isReference":true,"title":"Delete a user","type":"endpoint","createdAt":"2017-02-21T19:53:12.219Z","deprecated":false,"previousSlug":"","isBodyEmpty":true,"children":[]},{"_id":"58ac9b191909810f00fdaa05","api":{"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n \"users\": [\n {\n \"username\": \"admin\",\n \"firstName\": \"John\",\n \"lastName\": \"Doe\",\n \"email\": \"johndoe@activecampaign.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/1/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/1/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/1/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/1/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/1/configs\"\n },\n \"id\": \"1\"\n },\n {\n \"username\": \"janedoe\",\n \"firstName\": \"Jane\",\n \"lastName\": \"Doe\",\n \"email\": \"janedoe@activecampaign.com\",\n \"phone\": \"\",\n \"signature\": null,\n \"links\": {\n \"lists\": \"https://:account.api-us1.com/api/3/users/5/lists\",\n \"userGroup\": \"https://:account.api-us1.com/api/3/users/5/userGroup\",\n \"dealGroupTotals\": \"https://:account.api-us1.com/api/3/users/5/dealGroupTotals\",\n \"dealGroupUsers\": \"https://:account.api-us1.com/api/3/users/5/dealGroupUsers\",\n \"configs\": \"https://:account.api-us1.com/api/3/users/5/configs\"\n },\n \"id\": \"5\"\n }\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}"},{"code":"{}","name":"","status":400,"language":"json"}]},"settings":"","url":"/users","auth":"required","examples":{"codes":[]},"method":"get","params":[],"apiSetting":"58b53c301065f9c438aa1f77"},"parentDoc":"5924a2ecba8cdc0f00c98ffc","title":"List all users","createdAt":"2017-02-21T19:55:05.316Z","sync_unique":"","category":"58ac99cca7906a2f0076ab67","isReference":true,"link_external":false,"link_url":"","order":7,"hidden":false,"slug":"list-all-users","type":"endpoint","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]}]},{"_id":"5b9aa63ad989900003e98ccf","category":"58ac99cca7906a2f0076ab67","createdAt":"2018-09-13T18:02:34.384Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[],"url":"","method":"get"},"isReference":true,"order":1,"slug":"groups","type":"basic","title":"Groups","parentDoc":null,"isBodyEmpty":true,"children":[{"_id":"5bb0663a14dfd10003934a91","category":"58ac99cca7906a2f0076ab67","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2018-09-30T05:59:22.827Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[{"code":"{\n\t\"group\": {\n\t\t\"title\": \"My Groups Title\"\n\t}\n}","language":"json"},{"language":"json","code":"{\n\t\"group\": {\n\t\t\"title\": \"TEST TITLE\",\n \"descript\": \"Description Text\",\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"pgListAdd\": 1,\n \"pgListEdit\": 1,\n \"pgListDelete\": 1,\n \"pgListHeaders\": 1,\n \"pgListEmailaccount\": 1,\n \"pgListBounce\": 1,\n \"pgMessageAdd\": 1,\n \"pgMessageEdit\": 1,\n \"pgMessageDelete\": 1,\n \"pgMessageSend\": 1,\n \"pgContactAdd\": 1,\n \"pgContactEdit\": 1,\n \"pgContactDelete\": 1,\n \"pgContactMerge\": 1,\n \"pgContactImport\": 1,\n \"pgContactApprove\": 1,\n \"pgContactExport\": 1,\n \"pgContactSync\": 1,\n \"pgContactFilters\": 1,\n \"pgContactActions\": 1,\n \"pgContactFields\": 1,\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n\t\t\t\t\"pgGroupAdd\": 1,\n\t\t\t\t\"pgGroupEdit\": 1,\n\t\t\t\t\"pgGroupDelete\": 1,\n\t\t\t\t\"pgTemplateAdd\": 1,\n \"pgTemplateEdit\": 1,\n \"pgTemplateDelete\": 1,\n \"pgPersonalizationAdd\": 1,\n \"pgPersonalizationEdit\": 1,\n \"pgPersonalizationDelete\": 1,\n \"pgAutomationManage\": 1,\n \"pgFormEdit\": 1,\n \"pgReportsCampaign\": 1,\n \"pgReportsList\": 1,\n \"pgReportsUser\": 1,\n \"pgReportsTrend\": 1,\n \"pgStartupReports\": 1,\n \"pgStartupGettingstarted\": 1,\n \"pgDeal\": 1,\n \"pgDealDelete\": 1,\n \"pgDealReassign\": 1,\n \"pgDealGroupAdd\": 1,\n \"pgDealGroupEdit\": 1,\n \"pgDealGroupDelete\": 1,\n \"pgSavedResponsesManage\": 1,\n \"reqApproval\": 1,\n \"reqApproval1st\": 1,\n \"reqApprovalNotify\": \"JohnDoe@gmail.com\",\n \"socialdata\": 0\n\t}\n}"}]},"results":{"codes":[{"name":"","code":"{\n \"group\": {\n \"title\": \"My Groups Title\",\n \"p_admin\": 1,\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/:version/groups/7/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/:version/groups/7/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/:version/groups/7/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/:version/groups/7/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/:version/groups/7/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/:version/groups/7/automationGroups\"\n },\n \"id\": \"7\"\n }\n}","language":"json","status":200}]},"auth":"required","params":[{"name":"group.title","type":"string","enumValues":"","default":"","desc":"Title of the group to be created","required":true,"in":"body","ref":"","_id":"5baec04ccfaf8d00035799cc"},{"name":"group.descript","type":"string","enumValues":"","default":"","desc":"Group description","required":false,"in":"body","ref":"","_id":"5bb0403714dfd10003934909"},{"name":"group.pgMessageAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding messages","required":false,"in":"body","ref":"","_id":"5bb0403714dfd10003934908"},{"name":"group.unsubscribelink","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to force unsubscribe links","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a3"},{"name":"group.optinconfirm","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to force optin confirm for this group","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a2"},{"name":"group.pgListAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a1"},{"name":"group.pgListEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a0"},{"name":"group.pgListDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69f"},{"name":"group.pgListHeaders","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing custom email headers","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69e"},{"name":"group.pgListEmailaccount","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing Unsubscribe By Email","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69d"},{"name":"group.pgListBounce","type":"boolean","enumValues":"","default":"0","desc":"Permission for accessing list bounce settings","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69c"},{"name":"group.pgMessageAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding messages","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69b"},{"name":"group.pgMessageEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e6"},{"name":"group.pgMessageDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e5"},{"name":"group.pgMessageSend","type":"boolean","enumValues":"","default":"0","desc":"Permission for sending messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e4"},{"name":"group.pgContactAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e3"},{"name":"group.pgContactEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e2"},{"name":"group.pgContactDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e1"},{"name":"group.pgContactMerge","type":"boolean","enumValues":"","default":"0","desc":"Permission for merging contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e0"},{"name":"group.pgContactImport","type":"boolean","enumValues":"","default":"0","desc":"Permission for importing contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5df"},{"name":"group.pgContactApprove","type":"boolean","enumValues":"","default":"0","desc":"Permission for approving contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b08a1"},{"name":"group.pgContactExport","type":"boolean","enumValues":"","default":"0","desc":"Permission for exporting contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b08a0"},{"name":"group.pgContactSync","type":"boolean","enumValues":"","default":"0","desc":"Permission for syncing contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089f"},{"name":"group.pgContactFilters","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact list segments","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089e"},{"name":"group.pgContactActions","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact actions","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089d"},{"name":"group.pgContactFields","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact custom fields","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089c"},{"name":"group.pg_user_add","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089b"},{"name":"group.pg_user_edit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089a"},{"name":"group.pg_user_delete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0899"},{"name":"group.pgGroupAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0898"},{"name":"group.pgGroupEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0897"},{"name":"group.pgGroupDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0896"},{"name":"group.pgTemplateAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding templates","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0895"},{"name":"group.pgTemplateEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing templates","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0894"},{"name":"group.pgTemplateDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting templates","required":false,"in":"body","ref":"","_id":"5bb057b2bd6fc4000324d717"},{"name":"group.pgPersonalizationAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding personalization tags","required":false,"in":"body","ref":"","_id":"5bb057b2bd6fc4000324d716"},{"name":"group.pgPersonalizationEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing personalization tags","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7d"},{"name":"group.pgPersonalizationDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting personalization tags","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7c"},{"name":"group.pgAutomationManage","type":"boolean","enumValues":"","default":"0","desc":"","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7b"},{"name":"group.pgFormEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing subscription forms","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7a"},{"name":"group.pgReportsCampaign","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing campaign reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a79"},{"name":"group.pgReportsList","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing list reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a78"},{"name":"group.pgReportsUser","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing user reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a77"},{"name":"group.pgStartupReports","type":"boolean","enumValues":"","default":"0","desc":"Campaign ID of last campaign report viewed to decide whether to show link on startup","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a76"},{"name":"group.pgReportsTrend","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing trend reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a75"},{"name":"group.pgStartupGettingstarted","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to show the \"getting started\" tutorial on overview page","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a74"},{"name":"group.pgDeal","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a73"},{"name":"group.pgDealDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a72"},{"name":"group.pgDealReassign","type":"boolean","enumValues":"","default":"0","desc":"Permission for reassigning deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a71"},{"name":"group.pgDealGroupAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding deal groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a70"},{"name":"group.pgDealGroupEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing deal groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6f"},{"name":"group.pgDealGroupDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting deals groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6e"},{"name":"group.pgSavedResponsesManage","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing saved responses","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6d"},{"name":"group.pgTagManage","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing tags","required":false,"in":"body","ref":"","_id":"5eaaf63f379fb40065313878"},{"name":"group.reqApproval","type":"boolean","enumValues":"","default":"0","desc":"Whether or not this group requires all campaigns to be approved","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6c"},{"name":"group.reqApproval1st","type":"boolean","enumValues":"","default":"0","desc":"Whether or not this group requires first campaign to be approved","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6b"},{"name":"group.reqApprovalNotify","type":"string","enumValues":"","default":"","desc":"Who to notify for approval related issues (email)","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6a"},{"name":"group.socialdata","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to show social links in campaigns sent from this group","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a69"}],"url":"/groups","method":"post"},"isReference":true,"order":0,"slug":"create-a-new-group","type":"endpoint","title":"Create a group","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9abf7d62645c0003d0b1fe","category":"58ac99cca7906a2f0076ab67","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2018-09-13T19:50:21.430Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{\n \"group\": {\n \"title\": \"TEST TITLE\",\n \"descript\": \"This is a group for admin users (people that can manage content)\",\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": \"1\",\n \"pgListEdit\": \"1\",\n \"pgListDelete\": \"1\",\n \"pgListHeaders\": \"1\",\n \"pgListEmailaccount\": \"1\",\n \"pgListBounce\": \"1\",\n \"pgMessageAdd\": \"1\",\n \"pgMessageEdit\": \"1\",\n \"pgMessageDelete\": \"1\",\n \"pgMessageSend\": \"1\",\n \"pgContactAdd\": \"1\",\n \"pgContactEdit\": \"1\",\n \"pgContactDelete\": \"1\",\n \"pgContactMerge\": \"1\",\n \"pgContactImport\": \"1\",\n \"pgContactApprove\": \"1\",\n \"pgContactExport\": \"1\",\n \"pgContactSync\": \"1\",\n \"pgContactFilters\": \"1\",\n \"pgContactActions\": \"0\",\n \"pgContactFields\": \"1\",\n \"pg_user_add\": \"1\",\n \"pg_user_edit\": \"1\",\n \"pg_user_delete\": \"1\",\n \"pgGroupAdd\": \"1\",\n \"pgGroupEdit\": \"1\",\n \"pgGroupDelete\": \"1\",\n \"pgTemplateAdd\": \"1\",\n \"pgTemplateEdit\": \"1\",\n \"pgTemplateDelete\": \"1\",\n \"pgPersonalizationAdd\": \"1\",\n \"pgPersonalizationEdit\": \"1\",\n \"pgPersonalizationDelete\": \"1\",\n \"pgAutomationManage\": \"1\",\n \"pgFormEdit\": \"1\",\n \"pgReportsCampaign\": \"1\",\n \"pgReportsList\": \"1\",\n \"pgReportsUser\": \"1\",\n \"pgReportsTrend\": \"1\",\n \"pgStartupReports\": \"1\",\n \"pgStartupGettingstarted\": \"1\",\n \"pgDeal\": \"1\",\n \"pgDealDelete\": \"1\",\n \"pgDealReassign\": \"1\",\n \"pgDealGroupAdd\": \"1\",\n \"pgDealGroupEdit\": \"1\",\n \"pgDealGroupDelete\": \"1\",\n \"pgSavedResponsesManage\": \"1\",\n \"sdate\": \"2018-09-20T10:51:14-05:00\",\n \"reqApproval\": \"0\",\n \"reqApproval1st\": \"2\",\n \"reqApprovalNotify\": \"\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/3/groups/3/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/3/groups/3/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/3/groups/3/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/3/groups/3/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/3/groups/3/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/3/groups/3/automationGroups\"\n },\n \"id\": \"3\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for Group with id 10\"\n}","name":""}]},"auth":"required","params":[{"name":"id","type":"string","enumValues":"","default":"","desc":"ID of the group to retrieve","required":false,"in":"path","ref":"","_id":"5b9abf7d62645c0003d0b1ff"}],"url":"/groups/:id","method":"get"},"isReference":true,"order":1,"slug":"retrieve-a-group","type":"endpoint","title":"Retrieve a group","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9aba1feac9630003bf6c96","category":"58ac99cca7906a2f0076ab67","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2018-09-13T19:27:27.111Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"group\": {\n \"title\": \"My Groups Title\",\n \"p_admin\": 1,\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/:version/groups/7/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/:version/groups/7/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/:version/groups/7/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/:version/groups/7/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/:version/groups/7/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/:version/groups/7/automationGroups\"\n },\n \"id\": \"7\"\n }\n}","name":""},{"status":403,"language":"json","code":"{\n \"message\": \"No Result found for Group with id 8\"\n}","name":""},{"status":200,"language":"text","code":"{\n \"group\": {\n \"title\": \"TEST TITLE\",\n \"descript\": \"Description Text\",\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": 1,\n \"pgListEdit\": 1,\n \"pgListDelete\": 1,\n \"pgListHeaders\": 1,\n \"pgListEmailaccount\": 1,\n \"pgListBounce\": 1,\n \"pgMessageAdd\": 1,\n \"pgMessageEdit\": 1,\n \"pgMessageDelete\": 1,\n \"pgMessageSend\": 1,\n \"pgContactAdd\": 1,\n \"pgContactEdit\": 1,\n \"pgContactDelete\": 1,\n \"pgContactMerge\": 1,\n \"pgContactImport\": 1,\n \"pgContactApprove\": 1,\n \"pgContactExport\": 1,\n \"pgContactSync\": 1,\n \"pgContactFilters\": 1,\n \"pgContactActions\": 1,\n \"pgContactFields\": 1,\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n \"pgGroupAdd\": 1,\n \"pgGroupEdit\": 1,\n \"pgGroupDelete\": 1,\n \"pgTemplateAdd\": 1,\n \"pgTemplateEdit\": 1,\n \"pgTemplateDelete\": 1,\n \"pgPersonalizationAdd\": 1,\n \"pgPersonalizationEdit\": 1,\n \"pgPersonalizationDelete\": 1,\n \"pgAutomationManage\": 1,\n \"pgFormEdit\": 1,\n \"pgReportsCampaign\": 1,\n \"pgReportsList\": 1,\n \"pgReportsUser\": 1,\n \"pgReportsTrend\": 1,\n \"pgStartupReports\": 1,\n \"pgStartupGettingstarted\": 1,\n \"pgDeal\": 1,\n \"pgDealDelete\": 1,\n \"pgDealReassign\": 1,\n \"pgDealGroupAdd\": 1,\n \"pgDealGroupEdit\": 1,\n \"pgDealGroupDelete\": 1,\n \"pgSavedResponsesManage\": 1,\n \"sdate\": \"2018-09-29T22:08:36-05:00\",\n \"reqApproval\": 1,\n \"reqApproval1st\": 1,\n \"reqApprovalNotify\": \"JohnDoe@gmail.com\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/:version/groups/5/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/:version/groups/5/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/:version/groups/5/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/:version/groups/5/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/:version/groups/5/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/:version/groups/5/automationGroups\"\n },\n \"id\": \"5\"\n }\n}"}]},"examples":{"codes":[{"code":"{\n\t\"group\": {\n\t\t\"title\": \"My Groups Title\"\n\t}\n}","language":"json"},{"language":"json","code":"{\n\t\"group\": {\n\t\t\"title\": \"TEST TITLE\",\n \"descript\": \"Description Text\",\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"pgListAdd\": 1,\n \"pgListEdit\": 1,\n \"pgListDelete\": 1,\n \"pgListHeaders\": 1,\n \"pgListEmailaccount\": 1,\n \"pgListBounce\": 1,\n \"pgMessageAdd\": 1,\n \"pgMessageEdit\": 1,\n \"pgMessageDelete\": 1,\n \"pgMessageSend\": 1,\n \"pgContactAdd\": 1,\n \"pgContactEdit\": 1,\n \"pgContactDelete\": 1,\n \"pgContactMerge\": 1,\n \"pgContactImport\": 1,\n \"pgContactApprove\": 1,\n \"pgContactExport\": 1,\n \"pgContactSync\": 1,\n \"pgContactFilters\": 1,\n \"pgContactActions\": 1,\n \"pgContactFields\": 1,\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n\t\t\t\t\"pgGroupAdd\": 1,\n\t\t\t\t\"pgGroupEdit\": 1,\n\t\t\t\t\"pgGroupDelete\": 1,\n\t\t\t\t\"pgTemplateAdd\": 1,\n \"pgTemplateEdit\": 1,\n \"pgTemplateDelete\": 1,\n \"pgPersonalizationAdd\": 1,\n \"pgPersonalizationEdit\": 1,\n \"pgPersonalizationDelete\": 1,\n \"pgAutomationManage\": 1,\n \"pgFormEdit\": 1,\n \"pgReportsCampaign\": 1,\n \"pgReportsList\": 1,\n \"pgReportsUser\": 1,\n \"pgReportsTrend\": 1,\n \"pgStartupReports\": 1,\n \"pgStartupGettingstarted\": 1,\n \"pgDeal\": 1,\n \"pgDealDelete\": 1,\n \"pgDealReassign\": 1,\n \"pgDealGroupAdd\": 1,\n \"pgDealGroupEdit\": 1,\n \"pgDealGroupDelete\": 1,\n \"pgSavedResponsesManage\": 1,\n \"reqApproval\": 1,\n \"reqApproval1st\": 1,\n \"reqApprovalNotify\": \"JohnDoe@gmail.com\",\n \"socialdata\": 0\n\t}\n}"}]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"ID of the group to update","required":false,"in":"path","ref":"","_id":"5b9aba1feac9630003bf6c97"},{"name":"group.title","type":"string","enumValues":"","default":"","desc":"","required":false,"in":"body","ref":"","_id":"5baec04ccfaf8d00035799cc"},{"name":"group.descript","type":"string","enumValues":"","default":"","desc":"Group description","required":false,"in":"body","ref":"","_id":"5bb0403714dfd10003934909"},{"name":"group.pgMessageAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding messages","required":false,"in":"body","ref":"","_id":"5bb0403714dfd10003934908"},{"name":"group.unsubscribelink","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to force unsubscribe links","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a3"},{"name":"group.optinconfirm","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to force optin confirm for this group","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a2"},{"name":"group.pgListAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a1"},{"name":"group.pgListEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d6a0"},{"name":"group.pgListDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting lists","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69f"},{"name":"group.pgListHeaders","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing custom email headers","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69e"},{"name":"group.pgListEmailaccount","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing Unsubscribe By Email","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69d"},{"name":"group.pgListBounce","type":"boolean","enumValues":"","default":"0","desc":"Permission for accessing list bounce settings","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69c"},{"name":"group.pgMessageAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding messages","required":false,"in":"body","ref":"","_id":"5bb04363bd6fc4000324d69b"},{"name":"group.pgMessageEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e6"},{"name":"group.pgMessageDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e5"},{"name":"group.pgMessageSend","type":"boolean","enumValues":"","default":"0","desc":"Permission for sending messages","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e4"},{"name":"group.pgContactAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e3"},{"name":"group.pgContactEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e2"},{"name":"group.pgContactDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e1"},{"name":"group.pgContactMerge","type":"boolean","enumValues":"","default":"0","desc":"Permission for merging contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5e0"},{"name":"group.pgContactImport","type":"boolean","enumValues":"","default":"0","desc":"Permission for importing contacts","required":false,"in":"body","ref":"","_id":"5bb0453fa78760000374a5df"},{"name":"group.pgContactApprove","type":"boolean","enumValues":"","default":"0","desc":"Permission for approving contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b08a1"},{"name":"group.pgContactExport","type":"boolean","enumValues":"","default":"0","desc":"Permission for exporting contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b08a0"},{"name":"group.pgContactSync","type":"boolean","enumValues":"","default":"0","desc":"Permission for syncing contacts","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089f"},{"name":"group.pgContactFilters","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact list segments","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089e"},{"name":"group.pgContactActions","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact actions","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089d"},{"name":"group.pgContactFields","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing contact custom fields","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089c"},{"name":"group.pg_user_add","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089b"},{"name":"group.pg_user_edit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b089a"},{"name":"group.pg_user_delete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting users","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0899"},{"name":"group.pgGroupAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0898"},{"name":"group.pgGroupEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0897"},{"name":"group.pgGroupDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting groups","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0896"},{"name":"group.pgTemplateAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding templates","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0895"},{"name":"group.pgTemplateEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing templates","required":false,"in":"body","ref":"","_id":"5bb0568db6fc1000030b0894"},{"name":"group.pgTemplateDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting templates","required":false,"in":"body","ref":"","_id":"5bb057b2bd6fc4000324d717"},{"name":"group.pgPersonalizationAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding personalization tags","required":false,"in":"body","ref":"","_id":"5bb057b2bd6fc4000324d716"},{"name":"group.pgPersonalizationEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing personalization tags","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7d"},{"name":"group.pgPersonalizationDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting personalization tags","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7c"},{"name":"group.pgAutomationManage","type":"boolean","enumValues":"","default":"0","desc":"","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7b"},{"name":"group.pgFormEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing subscription forms","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a7a"},{"name":"group.pgReportsCampaign","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing campaign reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a79"},{"name":"group.pgReportsList","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing list reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a78"},{"name":"group.pgReportsUser","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing user reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a77"},{"name":"group.pgStartupReports","type":"boolean","enumValues":"","default":"0","desc":"Campaign ID of last campaign report viewed to decide whether to show link on startup","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a76"},{"name":"group.pgReportsTrend","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing trend reports","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a75"},{"name":"group.pgStartupGettingstarted","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to show the \"getting started\" tutorial on overview page","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a74"},{"name":"group.pgDeal","type":"boolean","enumValues":"","default":"0","desc":"Permission for viewing deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a73"},{"name":"group.pgDealDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a72"},{"name":"group.pgDealReassign","type":"boolean","enumValues":"","default":"0","desc":"Permission for reassigning deals","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a71"},{"name":"group.pgDealGroupAdd","type":"boolean","enumValues":"","default":"0","desc":"Permission for adding deal groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a70"},{"name":"group.pgDealGroupEdit","type":"boolean","enumValues":"","default":"0","desc":"Permission for editing deal groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6f"},{"name":"group.pgDealGroupDelete","type":"boolean","enumValues":"","default":"0","desc":"Permission for deleting deals groups","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6e"},{"name":"group.pgSavedResponsesManage","type":"boolean","enumValues":"","default":"0","desc":"Permission for managing saved responses","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6d"},{"name":"group.reqApproval","type":"boolean","enumValues":"","default":"0","desc":"Whether or not this group requires all campaigns to be approved","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6c"},{"name":"group.reqApproval1st","type":"boolean","enumValues":"","default":"0","desc":"Whether or not this group requires first campaign to be approved","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6b"},{"name":"group.reqApprovalNotify","type":"string","enumValues":"","default":"","desc":"Who to notify for approval related issues (email)","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a6a"},{"name":"group.socialdata","type":"boolean","enumValues":"","default":"0","desc":"Whether or not to show social links in campaigns sent from this group","required":false,"in":"body","ref":"","_id":"5bb064bd14dfd10003934a69"}],"url":"/groups/:id","method":"put"},"isReference":true,"order":2,"slug":"update-a-group","type":"endpoint","title":"Update a group","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"5b9ab99630f1ec0003933ef8","category":"58ac99cca7906a2f0076ab67","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2018-09-13T19:25:10.019Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"apiSetting":"58b53c301065f9c438aa1f77","examples":{"codes":[]},"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"auth":"required","params":[{"_id":"5b9ab92b30f1ec0003933eea","ref":"","in":"path","required":false,"desc":"ID of the group to be deleted","default":"","type":"int","name":"id"}],"url":"/groups/:id","method":"delete"},"isReference":true,"order":3,"slug":"delete-a-group-1","type":"endpoint","title":"Delete a group","isBodyEmpty":true,"children":[]},{"_id":"5b9abd3630f1ec00039340ed","category":"58ac99cca7906a2f0076ab67","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2018-09-13T19:40:38.897Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[{"name":"","code":"{\n \"groups\": [\n {\n \"title\": \"TEST TITLE\",\n \"descript\": \"This is a group for admin users (people that can manage content)\",\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": \"1\",\n \"pgListEdit\": \"1\",\n \"pgListDelete\": \"1\",\n \"pgListHeaders\": \"1\",\n \"pgListEmailaccount\": \"1\",\n \"pgListBounce\": \"1\",\n \"pgMessageAdd\": \"1\",\n \"pgMessageEdit\": \"1\",\n \"pgMessageDelete\": \"1\",\n \"pgMessageSend\": \"1\",\n \"pgContactAdd\": \"1\",\n \"pgContactEdit\": \"1\",\n \"pgContactDelete\": \"1\",\n \"pgContactMerge\": \"1\",\n \"pgContactImport\": \"1\",\n \"pgContactApprove\": \"1\",\n \"pgContactExport\": \"1\",\n \"pgContactSync\": \"1\",\n \"pgContactFilters\": \"1\",\n \"pgContactActions\": \"0\",\n \"pgContactFields\": \"1\",\n \"pg_user_add\": \"1\",\n \"pg_user_edit\": \"1\",\n \"pg_user_delete\": \"1\",\n \"pgGroupAdd\": \"1\",\n \"pgGroupEdit\": \"1\",\n \"pgGroupDelete\": \"1\",\n \"pgTemplateAdd\": \"1\",\n \"pgTemplateEdit\": \"1\",\n \"pgTemplateDelete\": \"1\",\n \"pgPersonalizationAdd\": \"1\",\n \"pgPersonalizationEdit\": \"1\",\n \"pgPersonalizationDelete\": \"1\",\n \"pgAutomationManage\": \"1\",\n \"pgFormEdit\": \"1\",\n \"pgReportsCampaign\": \"1\",\n \"pgReportsList\": \"1\",\n \"pgReportsUser\": \"1\",\n \"pgReportsTrend\": \"1\",\n \"pgStartupReports\": \"1\",\n \"pgStartupGettingstarted\": \"1\",\n \"pgDeal\": \"1\",\n \"pgDealDelete\": \"1\",\n \"pgDealReassign\": \"1\",\n \"pgDealGroupAdd\": \"1\",\n \"pgDealGroupEdit\": \"1\",\n \"pgDealGroupDelete\": \"1\",\n \"pgSavedResponsesManage\": \"1\",\n \"sdate\": \"2018-09-20T10:51:14-05:00\",\n \"reqApproval\": \"0\",\n \"reqApproval1st\": \"2\",\n \"reqApprovalNotify\": \"\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/3/groups/3/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/3/groups/3/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/3/groups/3/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/3/groups/3/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/3/groups/3/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/3/groups/3/automationGroups\"\n },\n \"id\": \"3\"\n },\n {\n \"title\": \"TEST TITLE\",\n \"descript\": null,\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": \"0\",\n \"pgListEdit\": \"0\",\n \"pgListDelete\": \"0\",\n \"pgListHeaders\": \"0\",\n \"pgListEmailaccount\": \"0\",\n \"pgListBounce\": \"0\",\n \"pgMessageAdd\": \"0\",\n \"pgMessageEdit\": \"0\",\n \"pgMessageDelete\": \"0\",\n \"pgMessageSend\": \"0\",\n \"pgContactAdd\": \"0\",\n \"pgContactEdit\": \"0\",\n \"pgContactDelete\": \"0\",\n \"pgContactMerge\": \"0\",\n \"pgContactImport\": \"0\",\n \"pgContactApprove\": \"0\",\n \"pgContactExport\": \"0\",\n \"pgContactSync\": \"0\",\n \"pgContactFilters\": \"0\",\n \"pgContactActions\": \"0\",\n \"pgContactFields\": \"0\",\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n \"pgGroupAdd\": \"0\",\n \"pgGroupEdit\": \"0\",\n \"pgGroupDelete\": \"0\",\n \"pgTemplateAdd\": \"0\",\n \"pgTemplateEdit\": \"0\",\n \"pgTemplateDelete\": \"0\",\n \"pgPersonalizationAdd\": \"0\",\n \"pgPersonalizationEdit\": \"0\",\n \"pgPersonalizationDelete\": \"0\",\n \"pgAutomationManage\": \"0\",\n \"pgFormEdit\": \"0\",\n \"pgReportsCampaign\": \"0\",\n \"pgReportsList\": \"0\",\n \"pgReportsUser\": \"0\",\n \"pgReportsTrend\": \"1\",\n \"pgStartupReports\": \"0\",\n \"pgStartupGettingstarted\": \"1\",\n \"pgDeal\": \"1\",\n \"pgDealDelete\": \"1\",\n \"pgDealReassign\": \"1\",\n \"pgDealGroupAdd\": \"1\",\n \"pgDealGroupEdit\": \"1\",\n \"pgDealGroupDelete\": \"1\",\n \"pgSavedResponsesManage\": \"0\",\n \"sdate\": null,\n \"reqApproval\": \"0\",\n \"reqApproval1st\": \"2\",\n \"reqApprovalNotify\": \"\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/3/groups/5/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/3/groups/5/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/3/groups/5/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/3/groups/5/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/3/groups/5/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/3/groups/5/automationGroups\"\n },\n \"id\": \"5\"\n },\n {\n \"title\": \"TEST TITLE\",\n \"descript\": null,\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": \"0\",\n \"pgListEdit\": \"0\",\n \"pgListDelete\": \"0\",\n \"pgListHeaders\": \"0\",\n \"pgListEmailaccount\": \"0\",\n \"pgListBounce\": \"0\",\n \"pgMessageAdd\": \"0\",\n \"pgMessageEdit\": \"0\",\n \"pgMessageDelete\": \"0\",\n \"pgMessageSend\": \"0\",\n \"pgContactAdd\": \"0\",\n \"pgContactEdit\": \"0\",\n \"pgContactDelete\": \"0\",\n \"pgContactMerge\": \"0\",\n \"pgContactImport\": \"0\",\n \"pgContactApprove\": \"0\",\n \"pgContactExport\": \"0\",\n \"pgContactSync\": \"0\",\n \"pgContactFilters\": \"0\",\n \"pgContactActions\": \"0\",\n \"pgContactFields\": \"0\",\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n \"pgGroupAdd\": \"0\",\n \"pgGroupEdit\": \"0\",\n \"pgGroupDelete\": \"0\",\n \"pgTemplateAdd\": \"0\",\n \"pgTemplateEdit\": \"0\",\n \"pgTemplateDelete\": \"0\",\n \"pgPersonalizationAdd\": \"0\",\n \"pgPersonalizationEdit\": \"0\",\n \"pgPersonalizationDelete\": \"0\",\n \"pgAutomationManage\": \"0\",\n \"pgFormEdit\": \"0\",\n \"pgReportsCampaign\": \"0\",\n \"pgReportsList\": \"0\",\n \"pgReportsUser\": \"0\",\n \"pgReportsTrend\": \"1\",\n \"pgStartupReports\": \"0\",\n \"pgStartupGettingstarted\": \"1\",\n \"pgDeal\": \"1\",\n \"pgDealDelete\": \"1\",\n \"pgDealReassign\": \"1\",\n \"pgDealGroupAdd\": \"1\",\n \"pgDealGroupEdit\": \"1\",\n \"pgDealGroupDelete\": \"1\",\n \"pgSavedResponsesManage\": \"0\",\n \"sdate\": null,\n \"reqApproval\": \"0\",\n \"reqApproval1st\": \"2\",\n \"reqApprovalNotify\": \"\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/3/groups/6/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/3/groups/6/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/3/groups/6/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/3/groups/6/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/3/groups/6/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/3/groups/6/automationGroups\"\n },\n \"id\": \"6\"\n },\n {\n \"title\": \"TEST TITLE\",\n \"descript\": null,\n \"unsubscribelink\": \"0\",\n \"optinconfirm\": \"0\",\n \"p_admin\": \"1\",\n \"pgListAdd\": \"0\",\n \"pgListEdit\": \"0\",\n \"pgListDelete\": \"0\",\n \"pgListHeaders\": \"0\",\n \"pgListEmailaccount\": \"0\",\n \"pgListBounce\": \"0\",\n \"pgMessageAdd\": \"0\",\n \"pgMessageEdit\": \"0\",\n \"pgMessageDelete\": \"0\",\n \"pgMessageSend\": \"0\",\n \"pgContactAdd\": \"0\",\n \"pgContactEdit\": \"0\",\n \"pgContactDelete\": \"0\",\n \"pgContactMerge\": \"0\",\n \"pgContactImport\": \"0\",\n \"pgContactApprove\": \"0\",\n \"pgContactExport\": \"0\",\n \"pgContactSync\": \"0\",\n \"pgContactFilters\": \"0\",\n \"pgContactActions\": \"0\",\n \"pgContactFields\": \"0\",\n \"pg_user_add\": \"0\",\n \"pg_user_edit\": \"0\",\n \"pg_user_delete\": \"0\",\n \"pgGroupAdd\": \"0\",\n \"pgGroupEdit\": \"0\",\n \"pgGroupDelete\": \"0\",\n \"pgTemplateAdd\": \"0\",\n \"pgTemplateEdit\": \"0\",\n \"pgTemplateDelete\": \"0\",\n \"pgPersonalizationAdd\": \"0\",\n \"pgPersonalizationEdit\": \"0\",\n \"pgPersonalizationDelete\": \"0\",\n \"pgAutomationManage\": \"0\",\n \"pgFormEdit\": \"0\",\n \"pgReportsCampaign\": \"0\",\n \"pgReportsList\": \"0\",\n \"pgReportsUser\": \"0\",\n \"pgReportsTrend\": \"1\",\n \"pgStartupReports\": \"0\",\n \"pgStartupGettingstarted\": \"1\",\n \"pgDeal\": \"1\",\n \"pgDealDelete\": \"1\",\n \"pgDealReassign\": \"1\",\n \"pgDealGroupAdd\": \"1\",\n \"pgDealGroupEdit\": \"1\",\n \"pgDealGroupDelete\": \"1\",\n \"pgSavedResponsesManage\": \"0\",\n \"sdate\": null,\n \"reqApproval\": \"0\",\n \"reqApproval1st\": \"2\",\n \"reqApprovalNotify\": \"\",\n \"socialdata\": \"0\",\n \"links\": {\n \"userGroups\": \"https://:account.api-us1.com/api/3/groups/7/userGroups\",\n \"groupLimit\": \"https://:account.api-us1.com/api/3/groups/7/groupLimit\",\n \"dealGroupGroups\": \"https://:account.api-us1.com/api/3/groups/7/dealGroupGroups\",\n \"listGroups\": \"https://:account.api-us1.com/api/3/groups/7/listGroups\",\n \"addressGroups\": \"https://:account.api-us1.com/api/3/groups/7/addressGroups\",\n \"automationGroups\": \"https://:account.api-us1.com/api/3/groups/7/automationGroups\"\n },\n \"id\": \"7\"\n }\n ],\n \"meta\": {\n \"total\": \"4\"\n }\n}","language":"json","status":200}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","auth":"required","params":[],"url":"/groups","method":"get"},"isReference":true,"order":4,"slug":"list-all-groups","type":"endpoint","title":"List all groups","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"620572cc90d7c6005c9c6616","api":{"method":"get","url":"/groupLimits","auth":"required","results":{"codes":[{"name":"","code":"{\n\t\"groupLimits\": [\n\t\t{\n\t\t\t\"groupid\": \"1\",\n\t\t\t\"limitMail\": \"0\",\n\t\t\t\"limitMailType\": \"month\",\n\t\t\t\"limitContact\": \"0\",\n\t\t\t\"limitList\": \"0\",\n\t\t\t\"limitCampaign\": \"0\",\n\t\t\t\"limitCampaignType\": \"month\",\n\t\t\t\"limitAttachment\": \"-1\",\n\t\t\t\"limitUser\": \"0\",\n\t\t\t\"abuseRatio\": \"4\",\n\t\t\t\"forceSenderInfo\": \"0\",\n\t\t\t\"links\": {\n\t\t\t\t\"group\": \"https://:account.api-us1.com/api/3/groupLimits/1/group\"\n\t\t\t},\n\t\t\t\"id\": \"1\",\n\t\t\t\"group\": \"1\"\n\t\t},\n\t\t{\n\t\t\t\"groupid\": \"2\",\n\t\t\t\"limitMail\": \"0\",\n\t\t\t\"limitMailType\": \"month\",\n\t\t\t\"limitContact\": \"0\",\n\t\t\t\"limitList\": \"0\",\n\t\t\t\"limitCampaign\": \"0\",\n\t\t\t\"limitCampaignType\": \"month\",\n\t\t\t\"limitAttachment\": \"-1\",\n\t\t\t\"limitUser\": \"0\",\n\t\t\t\"abuseRatio\": \"4\",\n\t\t\t\"forceSenderInfo\": \"0\",\n\t\t\t\"links\": {\n\t\t\t\t\"group\": \"https://:accounts.api-us1.com/api/3/groupLimits/2/group\"\n\t\t\t},\n\t\t\t\"id\": \"2\",\n\t\t\t\"group\": \"2\"\n\t\t},\n\t\t{\n\t\t\t\"groupid\": \"3\",\n\t\t\t\"limitMail\": \"0\",\n\t\t\t\"limitMailType\": \"month\",\n\t\t\t\"limitContact\": \"0\",\n\t\t\t\"limitList\": \"0\",\n\t\t\t\"limitCampaign\": \"0\",\n\t\t\t\"limitCampaignType\": \"month\",\n\t\t\t\"limitAttachment\": \"-1\",\n\t\t\t\"limitUser\": \"0\",\n\t\t\t\"abuseRatio\": \"4\",\n\t\t\t\"forceSenderInfo\": \"0\",\n\t\t\t\"links\": {\n\t\t\t\t\"group\": \"https://:account.api-us1.com/api/3/groupLimits/3/group\"\n\t\t\t},\n\t\t\t\"id\": \"3\",\n\t\t\t\"group\": \"3\"\n\t\t},\n\t\t{\n\t\t\t\"groupid\": \"4\",\n\t\t\t\"limitMail\": \"0\",\n\t\t\t\"limitMailType\": \"month\",\n\t\t\t\"limitContact\": \"0\",\n\t\t\t\"limitList\": \"0\",\n\t\t\t\"limitCampaign\": \"0\",\n\t\t\t\"limitCampaignType\": \"month\",\n\t\t\t\"limitAttachment\": \"-1\",\n\t\t\t\"limitUser\": \"0\",\n\t\t\t\"abuseRatio\": \"4\",\n\t\t\t\"forceSenderInfo\": \"0\",\n\t\t\t\"links\": {\n\t\t\t\t\"group\": \"https://:account.api-us1.com/api/3/groupLimits/4/group\"\n\t\t\t},\n\t\t\t\"id\": \"4\",\n\t\t\t\"group\": \"4\"\n\t\t}\n\t],\n\t\"meta\": {\n\t\t\"total\": \"4\"\n\t}\n}","language":"json","status":200}]},"examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77","params":[]},"title":"List All Group Limits","type":"endpoint","slug":"list-all-group-limits","order":5,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"previousSlug":"retrieve-all-group-limits","parentDoc":"5b9aa63ad989900003e98ccf","createdAt":"2022-02-10T20:17:16.941Z","category":"58ac99cca7906a2f0076ab67","isBodyEmpty":false,"children":[]}]}]},{"_id":"581a406b1a63870f008b622f","__v":0,"createdAt":"2016-11-02T19:37:15.211Z","from_sync":false,"reference":true,"slug":"test","order":30,"project":"57b6f40e480bae1900ce4e21","sync":{"url":"","isSync":false},"title":"Webhooks","version":"57b6f40e480bae1900ce4e24","pages":[{"_id":"589b4d756d051e0f00f42f8e","slug":"webhooks","sync_unique":"","api":{"auth":"required","params":[],"results":{"codes":[{"status":200,"language":"json","code":"{}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"","method":"get","examples":{"codes":[]}},"hidden":false,"link_external":false,"order":0,"type":"basic","isReference":true,"title":"Webhooks","category":"581a406b1a63870f008b622f","createdAt":"2017-02-08T16:55:17.618Z","link_url":"","parentDoc":null,"previousSlug":"","deprecated":false,"icon":"","isBodyEmpty":false,"children":[{"_id":"5848715c1047990f00d2dc11","createdAt":"2016-12-07T20:30:20.663Z","type":"endpoint","hidden":false,"link_url":"","order":0,"api":{"method":"post","params":[{"name":"webhook.name","type":"string","enumValues":"","default":"","desc":"A name (or label) to give this webhook.","required":true,"in":"body","ref":"","_id":"58488b6c2c66840f004fdb37"},{"name":"webhook.url","type":"string","enumValues":"","default":"","desc":"The URL where the webhook will send the POST request when the event occurs. Note that for https endpoints, we only can send webhooks on port 443, the default https port.","required":true,"in":"body","ref":"","_id":"589a447b79a27e1b00dedb91"},{"name":"webhook.events","type":"array_string","enumValues":"","default":"","desc":"The [event(s)](#section-events) that will trigger the webhook to fire.","required":true,"in":"body","ref":"","_id":"589a447b79a27e1b00dedb90"},{"name":"webhook.sources","type":"array_string","enumValues":"","default":"","desc":"The [source(s)](#section-sources) causing an event to occur.","required":true,"in":"body","ref":"","_id":"589a447b79a27e1b00dedb8f"},{"name":"webhook.listid","type":"int","enumValues":"","default":"","desc":"The id of a list associated with an event. If set, only events happening on this list id will trigger the webhook. This parameter has no effect on the following webhook events: \"subscriber_note\", \"contact_tag_added\", \"contact_tag_removed\", \"contact_task_add\", \"list_add\", \"sms_sent\", \"sms_reply\", \"sms_unsub\", \"deal_add\", \"deal_update\", \"deal_note_add\", \"deal_pipeline_add\", \"deal_stage_add\", \"deal_task_add\", \"deal_tasktype_add\", \"deal_task_complete\", \"account_add\", \"account_update\", \"account_contact_add\", \"account_contact_update\",","required":false,"in":"body","ref":"","_id":"589a457379a27e1b00dedb97"}],"results":{"codes":[{"status":201,"name":"","code":"{\n \"webhook\": {\n \"cdate\": \"2016-01-01T12:00:00-00:00\",\n \"listid\": \"0\",\n \"name\": \"My Hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"public\",\n \"system\"\n ],\n \"links\": [],\n \"id\": \"1\"\n }\n}","language":"json"}]},"settings":"","url":"/webhooks","auth":"required","examples":{"codes":[{"code":"{\n \"webhook\": {\n \"name\": \"My Hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"public\",\n \"system\"\n ]\n }\n}","name":"JSON","language":"json"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"category":"581a406b1a63870f008b622f","link_external":false,"slug":"create-webhook","isReference":true,"title":"Create a webhook","parentDoc":"589b4d756d051e0f00f42f8e","sync_unique":"","deprecated":false,"previousSlug":"","icon":"","isBodyEmpty":false,"children":[]},{"_id":"588b6d7d6aca6f2500d115a2","createdAt":"2017-01-27T15:55:41.318Z","hidden":false,"sync_unique":"","title":"Retrieve a webhook","type":"endpoint","api":{"method":"get","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"","required":false,"in":"path","ref":"","_id":"588b81ea6aca6f2500d115fd"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n \"webhook\": {\n \"cdate\": \"2016-01-01T12:00:00-00:00\",\n \"listid\": \"0\",\n \"name\": \"My hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"admin\",\n \"api\",\n \"system\"\n ],\n \"links\": [],\n \"id\": \"1\"\n }\n}","name":""}]},"settings":"","url":"/webhooks/:id","auth":"required","examples":{"codes":[]},"apiSetting":"58b53c301065f9c438aa1f77"},"category":"581a406b1a63870f008b622f","isReference":true,"parentDoc":"589b4d756d051e0f00f42f8e","link_url":"","order":1,"link_external":false,"slug":"get-webhook","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"588b6d9b6aca6f2500d115a3","category":"581a406b1a63870f008b622f","isReference":true,"link_external":false,"slug":"update-webhook","type":"endpoint","createdAt":"2017-01-27T15:56:11.652Z","hidden":false,"parentDoc":"589b4d756d051e0f00f42f8e","order":2,"title":"Update a webhook","api":{"results":{"codes":[{"status":200,"language":"json","code":"{\n \"webhook\": {\n \"cdate\": \"2016-01-01T12:00:00-00:00\",\n \"listid\": \"0\",\n \"name\": \"My Hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"public\",\n \"system\"\n ],\n \"links\": [],\n \"id\": \"1\"\n }\n}","name":""},{"status":400,"language":"json","code":"{}","name":""}]},"settings":"","url":"/webhooks/:id","auth":"required","examples":{"codes":[{"language":"json","code":"{\n \"webhook\": {\n \"name\": \"My Hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"public\",\n \"system\"\n ]\n }\n}","name":null}]},"method":"put","params":[{"name":"id","type":"int","enumValues":"","default":"","desc":"The webhook id","required":false,"in":"path","ref":"","_id":"588b84c033b1b337002e644b"},{"name":"webhook.name","type":"string","enumValues":"","default":"","desc":"A name (or label) to give the webhook.","required":false,"in":"body","ref":"","_id":"588b84c033b1b337002e644a"},{"name":"webhook.url","type":"string","enumValues":"","default":"","desc":"The URL where the webhook will send the POST request when the event occurs.","required":false,"in":"body","ref":"","_id":"589a499be94a202500fa2f75"},{"name":"webhook.events","type":"array_string","enumValues":"","default":"","desc":"The The [event(s)](#section-events) that will trigger the webhook to fire. that will trigger the webhook to fire.","required":false,"in":"body","ref":"","_id":"589a499be94a202500fa2f74"},{"name":"webhook.sources","type":"array_string","enumValues":"","default":"","desc":"The [source(s)](#section-sources) causing an event to occur.","required":false,"in":"body","ref":"","_id":"589a499be94a202500fa2f73"},{"name":"webhook.listid","type":"int","enumValues":"","default":"","desc":"The id of a list associated with an event (required for some events).","required":false,"in":"body","ref":"","_id":"589a499be94a202500fa2f72"}],"apiSetting":"58b53c301065f9c438aa1f77"},"link_url":"","sync_unique":"","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"588b6dab33b1b337002e63ca","hidden":false,"title":"Delete a webhook","type":"endpoint","api":{"settings":"","url":"/webhooks/:id","auth":"required","examples":{"codes":[]},"method":"delete","params":[{"required":false,"desc":"The webhook id","default":"","type":"int","name":"id","_id":"588b8535e840643900a40ad5","ref":"","in":"path"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{}"}]},"apiSetting":"58b53c301065f9c438aa1f77"},"createdAt":"2017-01-27T15:56:27.027Z","link_url":"","order":3,"parentDoc":"589b4d756d051e0f00f42f8e","sync_unique":"","category":"581a406b1a63870f008b622f","link_external":false,"isReference":true,"slug":"delete-webhook","isBodyEmpty":true,"children":[]},{"_id":"588b6db933b1b337002e63cd","createdAt":"2017-01-27T15:56:41.870Z","link_url":"","sync_unique":"","isReference":true,"link_external":false,"order":4,"slug":"get-a-list-of-webhooks","category":"581a406b1a63870f008b622f","title":"List all webhooks","type":"endpoint","api":{"url":"/webhooks","auth":"required","examples":{"codes":[]},"method":"get","params":[{"name":"filters[name]","type":"string","enumValues":"","default":"","desc":"Filter by webhook name","required":false,"in":"query","ref":"","_id":"588ba3686aca6f2500d1165c"},{"name":"filters[url]","type":"string","enumValues":"","default":"","desc":"Filter by webhook url","required":false,"in":"query","ref":"","_id":"588ba3686aca6f2500d1165b"},{"name":"filters[listid]","type":"string","enumValues":"","default":"","desc":"Filter by webhook's associated list","required":false,"in":"query","ref":"","_id":"588ba3686aca6f2500d1165a"}],"results":{"codes":[{"name":"","code":"{\n \"webhooks\": [\n {\n \"cdate\": \"2016-01-01T12:00:00-00:00\",\n \"listid\": \"0\",\n \"name\": \"My Hook\",\n \"url\": \"http://example.com/my-hook\",\n \"events\": [\n \"subscribe\",\n \"unsubscribe\",\n \"sent\"\n ],\n \"sources\": [\n \"public\",\n \"system\"\n ],\n \"links\": [],\n \"id\": \"1\"\n },\n {\n \"cdate\": \"2016-01-01T12:00:00-00:00\",\n \"listid\": \"0\",\n \"name\": \"My Hook 2\",\n \"url\": \"http://example.com/my-hook-2\",\n \"events\": [\n \"subscribe\"\n ],\n \"sources\": [\n \"admin\"\n ],\n \"links\": [],\n \"id\": \"2\"\n },\n ],\n \"meta\": {\n \"total\": \"2\"\n }\n}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"settings":"","apiSetting":"58b53c301065f9c438aa1f77"},"hidden":false,"parentDoc":"589b4d756d051e0f00f42f8e","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"588b6dfd33b1b337002e63ce","link_external":false,"link_url":"","sync_unique":"","api":{"auth":"required","examples":{"codes":[]},"method":"get","params":[],"results":{"codes":[{"name":"","code":"{\n \"webhookEvents\": [\n \"bounce\",\n \"click\",\n \"contact_tag_added\",\n \"contact_tag_removed\",\n \"deal_add\",\n \"deal_note_add\",\n \"deal_pipeline_add\",\n \"deal_stage_add\",\n \"deal_task_add\",\n \"deal_task_complete\",\n \"deal_tasktype_add\",\n \"deal_update\",\n \"forward\",\n \"list_add\",\n \"open\",\n \"reply\",\n \"sent\",\n \"share\",\n \"sms_reply\",\n \"sms_sent\",\n \"sms_unsub\",\n \"subscribe\",\n \"subscriber_note\",\n \"unsubscribe\",\n \"update\"\n ],\n \"meta\": {\n \"total\": 25\n }\n}","language":"json","status":200}]},"settings":"","url":"/webhook/events","apiSetting":"58b53c301065f9c438aa1f77"},"category":"581a406b1a63870f008b622f","order":5,"type":"endpoint","slug":"get-a-list-of-webhook-events","title":"List all webhook events","createdAt":"2017-01-27T15:57:49.411Z","hidden":false,"isReference":true,"parentDoc":"589b4d756d051e0f00f42f8e","deprecated":false,"previousSlug":"","isBodyEmpty":false,"children":[]},{"_id":"62eab74e25a03503b3b57a19","api":{"method":"get","url":"","auth":"required","results":{"codes":[{"name":"","code":"{}","language":"json","status":200},{"name":"","code":"{}","language":"json","status":400}]},"params":[]},"title":"Webhook Payloads","icon":"","type":"link","slug":"webhook-payloads","order":6,"isReference":true,"deprecated":false,"hidden":false,"sync_unique":"","link_url":"https://developers.activecampaign.com/page/webhooks","link_external":true,"previousSlug":"","createdAt":"2022-08-03T17:58:38.142Z","category":"581a406b1a63870f008b622f","parentDoc":"589b4d756d051e0f00f42f8e","isBodyEmpty":true,"children":[]}]}]}]},"baseUrl":"/","apiBaseUrl":"/","search":{"appId":"T28YKFATPY","searchApiKey":"NmU0ZjJhOTMxMjE1MGYyODE2NTQ3YTMyNWQ5ODQ5ZjAyYzZkODBmZjljZDI5NTAyODhiZjU2ZmNlYjA0ZmNlZHRhZ0ZpbHRlcnM9KHByb2plY3Q6NTdiNmY0MGU0ODBiYWUxOTAwY2U0ZTIxKSwodmVyc2lvbjpub25lLHZlcnNpb246NTdiNmY0MGU0ODBiYWUxOTAwY2U0ZTI0KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6VHV0b3JpYWwp","indexName":"readme_search_v2","projectsMeta":[{"modules":{"landing":true,"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"changelog":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"id":"57b6f40e480bae1900ce4e21","name":"ActiveCampaign","subdomain":"activecampaign","subpath":"","nav_names":{"discuss":"Community","reference":"API Documentation","docs":"","changelog":"Latest Updates","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":"activecampaign"},"version":"3"}},"code":404,"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":"5d9b54490ad72700745f63cb","term":"Webhook","definition":"Rather than use a resource to manually make a call to an integration in order to recieve data, a webhook allows for real time data gathering by creating a subscription with the service. A webhook is an HTTP-POST_ that occurs when something happens and POST's a message to a URL. Webhooks are how we can utilize an integration to create a contact at ActiveCampaign as soon as a customer fills out a form from that integration."}],"variables":{"user":{},"defaults":[{"source":"server","_id":"62e17c7832cc61003cf46034","name":"youraccountname","default":"youraccountname","apiSetting":"58b53c301065f9c438aa1f77"},{"source":"security","_id":"62e17c7832cc61003cf46033","name":"Api-Token","type":"apiKey","default":"","apiSetting":"58b53c301065f9c438aa1f77"}]},"project":{"_id":"57b6f40e480bae1900ce4e21","appearance":{"html_body":"","html_footer_meta":"<!-- Google Tag Manager (noscript) -->\n<noscript><iframe src=\"https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R\"\nheight=\"0\" width=\"0\" style=\"display:none;visibility:hidden\"></iframe></noscript>\n<!-- End Google Tag Manager (noscript) -->\n\n<!-- Adobe Cloud Elements-->\n<script src=\"https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js\" async></script>\n<!-- End Adobe Cloud Elements-->\n\n<!-- ActiveCampaign Analytics-->\n<script>\n (function(e,t,o,n,p,r,i){e.visitorGlobalObjectAlias=n;e[e.visitorGlobalObjectAlias]=e[e.visitorGlobalObjectAlias]||function(){(e[e.visitorGlobalObjectAlias].q=e[e.visitorGlobalObjectAlias].q||[]).push(arguments)};e[e.visitorGlobalObjectAlias].l=(new Date).getTime();r=t.createElement(\"script\");r.src=o;r.async=true;i=t.getElementsByTagName(\"script\")[0];i.parentNode.insertBefore(r,i)})(window,document,\"https://diffuser-cdn.app-us1.com/diffuser/diffuser.js\",\"vgo\");\n vgo('setAccount', '223079033');\n vgo('setTrackByDefault', true);\n vgo('process');\n</script>\n<!-- END ActiveCampaign Analytics -->","html_promo":"<style>\n.Header-leftADQdGVqx1wqU {\n\tdisplay: none;\n}\n</style>\n<div class=\"flex items-center justify-between mx-auto space-x-20 p-4\">\n <!-- Logo -->\n <div class=\"z-30\">\n <object data=\"https://files.readme.io/27a245e-ActiveCampaign_Logo_White.png\" type=\"image/png\" width=\"300\" height=\"93\"\n class=\"mylogo\"></object>\n </div>\n <!-- Menu Items -->\n <div class=\"hidden items-center space-x-10 text-sm md:text-sm text-white font-ibm md:flex\">\n <a href=\"https://developers.activecampaign.com/page/getting-started\" class=\"tracking-widest hover:text-softRed\">Get Started</a>\n <a href=\"https://developers.activecampaign.com/docs/getting-started-and-guides\" class=\"tracking-widest hover:text-softRed\">Documentation</a>\n <a href=\" https://developers.activecampaign.com/reference/overview\" class=\"tracking-widest hover:text-softRed\">API</a>\n <a href=\"https://community.activecampaign.com/\" class=\"tracking-widest hover:text-softRed\">Community</a>\n <a href=\"https://developers.activecampaign.com/page/developer-sandbox-accounts\"\n class=\"whitespace-nowrap px-6 py-2 text-white bg-black rounded-md shadow-md hover:text-black duration-200 hover:bg-white\">Free\n Developer Account &nbsp; &#9656;</a>\n </div>\n </div>","javascript_hub2":"const tabs = document.querySelectorAll('.featureTab')\nconst panels = document.querySelectorAll('.panel')\n// const menu = document.getElementById('hamMenu')\n// const btn = document.getElementById('hamMenu-btn')\n\nawait new Promise(r => setTimeout(r, 2000));\n\n\n$( \".featureTab\" ).on(\"click\", (function() {\n alert( \"Handler for .click() called.\" );\n}));\n\n$(window).on('pageLoad', function(e, state) {\n $(\".toc-list\").toggle(![\"/docs\", \"/docs/start\"].includes(window.location.pathname));\n // Tabs menu event listener\n //tabs.forEach((tab) => {\n // tab.addEventListener('click', onTabClick);\n // console.log(\"Tab loaded: \", tab)\n //})\n $( \".featureTab\" ).on(\"click\", (function() {\n alert( \"Handler for .click() called.\" );\n }));\n console.log(\"PAGE LOADED\");\n\n // Hamburger btn listener\n // btn.addEventListener('click', navToggle)\n});\n\n\n// function navToggle() {\n// console.log(\"MENU TOGGLE CLICK\")\n// btn.classList.toggle('open')\n// menu.classList.toggle('flex')\n// menu.classList.toggle('hidden')\n// }\n\nfunction onTabClick(e) {\n \tconsole.log(\"TAB CLICK!\")\n // Deactivate all tabs\n tabs.forEach((tab) => {\n tab.children[0].classList.remove(\n 'border-darkCoral1',\n 'border-b-4',\n 'md:border-b-0',\n )\n })\n\n // Hide all panels\n panels.forEach((panel) => panel.classList.add('hidden'))\n\n // Activate a new tab and panel, based on target\n e.target.classList.add(\n 'border-darkCoral1',\n 'border-b-4'\n )\n\n const classString = e.target.getAttribute('data-target')\n document.getElementById('panels')\n .getElementsByClassName(classString)[0]\n .classList.remove('hidden')\n\n}","link_logo_to_url":true,"hide_logo":true,"landing":true,"logo":["https://files.readme.io/4bca7fa-small-ac_logo-blue-trans.png","ac_logo-blue-trans.png",784,80,"#356ae6","https://files.readme.io/da98f9e-ac_logo-blue-trans.png"],"promos":[{"extras":{"type":"html","buttonPrimary":"get-started","buttonSecondary":"none"},"title":"Let's build something great together","text":"When you build integrations with ActiveCampaign, you can have a positive impact on small businesses across the world. This is where you can find ActiveCampaign API documentation, SDKs, support, and a community of developers like you.","_id":"57b6f40e480bae1900ce4e22"}],"html_hidelinks":false,"overlay":"circuits","stylesheet":"","categoriesAsDropdown":false,"favicon":["https://files.readme.io/7779a2b-small-ac_mark-white-bluebg.png","ac_mark-white-bluebg.png",32,32,"#4274e8","https://files.readme.io/2b329b6-ac_mark-white-bluebg.png"],"html_head":"<link href=\"https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=Poppins:wght@700&display=swap\" rel=\"stylesheet\">\n<script src=\"https://cdn.tailwindcss.com\"></script>\n\n<script>\n tailwind.config = {\n content: [\n ],\n theme: {\n screens: {\n sm: '480px',\n md: '768px',\n lg: '1020px',\n xl: '1440px'\n },\n extend: {\n colors: {\n dusk: 'hsl(194, 100%, 13%)',\n darkDusk: 'hsla(195, 100%, 9%, 1)',\n acBlue: 'hsl(222, 100%, 50%)',\n mint: 'hsl(165, 95%, 70%)',\n coral: 'hsl(14, 100%, 79%)',\n acBlue200: 'hsl(206, 100%, 96%)',\n acBlueDark1: 'hsl(238, 100%, 33%)',\n acBlueDark2: 'hsl(230, 100%, 41%)',\n acBlueLight1: 'hsl(222, 100%, 66%)',\n acBlueLight2: 'hsl(222, 100%, 80%)',\n acBlueLight3: 'hsl(222, 100%, 90%)',\n acBlueLight4: ' hsl(223, 100%, 96%)',\n darkMint: ' hsl(166, 78%, 45%)',\n grayishBlue: 'hsl(201, 11%, 66%)',\n darkCoral1: 'hsl(11, 100%, 60%)',\n lightDusk3: 'hsl(194, 25%, 66%)',\n lightDusk4: 'hsl(194, 26%, 80%)',\n lightDusk5: 'hsl(192, 31%, 94%)',\n },\n fontFamily: {\n poppins: ['Poppins', 'sans-serif'],\n ibm: ['IBM Plex Sans', 'sans-serif']\n },\n },\n }\n }\n</script>\n\n<style>\n #ssr-main .rm-LandingPage {\n width: 100%;\n --LandingPage-gap: var(--gap, 0em);\n }\n .markdown-body .font-poppins {\n font-family: Poppins, sans-serif;\n }\n #ssr-main .markdown-body h1 {\n color: #000;\n }\n .markdown-body .lg\\:text-6xl {\n font-size: 3.75rem;\n }\n</style>\n\n\n<!-- Google Tag Manager -->\n<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\nnew Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\nj=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n})(window,document,'script','dataLayer','GTM-NQ88L9R');</script>\n<!-- End Google Tag Manager -->","notheme":false,"typography":{"body":"Open+Sans:400:sans-serif","headline":"Open+Sans:400:sans-serif","tk_body":"","tk_headline":"","tk_key":"","typekit":false},"javascript":"","logo_white":["https://files.readme.io/b425c4d-small-ac_logo-white-trans.png","ac_logo-white-trans.png",784,80,"#ffffff","https://files.readme.io/56cd12f-ac_logo-white-trans.png"],"nextStepsLabel":"","showVersion":false,"logo_white_use":true,"main_body":{"type":"links"},"stylesheet_hub2":"body { font-family: ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif !important; }\nbody, p { color: #1F2129; }\nheader#hub-header #header-top #header-logo {width: 200px !important; height: 33px !important; }\n.ac_info-general {\n background: #f7f7f7;\n padding: 14px;\n border: #c8c8c8 1px solid;\n border-radius: 5px;\n -webkit-border-radius: 5px;\n -moz-border-radius: 5px;\n box-sizing: border-box;\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n}\n.hub-landing-description p { color: #FFFFFF !important; }\n.ac_container.greyborder, .ac_container.ac_container-grayborder {\n border: #cacaca 1px solid;\n position: relative;\n padding: 0px 20px 20px 20px;\n border-radius: 6px !important;\n width: 100%;\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n box-sizing: border-box;\n}\n.mb40 { margin-bottom: 40px; }\n/* .ac h1, #content-head h1, h1.header-scroll, .ac h2, .ac h3 { font-weight: 600; color: #1F2129; font-family: poppins,avenir,avenir next,futura,helvetica,arial,sans-serif; }\n.ac h1, #content-head h1 { font-size: 32px !important; }\n.ac h2, h1.header-scroll { font-size: 26px !important; }\n.ac h3 { font-size: 22px !important; }\n.ac h5 { font-size: 16px !important; }\n.ac ul li { margin-left: 20px; margin-bottom: 10px; list-style-type: disc; }\n#header-nav-left a:hover { border-radius: 0px !important; box-shadow: none !important; background-color: transparent !important; }\n#header-top { background-attachment: fixed; }\n.getting-started ul { margin-top: 10px; }\n.getting-started li { font-weight: bold; }\n.getting-started ul li { font-weight: normal; }\n.ac .icon-announcements:before { content: \"\"; display: block; height: 31px; width: 31px; background-size: 31px 31px; }\n.ac .landing1 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/zvgparjvu_book@2x.png); }\n.ac .landing2 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/3pesfob91_globe@2x.png); }\n.ac .landing3 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/hq3wzwwu9_target@2x.png); } */\n\n.theme-solid header#hub-header #header-top #header-nav-left li, .theme-solid header#hub-header #header-top #header-nav-right li {\n padding-left: 10px;\n padding-right: 10px;\n}\n.theme-solid header#hub-header #header-top #header-nav-left li a, .theme-solid header#hub-header #header-top #header-nav-right li a {\n color: rgba(255,255,255,1) !important;\n padding: 0px !important;\n font-family: ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif;\n font-size: 14px !important;\n}\n.theme-solid header#hub-header #header-top #header-nav-left li a:hover, .theme-solid header#hub-header #header-top #header-nav-right li a:hover {\nborder-bottom: 2px solid;\nborder-color: #FFFFFF;\n padding-bottom: 7px !important;\n}\n\n\n#header-bottom-nav .hub-subheader-breadcrumbs { display: none !important; }\n#hub-subheader { background-color: #2a4c79 !important; }\n#hub-search input { background-color: #2a4c79 !important; color: rgba(255,255,255,.78) !important; }\n#hub-search input::placeholder { color: rgba(255,255,255,.78) !important; }\n#hub-search .fa.fa-search { color: rgba(255,255,255,.78) !important; }\n#content-head h1 { text-align: left; }\n\n/* .rm-Header * { border: none !important; } */\n.rm-Header * { --Header-border-width: 0px !important; }\n\n/* Everything below this line is Doppler CSS */\n@import url('//fonts.googleapis.com/css?family=Ubuntu:300,400,500,700');\n\n@media (max-width:600px) {\n body .content-body .selector,\n body .content-body .selector.long,\n body .content-body .selector.long.half,\n body .content-body .selector.long:not(.half)\n {\n float: none !important;\n clear: both !important;\n width: 100% !important;\n }\n}\n\nbody {\n\tfont-family: 'Ubuntu', 'Helvetica Neue', Helvetica, Arial, sans-serif;\n font-size: 15px;\n}\n\n#content-head .excerpt {\n padding-top: 1rem;\n}\n\n/* Hide Discuss link while we're evaluating it */\n.Dropdown a[href=\"/discuss\"] {\n display: none;\n}\n\n.grecaptcha-badge {\n\tdisplay: none !important;\n}\n\n.video-embed {\n position: relative;\n padding: 0 0 56.25% 0;\n max-width: 100%;\n height: auto;\n margin: 0;\n background: black;\n border: 1px solid #5875EB;\n border-radius: 4px;\n overflow: hidden;\n -webkit-box-shadow: 0 5px 12px rgba(62,62,62,0.2);\n -moz-box-shadown: 0 5px 12px rgba(62,62,62,0.2);\n box-shadow: 0 5px 12px rgba(62,62,62,0.2);\n}\n\n.video-embed iframe {\n position: absolute;\n top: 0px;\n left: 0;\n height: 100%;\n width: 100%;\n display: block;\n border: none;\n outline: none;\n}\n\n* {\n outline: none;\n -webkit-font-smoothing: subpixel-antialiased;\n -webkit-padding-start: 0px;\n}\n\n.content-body .selector {\n position: relative;\n top: 0;\n\tpadding: 25px 20px 35px 20px;\n border: solid 1px rgba(0,0,0,0.1);\n display: block;\n float: left;\n text-decoration: none;\n width: calc((100%/3) - 20px);\n -webkit-border-radius: 7px;\n -moz-border-radius: 7px;\n border-radius: 7px;\n text-align: center;\n color: black;\n text-decoration: none !important;\n margin-right: 20px;\n margin-bottom: 20px;\n -webkit-transition: all .2s ease .01s;\n -moz-transition: all .2s ease .01s;\n -o-transition: all .2s ease .01s;\n transition: all .2s ease .01s;\n -webkit-box-shadow: 0 4px 10px rgba(62,62,62,.03);\n -moz-box-shadown: 0 4px 10px rgba(62,62,62,.03);\n box-shadow: 0 4px 10px rgba(62,62,62,.03);\n}\n\n.content-body .selector.col-2 {\n width: calc((100%/2) - 20px);\n}\n\n\n.content-body .selector:hover {\n\tborder-color: #4968F1;\n top: -2px;\n border-color: #8297f9;\n -webkit-box-shadow: 0 5px 8px rgba(81,111,247,.2);\n -moz-box-shadown: 0 5px 8px rgba(81,111,247,.2);\n box-shadow: 0 5px 8px rgba(81,111,247,.2);\n}\n\n.content-body .selector.long {\n\tpadding-bottom: 20px;\n}\n\n.content-body .selector.long:not(.half) {\n\twidth: calc(100% - 30px);\n}\n\n.content-body .selector.long.half {\n\twidth: calc(50% - 30px);\n}\n\n.content-body .selector.long .icon {\n\tfloat: left;\n height: 50px;\n}\n\n.content-body .selector.long .selector-info {\n\tfloat: right;\n width: calc(100% - 70px);\n text-align: left;\n}\n\n.content-body .selector .icon {\n font-size: 40px;\n height: 40px;\n margin-bottom: 20px;\n}\n\n.content-body .selector .title {\n font-size: 18px;\n font-weight: 500;\n}\n\n.content-body .selector .description {\n font-size: 15px;\n line-height: 20px;\n margin: 8px 0 10px 0;\n color: rgba(0,0,0,0.5);\n}\n\n.content-body .selector .description strong {\n\tdisplay: block;\n margin-top: 5px;\n}\n\n.content-body .selector .est {\n font-size: 15px;\n line-height: 18px;\n color: #4968F1;\n font-style: italic;\n}\n\n.content-body .clear {\n float: none;\n clear: both;\n}\n\n.CodeTabs-toolbar button:only-child {\n\tdisplay: none;\n}\n\n.Header-searchtb6Foi0-D9Vx {\nposition: relative !important;\nmargin-left: auto !important;\nmargin-bottom: 5px;\n}","header":{"img":["https://files.readme.io/8fdd9b9-010.jpg","010.jpg",2048,1379,"#917569"],"img_pos":"tl","img_size":"auto","style":"gradient"},"hideTableOfContents":false,"sticky":false,"body":{"style":"none"},"colors":{"body_highlight":"","header_text":"","main_alt":"","main":"#356ae6","highlight":"","custom_login_link_color":""},"html_footer":"<!-- Google Tag Manager (noscript) -->\n<noscript><iframe src=\"https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R\"\nheight=\"0\" width=\"0\" style=\"display:none;visibility:hidden\"></iframe></noscript>\n<!-- End Google Tag Manager (noscript) -->\n<script src=\"https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js\" async></script>","theme":"solid","referenceLayout":"row","childrenAsPills":false,"global_landing_page":{"html":"","redirect":""},"splitReferenceDocs":false,"rdmd":{"callouts":{"useIconFont":false},"theme":{"background":"","border":"","markdownEdge":"","markdownFont":"","markdownFontSize":"","markdownLineHeight":null,"markdownRadius":"","markdownText":"","markdownTitle":"","markdownTitleFont":"","mdCodeBackground":"","mdCodeFont":"","mdCodeRadius":"","mdCodeTabs":"","mdCodeText":"","tableEdges":"","tableHead":"","tableHeadText":"","tableRow":"","tableStripe":"","tableText":"","text":"","title":""}},"subheaderStyle":"dropdown","showMetricsInReference":false,"referenceSimpleMode":true,"stylesheet_hub3":"","loginLogo":[],"logo_large":false,"colorScheme":"light","changelog":{"layoutExpanded":false,"showAuthor":true,"showExactDate":false},"allowApiExplorerJsonEditor":false},"custom_domain":"developers.activecampaign.com","childrenProjects":[],"derivedPlan":"business","description":"Documentation for ActiveCampaign's APIs and native CX apps built with App Studio","error404":"","experiments":[],"first_page":"landing","flags":{"hub2":true,"jwt":false,"migrationRun":false,"migrationSwaggerRun":true,"allowXFrame":false,"allow_hub2":false,"autoSslGeneration":true,"correctnewlines":false,"swagger":false,"hideGoogleAnalytics":false,"oauth":false,"speedyRender":false,"stripe":false,"cookieAuthentication":false,"directGoogleToStableVersion":false,"disableAnonForum":false,"enterprise":false,"newApiExplorer":true,"newEditor":true,"translation":false,"alwaysShowDocPublishStatus":false,"newMarkdown":false,"newMarkdownBetaProgram":false,"newMarkdownLooseMode":false,"oldMarkdown":false,"newSearch":true,"rdmdCompatibilityMode":false,"staging":false,"tutorials":true,"allowApiExplorerJsonEditor":false,"useReactApp":true,"newHeader":false,"referenceRedesign":false,"auth0Oauth":false,"graphql":true,"singleProjectEnterprise":false,"dashReact":false,"allowReferenceUpgrade":true,"metricsV2":true,"newEditorDash":true,"enableRealtimeExperiences":false,"reviewWorkflow":true,"star":false,"allowDarkMode":false,"forceDarkMode":false,"useReactGLP":false,"disablePasswordlessLogin":false,"personalizedDocs":false,"myDevelopers":false,"superHub":false,"developerDashboard":false,"allowReusableOTPs":false,"dashHomeRefresh":false,"owlbotAi":true,"apiV2":false,"git":{"read":false,"write":false},"superHubBeta":false,"dashQuickstart":false,"disableAutoTranslate":false,"customBlocks":false,"devDashHub":false,"disableSAMLScoping":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":false},"fullBaseUrl":"https://developers.activecampaign.com/","git":{"migration":{"createRepository":{},"transformation":{},"migratingPages":{},"enableSuperhub":{}},"sync":{"connectedRepository":{"organization":{},"privacy":{}},"installationRequest":{},"github":[]}},"glossaryTerms":[{"_id":"5d9b54490ad72700745f63cb","term":"Webhook","definition":"Rather than use a resource to manually make a call to an integration in order to recieve data, a webhook allows for real time data gathering by creating a subscription with the service. A webhook is an HTTP-POST_ that occurs when something happens and POST's a message to a URL. Webhooks are how we can utilize an integration to create a contact at ActiveCampaign as soon as a customer fills out a form from that integration."}],"graphqlSchema":"https://swapi-graphql.netlify.app/.netlify/functions/index","gracePeriod":{"enabled":false,"endsAt":null},"shouldGateDash":false,"hasOneChild":false,"healthCheck":{"provider":"statusPage","settings":{"page":"36wq37z91g4s","status":false,"url":""}},"intercom_secure_emailonly":false,"intercom":"","is_active":true,"internal":"","jwtExpirationTime":0,"landing_bottom":[{"html":" <!-- Hero Section -->\n\n <section id=\"hero\" class=\"bg-acBlue200 px-4\">\n <!-- Container For Image & Content -->\n <div class=\"container flex flex-col-reverse mx-auto p-6 lg:flex-row lg:mb-0\">\n <!-- Content -->\n <div class=\"flex flex-col space-y-10 lg:w-1/2\">\n <p class=\"text-3xl font-bold font-poppins text-center pt-16 lg:text-5xl lg:text-left\">\n Easily Integrate Your App With Ours.\n </p>\n <p class=\"max-w-md mx-auto text-lg font-ibm text-center text-gray-400 lg:text-xl lg:text-left lg:mt-0 lg:mx-0\">\n Help over 180,000 businesses around the world deliver unique customer experiences by building an app with\n ActiveCampaign.\n </p>\n <div class=\"no-underline flex items-center justify-center w-full space-x-4 lg:justify-start\">\n <!-- <a href=\"https://developers.activecampaign.com/page/getting-started\"\n class=\"font-ibm p-4 text-sm text-white bg-acBlue rounded-lg shadow-md border-2 border-acBlue md:text-base hover:bg-acBlueLight4 hover:text-black duration-200\">Get Started</a> -->\n <a href=\"https://developers.activecampaign.com/page/getting-started\" style=\"text-decoration: none !important;\"\n class=\"font-ibm px-10 py-5 font-bold text-white rounded-lg bg-acBlueLight1 hover:bg-dusk lg:text-base focus:outline-none drop-shadow-lg hover:text-white hover:drop-shadow-sm transition\">\n Get Started\n </a>\n </div>\n </div>\n <!-- Image -->\n <div class=\"relative mx-auto lg:mx-0 lg:mb-0 lg:w-1/2\">\n <div class=\"bg-hero\">\n\n </div>\n <img src=\"https://files.readme.io/1378981-header_splashv1.png\" alt=\"\"\n class=\"relative z-10 lg:top-24 xl:top-0 overflow-x-visible\">\n </div>\n </div>\n </section>\n <div class=\"px-4\">\n <!-- Features Heading -->\n <section class=\"mb-8\" id=\"features\">\n <div class=\"container mx-auto mt-16 px-6\">\n <h2 class=\"mb-16 text-3xl text-center font-poppins\">WAYS TO BUILD</h2>\n <p class=\"pt-4 mx-auto text-center text-4xl font-bold font-poppins\">\n Choose how you integrate with ActiveCampaign\n </p>\n </div>\n </section>\n <!-- Ways to build Section -->\n <section id=\"paths\" class=\"pt-8\">\n <div class=\"relative items-stretch container flex flex-col mx-auto md:flex-row md:space-x-7\">\n <!-- App Studio CX App -->\n <div\n class=\"mb-4 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div class=\"w-20 h-20 absolute -ml-10 left-1/2 md:left-16\">\n <img src=\"https://files.readme.io/56f33b7-ac_app_studio_cx_il.png\" alt=\"\">\n </div>\n <div class=\"pt-8\">\n <h2 class=\"pt-6 text-3xl font-bold text-center font-ibm md:text-left\">App Studio CX App</h2>\n <p class=\"font-ibm text-center text-lg text-gray-400 md:text-left\">\n App Studio is a self-serve portal for developers and SaaS companies interested in building apps on our\n platform. Independently write and test code, submit code for review, and release an approved CX App\n directly\n into the ecosystem.\n </p>\n </div>\n <a href=\"https://developers.activecampaign.com/docs\" style=\"text-decoration: none !important;\"\n class=\"font-ibm py-3 text-base font-bold text-acBlueLight1 focus:outline-none\">\n Build an App Studio CX App &nbsp; &#9656;\n </a>\n </div>\n\n <!-- Deep Data -->\n <div\n class=\"mb-4 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div class=\"w-20 h-20 absolute -ml-10 left-1/2 md:left-16\">\n <img src=\"https://files.readme.io/b9bbc6a-ac_deep_data_il.png\" alt=\"\">\n </div>\n <div class=\"pt-8\">\n <h2 class=\"pt-6 text-3xl font-bold text-center font-ibm md:text-left\">Deep Data</h2>\n <p class=\"font-ibm text-center text-lg text-gray-400 md:text-left\">\n Use ActiveCampaign's powerful Deep Data tools to link external services.\n </p>\n </div>\n <a href=\"https://developers.activecampaign.com/reference/connections\" style=\"text-decoration: none !important;\"\n class=\"font-ibm py-3 text-base font-bold text-acBlueLight1 focus:outline-none\">\n Build a Deep Data Integration &nbsp; &#9656;\n </a>\n </div>\n <!-- ActiveCampaign API -->\n <div\n class=\"mb-4 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div class=\"w-20 h-20 absolute -ml-10 left-1/2 md:left-16\">\n <img src=\"https://files.readme.io/58952fd-ac_api_il.png\" alt=\"\">\n </div>\n <div class=\"pt-8\">\n <h2 class=\"pt-6 text-3xl font-bold text-center font-ibm md:text-left\">ActiveCampaign API</h2>\n <p class=\"font-ibm text-center text-lg text-gray-400 md:text-left\">\n App Studio not for you? Check out the ActiveCampaign REST API for your integration. API endpoint URLs\n return JSON, and are organized around resources, such as contacts or deals.\n </p>\n </div>\n <a href=\"https://developers.activecampaign.com/reference/overview\" style=\"text-decoration: none !important;\"\n class=\"font-ibm py-3 text-base font-bold text-acBlueLight1 focus:outline-none\">\n View API Documentation &nbsp; &#9656;\n </a>\n </div>\n </div>\n </section>\n <!-- Examples Section-->\n <section id=\"examples\">\n <div class=\"container mx-auto px-6\">\n <p class=\"mx-auto text-center pt-8 text-4xl font-bold font-poppins\">\n CX App Examples\n </p>\n <p class=\"pt-8 max-w-md mx-auto text-center text-lg font-ibm text-gray-400\">\n Explore what's possible with App Studio. Get inspired with examples of our popular CX apps.\n </p>\n </div>\n </section>\n <!-- NEW Examples Section -->\n <section id=\"paths\" class=\"pt-16\">\n <div class=\"relative items-stretch container flex flex-col mx-auto md:flex-row md:space-x-7\">\n <!-- TWILIO -->\n <div\n class=\"mb-20 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div>\n <div class=\"pb-8\">\n <img src=\"https://files.readme.io/f98987c-twillio_logo.png\" alt=\"\">\n </div>\n <p class=\"font-ibm text-xl text-gray-400 md:text-left\">\n Basic Auth <br>\n Outbound Workflows\n </p>\n </div>\n <div class=\"flex flex-col text-center space-y-4 md:space-y-0 md:space-x-4 md:flex-row\">\n <a href=\"https://developers.activecampaign.com/docs/twillio-sms-outbound-example\"\n style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-white bg-acBlueDark2 rounded-md duration-200 hover:bg-white\">\n See code</a>\n\n <a href=\"https://www.activecampaign.com/apps/twilio-integration\" style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-acBlueDark2\">\n Marketplace &nbsp; &#8250;</a>\n </div>\n </div>\n <!-- CALENDLY -->\n <div\n class=\"mb-20 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div>\n <div class=\"pb-8\">\n <img src=\"https://files.readme.io/9d45abc-calendly_logo_crlvl.png\" alt=\"\">\n </div>\n <p class=\"font-ibm text-xl text-gray-400 md:text-left\">\n OAuth2, Custom Objects <br>\n Bidirectional Workflows\n </p>\n </div>\n <div class=\"flex flex-col text-center space-y-4 md:space-y-0 md:space-x-4 md:flex-row\">\n <a href=\"https://developers.activecampaign.com/docs/calendly-custom-objects-example\"\n style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-white bg-acBlueDark2 rounded-md duration-200 hover:bg-white\">\n See code</a>\n\n <a href=\"https://www.activecampaign.com/apps/calendly-integration\" style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-acBlueDark2\">\n Marketplace &nbsp; &#8250;</a>\n </div>\n </div>\n <!-- SLACK -->\n <div\n class=\"mb-20 relative justify-between flex flex-col p-6 space-y-6 bg-white rounded-lg md:w-1/3 drop-shadow-lg\">\n <div>\n <div class=\"pb-8\">\n <img src=\"https://files.readme.io/801c79e-fcb07bb-cr-slack_logo.png\" alt=\"\">\n </div>\n <p class=\"font-ibm text-xl text-gray-400 md:text-left\">\n OAuth2<br>\n Bidirectional Workflows\n </p>\n </div>\n <div class=\"flex flex-col text-center space-y-4 md:space-y-0 md:space-x-4 md:flex-row\">\n <a href=\"https://developers.activecampaign.com/docs/slack-outbound-example\"\n style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-white bg-acBlueDark2 rounded-md duration-200 hover:bg-white\">\n See code</a>\n\n <a href=\"https://www.activecampaign.com/apps/slack-integration\" style=\"text-decoration: none !important;\"\n class=\"whitespace-nowrap w-full text-md py-2 mx-auto font-ibm text-acBlueDark2\">\n Marketplace &nbsp; &#8250;</a>\n </div>\n </div>\n </div>\n </section>\n </div>\n\n <!-- CTA Section -->\n <section id=\"cta\" class=\"py-24 pt-16 bg-acBlueDark2\">\n <div class=\"flex flex-col p-2 space-y-6\">\n <p class=\"text-xl lg:text-3xl font-bold font-poppins text-center text-white\">\n Integrate with our 180k+ customers globally.\n </p>\n <p class=\"pb-10 text-xl lg:text-3xl font-bold font-poppins text-center text-white\">\n Start building today\n </p>\n <a href=\"https://developers.activecampaign.com/page/developer-sandbox-accounts\"\n style=\"text-decoration: none !important;\"\n class=\"px-10 text-2xl py-3 mx-auto font-ibm text-white bg-black rounded-md shadow-md hover:text-black duration-200 hover:bg-white\">\n Free developer account &nbsp; &#9656;\n </a>\n </div>\n </section>\n <!-- Footer -->\n <footer class=\"py-16 bg-dusk\">\n <!-- Footer Flex Container -->\n <div class=\"container flex-flex-col items-center justify-between mx-auto space-y-16 md:flex-row md:space-y-0\">\n <!-- AC Logo And Menu Container -->\n <div\n class=\"flex flex-col items-center justify-between space-y-8 text-lg font-poppins md:flex-row md:space-y-0 md:space-x-14 text-grayishBlue\">\n <img src=\"https://files.readme.io/dd8a403-ActiveCampaign_Logo_White.png\" alt=\"\" class=\"mb-1\" width=\"300\"\n height=\"100\" />\n <a href=\"https://www.activecampaign.com/about/careers\"\n class=\"font-light font-poppins uppercase hover:text-darkCoral1\"\n style=\"text-decoration: none !important;\">Careers</a>\n <a href=\"https://community.activecampaign.com/\" class=\"font-light font-poppins uppercase hover:text-darkCoral1\"\n style=\"text-decoration: none !important;\">Community</a>\n <a href=\"https://developers.activecampaign.com/reference/overview\"\n class=\"font-light font-poppins uppercase hover:text-darkCoral1\"\n style=\"text-decoration: none !important;\">Documentation</a>\n\n <!-- Social Container -->\n <div class=\"flex space-x-10\">\n <a href=\"https://www.facebook.com/activecampaign/\">\n <img src=\"https://files.readme.io/ead400e-icon-facebook.svg\" alt=\"\" class=\"h-6 ficon pl-6\">\n </a>\n <a href=\"https://twitter.com/ActiveCampaign\">\n <img src=\"https://files.readme.io/32e0686-icon-twitter.svg\" alt=\"\" class=\"h-6 ficon pr-6\">\n </a>\n </div>\n </div>\n </div>\n </footer>\n","alignment":"left","type":"html"}],"mdxMigrationStatus":"rdmd","metrics":{"enabled":false,"thumbsEnabled":true,"monthlyLimit":0,"planLimit":1000000,"realtime":{"dashEnabled":false,"hubEnabled":false},"monthlyPurchaseLimit":0,"meteredBilling":{}},"modules":{"landing":true,"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"changelog":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"name":"ActiveCampaign","nav_names":{"discuss":"Community","reference":"API Documentation","docs":"","changelog":"Latest Updates","tutorials":"","recipes":""},"oauth_url":"","onboardingCompleted":{"documentation":true,"appearance":true,"jwt":true,"api":true,"logs":false,"domain":true,"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":"business","planOverride":"","planSchedule":{"stripeScheduleId":null,"changeDate":null,"nextPlan":null},"planStatus":"active","planTrial":"business","readmeScore":{"components":{"newDesign":{"enabled":true,"points":25},"reference":{"enabled":true,"points":50},"tryItNow":{"enabled":true,"points":35},"syncingOAS":{"enabled":false,"points":10},"customLogin":{"enabled":true,"points":25},"metrics":{"enabled":false,"points":40},"recipes":{"enabled":true,"points":15},"pageVoting":{"enabled":true,"points":1},"suggestedEdits":{"enabled":true,"points":10},"support":{"enabled":false,"points":5},"htmlLanding":{"enabled":true,"points":5},"guides":{"enabled":true,"points":10},"changelog":{"enabled":true,"points":5},"glossary":{"enabled":false,"points":1},"variables":{"enabled":true,"points":1},"integrations":{"enabled":false,"points":2}},"percentScore":37.5,"totalScore":182},"reCaptchaSiteKey":"","reference":{"alwaysUseDefaults":true,"defaultExpandResponseExample":false,"defaultExpandResponseSchema":false,"enableOAuthFlows":false},"seo":{"overwrite_title_tag":false},"stable":{"_id":"57b6f40e480bae1900ce4e24","categories":["57b6f40e480bae1900ce4e25","57b6f456aabccd0e00f24909","581a406b1a63870f008b622f","5849b5aefcabe31900998f5b","5849beaf0e1b5e0f00854080","5849d43a3bcfb30f00dde73b","584b206696f59f0f006157b3","5898e1b8ec49fb0f004c25fa","58ac99cca7906a2f0076ab67","58b05f83f634c737009156fd","58b49200d373740f008f6037","58b5ee57e31a610f003a59b5","58bd8ada8bea2c0f00ea6b3a","58bdca9a5cbad00f00124aff","58c02f80b094740f005116e3","58d2d420ad20be0f00ccbacc","58ebd613cbc3f70f009b9fa0","5b969043eea09300037d6e13","5b96a8e64ab6050003d69afa","5b96af094ab6050003d69d34","5b96c453ff009a0003fd13cd","5b99eca243d76f000384cb35","5b9a92a8c7ccfc0003acd89c","5b9aa0c0ea73db0003e33345","5b9aa5f3ea73db0003e33438","5b9ac09f30f1ec000393414a","5b9ac81c3acc1d0003c40009","5b9acb6e3acc1d0003c40121","5b9af9bccd7ed6000349448f","5b9afbb7be532f00037e75d5","5b9afefacf6a7e000348cf36","5b9b019bcf6a7e000348cf47","5b9b0242cf6a7e000348cf4b","5ba11a83b882f80003ccc409","5ba121db0ae76c0003a81231","5ba8f0de4c8c220003a08e40","5ba8fcdf12256800034de280","5babcb62e00bd400038d86b9","5bad3f41f56aff0003cff86f","5bad3f4f25ecd000036a151f","5bafdba5e6b5a300037f0147","5bb57211a1c16c00038041e1","5bee4153e47f490026b87250","5bee81df54e56600185c31fd","5bef7a2dc032320012296403","5bef7ef71d361e0135e2cfb2","5cdc67c4e8507c00140b8c2e","5cdc690b0c875a00398c2f28","5d8b7ac425e74f031c7f1e5c","5db83db17af01c006ffd5afb","5dc0318ac91e080029778cb7","6040812e86f98900181314a1","6048f06d3b522500189b088f","606df980ba13ce004065499d","606df9c9f2d25500318e5720","606dff0a770ebe0047fe6868","6075e4661fc6a80010e74e4b","609d734d2db60f0028e7de3e","609d8058fca70d0040bb3111","60d0a822312198006373ede4","62335be3f4c0ca005a6b27ab","6283c8636cbbce009dc7e5f8","629a2817d3188a02dd769061","629a286e5b28390048c4c8ee","6376b408081e400003bab893","63f53fee77575500513a73e4","64065189fda1c20046cebc77","64cab60c5659c2000a4e8e02","6564c6f3d898bd0050f74cca"],"releaseDate":"2016-08-19T11:57:02.414Z","version":"3","version_clean":"3.0.0","__v":51,"createdAt":"2016-08-19T11:57:02.414Z","is_beta":false,"is_deprecated":false,"is_hidden":false,"is_stable":true,"project":"57b6f40e480bae1900ce4e21","codename":"","updatedAt":"2023-11-27T16:42:27.379Z"},"subdomain":"activecampaign","subpath":"","superHubWaitlist":true,"topnav":{"edited":true,"left":[{"type":"home","text":"Home"},{"text":"Sandbox Accounts","page":"developer-sandbox-accounts","type":"custompage","url":"/page/developer-sandbox-accounts"},{"type":"reference","text":"API Documentation"},{"type":"url","url":"/docs","text":"App Studio"},{"url":"/page/webhooks","text":"Webhooks","type":"custompage","page":"webhooks"},{"type":"url","text":"Community","url":"https://community.activecampaign.com/c/developers/16"}],"right":[],"bottom":[]},"trial":{"trialEndsAt":"2016-09-02T11:57:02.389Z","trialDeadlineEnabled":true},"translate":{"languages":[],"provider":"transifex","key_public":"","org_name":"","project_name":"","show_widget":false},"url":"https://www.activecampaign.com/","versions":[{"_id":"57b6f54aaabccd0e00f24913","codename":"","is_beta":false,"is_stable":false,"version":"1.0","version_clean":"1.0.0","categories":["57b6f54aaabccd0e00f24914","57b6f54aaabccd0e00f24915","57b6f75a3d3e620e004ec726","584984a9bd8d22390066ca27","6376b408081e400003bab892"],"createdAt":"2016-08-19T12:02:18.266Z","is_deprecated":false,"is_hidden":true,"project":"57b6f40e480bae1900ce4e21","releaseDate":"2016-08-19T12:02:18.266Z","__v":3},{"_id":"57b6f40e480bae1900ce4e24","categories":["57b6f40e480bae1900ce4e25","57b6f456aabccd0e00f24909","581a406b1a63870f008b622f","5849b5aefcabe31900998f5b","5849beaf0e1b5e0f00854080","5849d43a3bcfb30f00dde73b","584b206696f59f0f006157b3","5898e1b8ec49fb0f004c25fa","58ac99cca7906a2f0076ab67","58b05f83f634c737009156fd","58b49200d373740f008f6037","58b5ee57e31a610f003a59b5","58bd8ada8bea2c0f00ea6b3a","58bdca9a5cbad00f00124aff","58c02f80b094740f005116e3","58d2d420ad20be0f00ccbacc","58ebd613cbc3f70f009b9fa0","5b969043eea09300037d6e13","5b96a8e64ab6050003d69afa","5b96af094ab6050003d69d34","5b96c453ff009a0003fd13cd","5b99eca243d76f000384cb35","5b9a92a8c7ccfc0003acd89c","5b9aa0c0ea73db0003e33345","5b9aa5f3ea73db0003e33438","5b9ac09f30f1ec000393414a","5b9ac81c3acc1d0003c40009","5b9acb6e3acc1d0003c40121","5b9af9bccd7ed6000349448f","5b9afbb7be532f00037e75d5","5b9afefacf6a7e000348cf36","5b9b019bcf6a7e000348cf47","5b9b0242cf6a7e000348cf4b","5ba11a83b882f80003ccc409","5ba121db0ae76c0003a81231","5ba8f0de4c8c220003a08e40","5ba8fcdf12256800034de280","5babcb62e00bd400038d86b9","5bad3f41f56aff0003cff86f","5bad3f4f25ecd000036a151f","5bafdba5e6b5a300037f0147","5bb57211a1c16c00038041e1","5bee4153e47f490026b87250","5bee81df54e56600185c31fd","5bef7a2dc032320012296403","5bef7ef71d361e0135e2cfb2","5cdc67c4e8507c00140b8c2e","5cdc690b0c875a00398c2f28","5d8b7ac425e74f031c7f1e5c","5db83db17af01c006ffd5afb","5dc0318ac91e080029778cb7","6040812e86f98900181314a1","6048f06d3b522500189b088f","606df980ba13ce004065499d","606df9c9f2d25500318e5720","606dff0a770ebe0047fe6868","6075e4661fc6a80010e74e4b","609d734d2db60f0028e7de3e","609d8058fca70d0040bb3111","60d0a822312198006373ede4","62335be3f4c0ca005a6b27ab","6283c8636cbbce009dc7e5f8","629a2817d3188a02dd769061","629a286e5b28390048c4c8ee","6376b408081e400003bab893","63f53fee77575500513a73e4","64065189fda1c20046cebc77","64cab60c5659c2000a4e8e02","6564c6f3d898bd0050f74cca"],"releaseDate":"2016-08-19T11:57:02.414Z","version":"3","version_clean":"3.0.0","__v":51,"createdAt":"2016-08-19T11:57:02.414Z","is_beta":false,"is_deprecated":false,"is_hidden":false,"is_stable":true,"project":"57b6f40e480bae1900ce4e21","codename":"","updatedAt":"2023-11-27T16:42:27.379Z"}],"variableDefaults":[{"source":"server","_id":"62e17c7832cc61003cf46034","name":"youraccountname","default":"youraccountname","apiSetting":"58b53c301065f9c438aa1f77"},{"source":"security","_id":"62e17c7832cc61003cf46033","name":"Api-Token","type":"apiKey","default":"","apiSetting":"58b53c301065f9c438aa1f77"}],"webhookEnabled":false,"isHubEditable":true},"projectStore":{"data":{"allow_crawlers":"disabled","glossary":[{"_id":"5d9b54490ad72700745f63cb","term":"Webhook","definition":"Rather than use a resource to manually make a call to an integration in order to recieve data, a webhook allows for real time data gathering by creating a subscription with the service. A webhook is an HTTP-POST_ that occurs when something happens and POST's a message to a URL. Webhooks are how we can utilize an integration to create a contact at ActiveCampaign as soon as a customer fills out a form from that integration."}],"canonical_url":null,"description":"Documentation for ActiveCampaign's APIs and native CX apps built with App Studio","parent":null,"homepage_url":"https://www.activecampaign.com/","id":"57b6f40e480bae1900ce4e21","is_migrated":false,"name":"ActiveCampaign","redirects":[],"sitemap":"disabled","subdomain":"activecampaign","suggested_edits":"enabled","uri":"/projects/me","variable_defaults":[{"name":"youraccountname","default":"youraccountname","source":"server","id":"62e17c7832cc61003cf46034"},{"name":"Api-Token","default":"","source":"security","type":"apiKey","id":"62e17c7832cc61003cf46033"}],"webhooks":[],"custom_login":{"login_url":null,"logout_url":null},"onboarding_completed":{"api":true,"appearance":true,"documentation":true,"domain":true,"jwt":true,"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":"disabled","response_examples":"collapsed","response_schemas":"collapsed"},"seo":{"overwrite_title_tag":"disabled"},"plan":{"type":"business","grace_period":{"enabled":false,"end_date":null},"trial":{"expired":false,"end_date":"2016-09-02T11:57:02.389Z"}},"health_check":{"provider":"statuspage","settings":{"manual":{"status":"down","url":null},"statuspage":{"id":"36wq37z91g4s"}}},"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":"enabled","custom_code":{"css":"enabled","html":"enabled","js":"enabled"}}},"appearance":{"brand":{"primary_color":"#356ae6","link_color":null,"theme":"light"},"changelog":{"layout":"collapsed","show_author":true,"show_exact_date":false},"markdown":{"callouts":{"icon_font":"emojis"}},"table_of_contents":"enabled","whats_next_label":null,"footer":{"readme_logo":"hide"},"logo":{"size":"default","dark_mode":{"uri":null,"url":"https://files.readme.io/b425c4d-small-ac_logo-white-trans.png","name":"ac_logo-white-trans.png","width":784,"height":80,"color":"#ffffff","links":{"original_url":"https://files.readme.io/56cd12f-ac_logo-white-trans.png"}},"main":{"uri":null,"url":"https://files.readme.io/4bca7fa-small-ac_logo-blue-trans.png","name":"ac_logo-blue-trans.png","width":784,"height":80,"color":"#356ae6","links":{"original_url":"https://files.readme.io/da98f9e-ac_logo-blue-trans.png"}},"favicon":{"uri":null,"url":"https://files.readme.io/7779a2b-small-ac_mark-white-bluebg.png","name":"ac_mark-white-bluebg.png","width":32,"height":32,"color":"#4274e8","links":{"original_url":"https://files.readme.io/2b329b6-ac_mark-white-bluebg.png"}}},"custom_code":{"css":"body { font-family: ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif !important; }\nbody, p { color: #1F2129; }\nheader#hub-header #header-top #header-logo {width: 200px !important; height: 33px !important; }\n.ac_info-general {\n background: #f7f7f7;\n padding: 14px;\n border: #c8c8c8 1px solid;\n border-radius: 5px;\n -webkit-border-radius: 5px;\n -moz-border-radius: 5px;\n box-sizing: border-box;\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n}\n.hub-landing-description p { color: #FFFFFF !important; }\n.ac_container.greyborder, .ac_container.ac_container-grayborder {\n border: #cacaca 1px solid;\n position: relative;\n padding: 0px 20px 20px 20px;\n border-radius: 6px !important;\n width: 100%;\n -webkit-box-sizing: border-box;\n -moz-box-sizing: border-box;\n box-sizing: border-box;\n}\n.mb40 { margin-bottom: 40px; }\n/* .ac h1, #content-head h1, h1.header-scroll, .ac h2, .ac h3 { font-weight: 600; color: #1F2129; font-family: poppins,avenir,avenir next,futura,helvetica,arial,sans-serif; }\n.ac h1, #content-head h1 { font-size: 32px !important; }\n.ac h2, h1.header-scroll { font-size: 26px !important; }\n.ac h3 { font-size: 22px !important; }\n.ac h5 { font-size: 16px !important; }\n.ac ul li { margin-left: 20px; margin-bottom: 10px; list-style-type: disc; }\n#header-nav-left a:hover { border-radius: 0px !important; box-shadow: none !important; background-color: transparent !important; }\n#header-top { background-attachment: fixed; }\n.getting-started ul { margin-top: 10px; }\n.getting-started li { font-weight: bold; }\n.getting-started ul li { font-weight: normal; }\n.ac .icon-announcements:before { content: \"\"; display: block; height: 31px; width: 31px; background-size: 31px 31px; }\n.ac .landing1 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/zvgparjvu_book@2x.png); }\n.ac .landing2 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/3pesfob91_globe@2x.png); }\n.ac .landing3 .icon-announcements:before { background-image: url(http://d226aj4ao1t61q.cloudfront.net/hq3wzwwu9_target@2x.png); } */\n\n.theme-solid header#hub-header #header-top #header-nav-left li, .theme-solid header#hub-header #header-top #header-nav-right li {\n padding-left: 10px;\n padding-right: 10px;\n}\n.theme-solid header#hub-header #header-top #header-nav-left li a, .theme-solid header#hub-header #header-top #header-nav-right li a {\n color: rgba(255,255,255,1) !important;\n padding: 0px !important;\n font-family: ibm plex sans,franklin gothic,itc franklin gothic,helvetica,arial,sans-serif;\n font-size: 14px !important;\n}\n.theme-solid header#hub-header #header-top #header-nav-left li a:hover, .theme-solid header#hub-header #header-top #header-nav-right li a:hover {\nborder-bottom: 2px solid;\nborder-color: #FFFFFF;\n padding-bottom: 7px !important;\n}\n\n\n#header-bottom-nav .hub-subheader-breadcrumbs { display: none !important; }\n#hub-subheader { background-color: #2a4c79 !important; }\n#hub-search input { background-color: #2a4c79 !important; color: rgba(255,255,255,.78) !important; }\n#hub-search input::placeholder { color: rgba(255,255,255,.78) !important; }\n#hub-search .fa.fa-search { color: rgba(255,255,255,.78) !important; }\n#content-head h1 { text-align: left; }\n\n/* .rm-Header * { border: none !important; } */\n.rm-Header * { --Header-border-width: 0px !important; }\n\n/* Everything below this line is Doppler CSS */\n@import url('//fonts.googleapis.com/css?family=Ubuntu:300,400,500,700');\n\n@media (max-width:600px) {\n body .content-body .selector,\n body .content-body .selector.long,\n body .content-body .selector.long.half,\n body .content-body .selector.long:not(.half)\n {\n float: none !important;\n clear: both !important;\n width: 100% !important;\n }\n}\n\nbody {\n\tfont-family: 'Ubuntu', 'Helvetica Neue', Helvetica, Arial, sans-serif;\n font-size: 15px;\n}\n\n#content-head .excerpt {\n padding-top: 1rem;\n}\n\n/* Hide Discuss link while we're evaluating it */\n.Dropdown a[href=\"/discuss\"] {\n display: none;\n}\n\n.grecaptcha-badge {\n\tdisplay: none !important;\n}\n\n.video-embed {\n position: relative;\n padding: 0 0 56.25% 0;\n max-width: 100%;\n height: auto;\n margin: 0;\n background: black;\n border: 1px solid #5875EB;\n border-radius: 4px;\n overflow: hidden;\n -webkit-box-shadow: 0 5px 12px rgba(62,62,62,0.2);\n -moz-box-shadown: 0 5px 12px rgba(62,62,62,0.2);\n box-shadow: 0 5px 12px rgba(62,62,62,0.2);\n}\n\n.video-embed iframe {\n position: absolute;\n top: 0px;\n left: 0;\n height: 100%;\n width: 100%;\n display: block;\n border: none;\n outline: none;\n}\n\n* {\n outline: none;\n -webkit-font-smoothing: subpixel-antialiased;\n -webkit-padding-start: 0px;\n}\n\n.content-body .selector {\n position: relative;\n top: 0;\n\tpadding: 25px 20px 35px 20px;\n border: solid 1px rgba(0,0,0,0.1);\n display: block;\n float: left;\n text-decoration: none;\n width: calc((100%/3) - 20px);\n -webkit-border-radius: 7px;\n -moz-border-radius: 7px;\n border-radius: 7px;\n text-align: center;\n color: black;\n text-decoration: none !important;\n margin-right: 20px;\n margin-bottom: 20px;\n -webkit-transition: all .2s ease .01s;\n -moz-transition: all .2s ease .01s;\n -o-transition: all .2s ease .01s;\n transition: all .2s ease .01s;\n -webkit-box-shadow: 0 4px 10px rgba(62,62,62,.03);\n -moz-box-shadown: 0 4px 10px rgba(62,62,62,.03);\n box-shadow: 0 4px 10px rgba(62,62,62,.03);\n}\n\n.content-body .selector.col-2 {\n width: calc((100%/2) - 20px);\n}\n\n\n.content-body .selector:hover {\n\tborder-color: #4968F1;\n top: -2px;\n border-color: #8297f9;\n -webkit-box-shadow: 0 5px 8px rgba(81,111,247,.2);\n -moz-box-shadown: 0 5px 8px rgba(81,111,247,.2);\n box-shadow: 0 5px 8px rgba(81,111,247,.2);\n}\n\n.content-body .selector.long {\n\tpadding-bottom: 20px;\n}\n\n.content-body .selector.long:not(.half) {\n\twidth: calc(100% - 30px);\n}\n\n.content-body .selector.long.half {\n\twidth: calc(50% - 30px);\n}\n\n.content-body .selector.long .icon {\n\tfloat: left;\n height: 50px;\n}\n\n.content-body .selector.long .selector-info {\n\tfloat: right;\n width: calc(100% - 70px);\n text-align: left;\n}\n\n.content-body .selector .icon {\n font-size: 40px;\n height: 40px;\n margin-bottom: 20px;\n}\n\n.content-body .selector .title {\n font-size: 18px;\n font-weight: 500;\n}\n\n.content-body .selector .description {\n font-size: 15px;\n line-height: 20px;\n margin: 8px 0 10px 0;\n color: rgba(0,0,0,0.5);\n}\n\n.content-body .selector .description strong {\n\tdisplay: block;\n margin-top: 5px;\n}\n\n.content-body .selector .est {\n font-size: 15px;\n line-height: 18px;\n color: #4968F1;\n font-style: italic;\n}\n\n.content-body .clear {\n float: none;\n clear: both;\n}\n\n.CodeTabs-toolbar button:only-child {\n\tdisplay: none;\n}\n\n.Header-searchtb6Foi0-D9Vx {\nposition: relative !important;\nmargin-left: auto !important;\nmargin-bottom: 5px;\n}","js":"const tabs = document.querySelectorAll('.featureTab')\nconst panels = document.querySelectorAll('.panel')\n// const menu = document.getElementById('hamMenu')\n// const btn = document.getElementById('hamMenu-btn')\n\nawait new Promise(r => setTimeout(r, 2000));\n\n\n$( \".featureTab\" ).on(\"click\", (function() {\n alert( \"Handler for .click() called.\" );\n}));\n\n$(window).on('pageLoad', function(e, state) {\n $(\".toc-list\").toggle(![\"/docs\", \"/docs/start\"].includes(window.location.pathname));\n // Tabs menu event listener\n //tabs.forEach((tab) => {\n // tab.addEventListener('click', onTabClick);\n // console.log(\"Tab loaded: \", tab)\n //})\n $( \".featureTab\" ).on(\"click\", (function() {\n alert( \"Handler for .click() called.\" );\n }));\n console.log(\"PAGE LOADED\");\n\n // Hamburger btn listener\n // btn.addEventListener('click', navToggle)\n});\n\n\n// function navToggle() {\n// console.log(\"MENU TOGGLE CLICK\")\n// btn.classList.toggle('open')\n// menu.classList.toggle('flex')\n// menu.classList.toggle('hidden')\n// }\n\nfunction onTabClick(e) {\n \tconsole.log(\"TAB CLICK!\")\n // Deactivate all tabs\n tabs.forEach((tab) => {\n tab.children[0].classList.remove(\n 'border-darkCoral1',\n 'border-b-4',\n 'md:border-b-0',\n )\n })\n\n // Hide all panels\n panels.forEach((panel) => panel.classList.add('hidden'))\n\n // Activate a new tab and panel, based on target\n e.target.classList.add(\n 'border-darkCoral1',\n 'border-b-4'\n )\n\n const classString = e.target.getAttribute('data-target')\n document.getElementById('panels')\n .getElementsByClassName(classString)[0]\n .classList.remove('hidden')\n\n}","html":{"header":"<link href=\"https://fonts.googleapis.com/css2?family=IBM+Plex+Sans:wght@400;500;600;700&family=Poppins:wght@700&display=swap\" rel=\"stylesheet\">\n<script src=\"https://cdn.tailwindcss.com\"></script>\n\n<script>\n tailwind.config = {\n content: [\n ],\n theme: {\n screens: {\n sm: '480px',\n md: '768px',\n lg: '1020px',\n xl: '1440px'\n },\n extend: {\n colors: {\n dusk: 'hsl(194, 100%, 13%)',\n darkDusk: 'hsla(195, 100%, 9%, 1)',\n acBlue: 'hsl(222, 100%, 50%)',\n mint: 'hsl(165, 95%, 70%)',\n coral: 'hsl(14, 100%, 79%)',\n acBlue200: 'hsl(206, 100%, 96%)',\n acBlueDark1: 'hsl(238, 100%, 33%)',\n acBlueDark2: 'hsl(230, 100%, 41%)',\n acBlueLight1: 'hsl(222, 100%, 66%)',\n acBlueLight2: 'hsl(222, 100%, 80%)',\n acBlueLight3: 'hsl(222, 100%, 90%)',\n acBlueLight4: ' hsl(223, 100%, 96%)',\n darkMint: ' hsl(166, 78%, 45%)',\n grayishBlue: 'hsl(201, 11%, 66%)',\n darkCoral1: 'hsl(11, 100%, 60%)',\n lightDusk3: 'hsl(194, 25%, 66%)',\n lightDusk4: 'hsl(194, 26%, 80%)',\n lightDusk5: 'hsl(192, 31%, 94%)',\n },\n fontFamily: {\n poppins: ['Poppins', 'sans-serif'],\n ibm: ['IBM Plex Sans', 'sans-serif']\n },\n },\n }\n }\n</script>\n\n<style>\n #ssr-main .rm-LandingPage {\n width: 100%;\n --LandingPage-gap: var(--gap, 0em);\n }\n .markdown-body .font-poppins {\n font-family: Poppins, sans-serif;\n }\n #ssr-main .markdown-body h1 {\n color: #000;\n }\n .markdown-body .lg\\:text-6xl {\n font-size: 3.75rem;\n }\n</style>\n\n\n<!-- Google Tag Manager -->\n<script>(function(w,d,s,l,i){w[l]=w[l]||[];w[l].push({'gtm.start':\nnew Date().getTime(),event:'gtm.js'});var f=d.getElementsByTagName(s)[0],\nj=d.createElement(s),dl=l!='dataLayer'?'&l='+l:'';j.async=true;j.src=\n'https://www.googletagmanager.com/gtm.js?id='+i+dl;f.parentNode.insertBefore(j,f);\n})(window,document,'script','dataLayer','GTM-NQ88L9R');</script>\n<!-- End Google Tag Manager -->","home_footer":"<!-- Google Tag Manager (noscript) -->\n<noscript><iframe src=\"https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R\"\nheight=\"0\" width=\"0\" style=\"display:none;visibility:hidden\"></iframe></noscript>\n<!-- End Google Tag Manager (noscript) -->\n<script src=\"https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js\" async></script>","page_footer":"<!-- Google Tag Manager (noscript) -->\n<noscript><iframe src=\"https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R\"\nheight=\"0\" width=\"0\" style=\"display:none;visibility:hidden\"></iframe></noscript>\n<!-- End Google Tag Manager (noscript) -->\n\n<!-- Adobe Cloud Elements-->\n<script src=\"https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js\" async></script>\n<!-- End Adobe Cloud Elements-->\n\n<!-- ActiveCampaign Analytics-->\n<script>\n (function(e,t,o,n,p,r,i){e.visitorGlobalObjectAlias=n;e[e.visitorGlobalObjectAlias]=e[e.visitorGlobalObjectAlias]||function(){(e[e.visitorGlobalObjectAlias].q=e[e.visitorGlobalObjectAlias].q||[]).push(arguments)};e[e.visitorGlobalObjectAlias].l=(new Date).getTime();r=t.createElement(\"script\");r.src=o;r.async=true;i=t.getElementsByTagName(\"script\")[0];i.parentNode.insertBefore(r,i)})(window,document,\"https://diffuser-cdn.app-us1.com/diffuser/diffuser.js\",\"vgo\");\n vgo('setAccount', '223079033');\n vgo('setTrackByDefault', true);\n vgo('process');\n</script>\n<!-- END ActiveCampaign Analytics -->"}},"header":{"type":"gradient","gradient_color":null,"overlay":{"fill":"auto","type":"circuits","position":"top-left","image":{"uri":null,"url":"https://files.readme.io/8fdd9b9-010.jpg","name":"010.jpg","width":2048,"height":1379,"color":"#917569","links":{"original_url":null}}}},"navigation":{"first_page":"landing_page","left":[{"type":"home","title":null,"url":null,"custom_page":null},{"type":"custom_page","title":"Sandbox Accounts","url":null,"custom_page":"developer-sandbox-accounts"},{"type":"reference","title":null,"url":null,"custom_page":null},{"type":"link_url","title":"App Studio","url":"/docs","custom_page":null},{"type":"custom_page","title":"Webhooks","url":"google.com","custom_page":"webhooks"},{"type":"link_url","title":"Community","url":"https://community.activecampaign.com/c/developers/16","custom_page":null}],"logo_link":"homepage","right":[],"sub_nav":[],"subheader_layout":"dropdown","version":"disabled","links":{"home":{"label":"Home","visibility":"enabled"},"graphql":{"label":"GraphQL","visibility":"disabled"},"guides":{"label":"Guides","alias":null,"visibility":"enabled"},"reference":{"label":"API Reference","alias":"API Documentation","visibility":"enabled"},"recipes":{"label":"Recipes","alias":null,"visibility":"enabled"},"changelog":{"label":"Changelog","alias":"Latest Updates","visibility":"enabled"},"discussions":{"label":"Discussions","alias":"Community","visibility":"disabled"}}}}}},"version":{"_id":"57b6f40e480bae1900ce4e24","categories":["57b6f40e480bae1900ce4e25","57b6f456aabccd0e00f24909","581a406b1a63870f008b622f","5849b5aefcabe31900998f5b","5849beaf0e1b5e0f00854080","5849d43a3bcfb30f00dde73b","584b206696f59f0f006157b3","5898e1b8ec49fb0f004c25fa","58ac99cca7906a2f0076ab67","58b05f83f634c737009156fd","58b49200d373740f008f6037","58b5ee57e31a610f003a59b5","58bd8ada8bea2c0f00ea6b3a","58bdca9a5cbad00f00124aff","58c02f80b094740f005116e3","58d2d420ad20be0f00ccbacc","58ebd613cbc3f70f009b9fa0","5b969043eea09300037d6e13","5b96a8e64ab6050003d69afa","5b96af094ab6050003d69d34","5b96c453ff009a0003fd13cd","5b99eca243d76f000384cb35","5b9a92a8c7ccfc0003acd89c","5b9aa0c0ea73db0003e33345","5b9aa5f3ea73db0003e33438","5b9ac09f30f1ec000393414a","5b9ac81c3acc1d0003c40009","5b9acb6e3acc1d0003c40121","5b9af9bccd7ed6000349448f","5b9afbb7be532f00037e75d5","5b9afefacf6a7e000348cf36","5b9b019bcf6a7e000348cf47","5b9b0242cf6a7e000348cf4b","5ba11a83b882f80003ccc409","5ba121db0ae76c0003a81231","5ba8f0de4c8c220003a08e40","5ba8fcdf12256800034de280","5babcb62e00bd400038d86b9","5bad3f41f56aff0003cff86f","5bad3f4f25ecd000036a151f","5bafdba5e6b5a300037f0147","5bb57211a1c16c00038041e1","5bee4153e47f490026b87250","5bee81df54e56600185c31fd","5bef7a2dc032320012296403","5bef7ef71d361e0135e2cfb2","5cdc67c4e8507c00140b8c2e","5cdc690b0c875a00398c2f28","5d8b7ac425e74f031c7f1e5c","5db83db17af01c006ffd5afb","5dc0318ac91e080029778cb7","6040812e86f98900181314a1","6048f06d3b522500189b088f","606df980ba13ce004065499d","606df9c9f2d25500318e5720","606dff0a770ebe0047fe6868","6075e4661fc6a80010e74e4b","609d734d2db60f0028e7de3e","609d8058fca70d0040bb3111","60d0a822312198006373ede4","62335be3f4c0ca005a6b27ab","6283c8636cbbce009dc7e5f8","629a2817d3188a02dd769061","629a286e5b28390048c4c8ee","6376b408081e400003bab893","63f53fee77575500513a73e4","64065189fda1c20046cebc77","64cab60c5659c2000a4e8e02","6564c6f3d898bd0050f74cca"],"releaseDate":"2016-08-19T11:57:02.414Z","version":"3","version_clean":"3.0.0","__v":51,"createdAt":"2016-08-19T11:57:02.414Z","is_beta":false,"is_deprecated":false,"is_hidden":false,"is_stable":true,"project":"57b6f40e480bae1900ce4e21","codename":"","updatedAt":"2023-11-27T16:42:27.379Z"}},"reqUrl":"//","version":{"_id":"57b6f40e480bae1900ce4e24","categories":["57b6f40e480bae1900ce4e25","57b6f456aabccd0e00f24909","581a406b1a63870f008b622f","5849b5aefcabe31900998f5b","5849beaf0e1b5e0f00854080","5849d43a3bcfb30f00dde73b","584b206696f59f0f006157b3","5898e1b8ec49fb0f004c25fa","58ac99cca7906a2f0076ab67","58b05f83f634c737009156fd","58b49200d373740f008f6037","58b5ee57e31a610f003a59b5","58bd8ada8bea2c0f00ea6b3a","58bdca9a5cbad00f00124aff","58c02f80b094740f005116e3","58d2d420ad20be0f00ccbacc","58ebd613cbc3f70f009b9fa0","5b969043eea09300037d6e13","5b96a8e64ab6050003d69afa","5b96af094ab6050003d69d34","5b96c453ff009a0003fd13cd","5b99eca243d76f000384cb35","5b9a92a8c7ccfc0003acd89c","5b9aa0c0ea73db0003e33345","5b9aa5f3ea73db0003e33438","5b9ac09f30f1ec000393414a","5b9ac81c3acc1d0003c40009","5b9acb6e3acc1d0003c40121","5b9af9bccd7ed6000349448f","5b9afbb7be532f00037e75d5","5b9afefacf6a7e000348cf36","5b9b019bcf6a7e000348cf47","5b9b0242cf6a7e000348cf4b","5ba11a83b882f80003ccc409","5ba121db0ae76c0003a81231","5ba8f0de4c8c220003a08e40","5ba8fcdf12256800034de280","5babcb62e00bd400038d86b9","5bad3f41f56aff0003cff86f","5bad3f4f25ecd000036a151f","5bafdba5e6b5a300037f0147","5bb57211a1c16c00038041e1","5bee4153e47f490026b87250","5bee81df54e56600185c31fd","5bef7a2dc032320012296403","5bef7ef71d361e0135e2cfb2","5cdc67c4e8507c00140b8c2e","5cdc690b0c875a00398c2f28","5d8b7ac425e74f031c7f1e5c","5db83db17af01c006ffd5afb","5dc0318ac91e080029778cb7","6040812e86f98900181314a1","6048f06d3b522500189b088f","606df980ba13ce004065499d","606df9c9f2d25500318e5720","606dff0a770ebe0047fe6868","6075e4661fc6a80010e74e4b","609d734d2db60f0028e7de3e","609d8058fca70d0040bb3111","60d0a822312198006373ede4","62335be3f4c0ca005a6b27ab","6283c8636cbbce009dc7e5f8","629a2817d3188a02dd769061","629a286e5b28390048c4c8ee","6376b408081e400003bab893","63f53fee77575500513a73e4","64065189fda1c20046cebc77","64cab60c5659c2000a4e8e02","6564c6f3d898bd0050f74cca"],"releaseDate":"2016-08-19T11:57:02.414Z","version":"3","version_clean":"3.0.0","__v":51,"createdAt":"2016-08-19T11:57:02.414Z","is_beta":false,"is_deprecated":false,"is_hidden":false,"is_stable":true,"project":"57b6f40e480bae1900ce4e21","codename":"","updatedAt":"2023-11-27T16:42:27.379Z"},"lang":"en","langFull":"Default","is404":true,"isDetachedProductionSite":false}"></script></div><div id="hub-container"><div class="hub-container"><div state-container ng-attr-id="{{state.current().root !== 'docs' && 'react-app-content-container'}}"><div id="replace-view" ng-non-bindable></div></div></div></div><script>var is_hub = true; var is_hub2 = true; var is_hub_edit = true; </script><div id="ssr-end"><script id="__LOADABLE_REQUIRED_CHUNKS__" type="application/json">[6859,1802,9772,3284,7449,7372,9082,572,5312,5548,2395,6522,7112,4608,8263,1282,2852,3880,7783,1456,4935,7971,6722,153,1313,5798,1666,6841,1080,9852,8684,1936,4002,3787,9575,8063,6922,2859,1202,2144,9141,1343,6060,2637,4674,1731,3221,7327,7285,3307,1948,5408,2402,4793,2616,3412,4467,3859,678,8899,2578]</script><script id="__LOADABLE_REQUIRED_CHUNKS___ext" type="application/json">{"namedChunks":["routes-SuperHub","Header","core-icons-chevron-up-down-svg","routes-Reference","Footer","routes-PageNotFound","Editor","core-icons-x-circle-svg","core-icons-suggested-edits-svg","routes-Doc","routes-Landing","core-icons-arrow-right-svg","core-icons-arrow-up-right-svg","CustomPage","core-icons-alert-circle-svg","routes-Changelog","Post","core-icons-more-vertical-svg","core-icons-lock-svg","List","core-icons-search-svg","core-icons-custom-pages-svg","routes-SuperHub-Routes","rmdx","routes-Discuss","Page","core-icons-star-svg","core-icons-trending-up-svg","core-icons-callout-info-svg","routes-Tutorials","core-icons-chevron-down-svg","core-icons-webhook-svg","core-graphics-json-svg","routes-CustomPage","New","core-icons-eye-off-svg"]}</script> <script async data-chunk="main" src="https://cdn.readme.io/public/hub/web/main.766cf20fa350c2c18107.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6859.fc1496da022e612abe33.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1802.00a1e88cc0d9da2aae1b.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9772.1912e092b9c8785ff5c3.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/3284.6ecd6ef27e2009d3fdc7.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7449.dae0332305a8704415a6.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7372.aa4569536a36087cf4a9.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/9082.f9fa9ec2b80af1ef61bd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/572.bab1eda8453360a8a761.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5312.ca2c08ec1b75bb03c21e.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/5548.8fb1bb5d57de6c263c67.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/2395.6288c030d5183baa5a89.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/6522.057d8ea587133ae98687.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/7112.69c3d611e7e54e411b26.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/4608.3b5a227647e78e858c3f.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/8263.a563779273b90f66c0db.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/1282.591f476c316bf3670bbd.js"></script> <script async data-chunk="routes-SuperHub" src="https://cdn.readme.io/public/hub/web/routes-SuperHub.a3bb3020bf29f8f67ef8.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/3880.3892311d81c548cb073c.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/7783.48ca7ef3a5c469d97e53.js"></script> <script async data-chunk="Header" src="https://cdn.readme.io/public/hub/web/Header.ad57d9fcd570c04fb712.js"></script> <script async data-chunk="core-icons-chevron-up-down-svg" src="https://cdn.readme.io/public/hub/web/core-icons-chevron-up-down-svg.6aae957df71e6f4c5e24.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/7971.db270c2970b791e38435.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/6722.e485c5aa155bd0f0ccf8.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/153.e4db5a313c7d51383015.js"></script> <script async data-chunk="routes-Reference" src="https://cdn.readme.io/public/hub/web/routes-Reference.d66a49f09580aafdabb6.js"></script> <script async data-chunk="Footer" src="https://cdn.readme.io/public/hub/web/Footer.eb98b86c4279989f5a59.js"></script> <script async data-chunk="routes-PageNotFound" src="https://cdn.readme.io/public/hub/web/routes-PageNotFound.84a460336ee9c83a7d55.js"></script> <script async data-chunk="Editor" src="https://cdn.readme.io/public/hub/web/6841.587d285d41ca8bab11b1.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="routes-Doc" src="https://cdn.readme.io/public/hub/web/routes-Doc.e3a4e0817a9a640436bc.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/4002.08d1caef58d08eaccd19.js"></script> <script async data-chunk="routes-Landing" src="https://cdn.readme.io/public/hub/web/routes-Landing.f0816876bdfbbc06801a.js"></script> <script async data-chunk="core-icons-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="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-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="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="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-search-svg" src="https://cdn.readme.io/public/hub/web/core-icons-search-svg.ad9cac962958d30983a7.js"></script> <script async data-chunk="core-icons-custom-pages-svg" src="https://cdn.readme.io/public/hub/web/core-icons-custom-pages-svg.444e514638d9afbec182.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/7285.703d773b1bb63ae6e7ee.js"></script> <script async data-chunk="routes-SuperHub-Routes" src="https://cdn.readme.io/public/hub/web/routes-SuperHub-Routes.5ccfbee71da134a1eeba.js"></script> <script async data-chunk="rmdx" src="https://cdn.readme.io/public/hub/web/rmdx.594ae0fac8012b876a80.js"></script> <script async data-chunk="routes-Discuss" src="https://cdn.readme.io/public/hub/web/routes-Discuss.6a5b69949f194448cf4f.js"></script> <script async data-chunk="Page" src="https://cdn.readme.io/public/hub/web/Page.65c6f721688901333944.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="routes-Tutorials" src="https://cdn.readme.io/public/hub/web/routes-Tutorials.8adf2bf8562dfeff14b4.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-webhook-svg" src="https://cdn.readme.io/public/hub/web/core-icons-webhook-svg.fe540ea1c09e1c0e0247.js"></script> <script async data-chunk="New" src="https://cdn.readme.io/public/hub/web/New.908bc26e77bebc585452.js"></script> <script async data-chunk="core-icons-eye-off-svg" src="https://cdn.readme.io/public/hub/web/core-icons-eye-off-svg.b2b8b241b4b324dfd9c1.js"></script></div><script id="customJS">const tabs = document.querySelectorAll('.featureTab') const panels = document.querySelectorAll('.panel') // const menu = document.getElementById('hamMenu') // const btn = document.getElementById('hamMenu-btn') await new Promise(r => setTimeout(r, 2000)); $( ".featureTab" ).on("click", (function() { alert( "Handler for .click() called." ); })); $(window).on('pageLoad', function(e, state) { $(".toc-list").toggle(!["/docs", "/docs/start"].includes(window.location.pathname)); // Tabs menu event listener //tabs.forEach((tab) => { // tab.addEventListener('click', onTabClick); // console.log("Tab loaded: ", tab) //}) $( ".featureTab" ).on("click", (function() { alert( "Handler for .click() called." ); })); console.log("PAGE LOADED"); // Hamburger btn listener // btn.addEventListener('click', navToggle) }); // function navToggle() { // console.log("MENU TOGGLE CLICK") // btn.classList.toggle('open') // menu.classList.toggle('flex') // menu.classList.toggle('hidden') // } function onTabClick(e) { console.log("TAB CLICK!") // Deactivate all tabs tabs.forEach((tab) => { tab.children[0].classList.remove( 'border-darkCoral1', 'border-b-4', 'md:border-b-0', ) }) // Hide all panels panels.forEach((panel) => panel.classList.add('hidden')) // Activate a new tab and panel, based on target e.target.classList.add( 'border-darkCoral1', 'border-b-4' ) const classString = e.target.getAttribute('data-target') document.getElementById('panels') .getElementsByClassName(classString)[0] .classList.remove('hidden') } </script><!-- Google Tag Manager (noscript) --> <noscript><iframe src="https://www.googletagmanager.com/ns.html?id=GTM-NQ88L9R" height="0" width="0" style="display:none;visibility:hidden"></iframe></noscript> <!-- End Google Tag Manager (noscript) --> <!-- Adobe Cloud Elements--> <script src="https://assets.adobedtm.com/fccae223403d/b9ca3c9bef1d/launch-dab30381be28.min.js" async></script> <!-- End Adobe Cloud Elements--> <!-- ActiveCampaign Analytics--> <script> (function(e,t,o,n,p,r,i){e.visitorGlobalObjectAlias=n;e[e.visitorGlobalObjectAlias]=e[e.visitorGlobalObjectAlias]||function(){(e[e.visitorGlobalObjectAlias].q=e[e.visitorGlobalObjectAlias].q||[]).push(arguments)};e[e.visitorGlobalObjectAlias].l=(new Date).getTime();r=t.createElement("script");r.src=o;r.async=true;i=t.getElementsByTagName("script")[0];i.parentNode.insertBefore(r,i)})(window,document,"https://diffuser-cdn.app-us1.com/diffuser/diffuser.js","vgo"); vgo('setAccount', '223079033'); vgo('setTrackByDefault', true); vgo('process'); </script> <!-- END ActiveCampaign Analytics --><script id="hub-me" type="application/json" data-json="{"loggedIn":false,"search":{"app":"T28YKFATPY","token":"NmU0ZjJhOTMxMjE1MGYyODE2NTQ3YTMyNWQ5ODQ5ZjAyYzZkODBmZjljZDI5NTAyODhiZjU2ZmNlYjA0ZmNlZHRhZ0ZpbHRlcnM9KHByb2plY3Q6NTdiNmY0MGU0ODBiYWUxOTAwY2U0ZTIxKSwodmVyc2lvbjpub25lLHZlcnNpb246NTdiNmY0MGU0ODBiYWUxOTAwY2U0ZTI0KSwoaGlkZGVuOm5vbmUsaGlkZGVuOmZhbHNlKSwoaW5kZXg6Q3VzdG9tUGFnZSxpbmRleDpQYWdlLGluZGV4OkJsb2csaW5kZXg6VHV0b3JpYWwp","filters":"tagFilters=(project:57b6f40e480bae1900ce4e21),(version:none,version:57b6f40e480bae1900ce4e24),(hidden:none,hidden:false),(index:CustomPage,index:Page,index:Blog,index:Tutorial)","metaData":[{"modules":{"landing":true,"suggested_edits":true,"discuss":false,"reference":true,"examples":true,"docs":true,"changelog":true,"logs":false,"custompages":true,"tutorials":true,"graphql":false},"id":"57b6f40e480bae1900ce4e21","name":"ActiveCampaign","subdomain":"activecampaign","subpath":"","nav_names":{"discuss":"Community","reference":"API Documentation","docs":"","changelog":"Latest Updates","tutorials":"","recipes":""}}]}}"></script><script id="readme-data-baseUrl" type="application/json"></script></body></html>