[{"data":1,"prerenderedAt":408},["ShallowReactive",2],{"navigation":3,"\u002Fdocs\u002Fgetting-started":22,"\u002Fdocs\u002Fgetting-started-surround":404},[4,8,12],{"title":5,"path":6,"stem":7},"Getting started","\u002Fdocs\u002Fgetting-started","1.docs\u002F1.getting-started",{"title":9,"path":10,"stem":11},"Authentication","\u002Fdocs\u002Fauthentication","1.docs\u002F2.authentication",{"title":13,"path":14,"stem":15,"children":16,"page":21},"API Reference","\u002Fdocs\u002Fapi","1.docs\u002F3.api",[17],{"title":18,"path":19,"stem":20},"Consent","\u002Fdocs\u002Fapi\u002Fconsent","1.docs\u002F3.api\u002F1.consent",false,{"id":23,"title":5,"body":24,"description":398,"extension":399,"meta":400,"navigation":126,"path":6,"seo":402,"stem":7,"__hash__":403},"docs\u002F1.docs\u002F1.getting-started.md",{"type":25,"value":26,"toc":392},"minimark",[27,31,36,39,50,61,65,72,194,198,201,275,278,361,365,388],[28,29,30],"p",{},"Use the dealerMe API to keep shopper consent in sync between dealerMe and your own systems: whether each contact has agreed to be reached by email, text or phone call.",[32,33,35],"h2",{"id":34},"base-url","Base URL",[28,37,38],{},"All endpoints live under version 1 of the API:",[40,41,46],"pre",{"className":42,"code":44,"language":45},[43],"language-text","https:\u002F\u002Fapi.dealerme.com\u002Fv1\n","text",[47,48,44],"code",{"__ignoreMap":49},"",[28,51,52,53,56,57,60],{},"Send and receive JSON. Include ",[47,54,55],{},"Accept: application\u002Fjson"," on every request, and ",[47,58,59],{},"Content-Type: application\u002Fjson"," when you send a body.",[32,62,64],{"id":63},"making-a-request","Making a request",[28,66,67,68,71],{},"Every request needs an API token, plus a header that tells dealerMe which organization the request is for. See ",[69,70,9],"a",{"href":10}," for how to create a token and which header each endpoint expects.",[73,74,75],"code-group",{},[40,76,81],{"className":77,"code":78,"filename":79,"language":80,"meta":49,"style":49},"language-bash shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","DEALERME_TOKEN=\"your API token\"\nDEALERME_ORG_ID=\"your organization id\"\n\ncurl \"https:\u002F\u002Fapi.dealerme.com\u002Fv1\u002Fconsent-management\u002Femail\u002Fconsent?contact_value=jane@example.com\" \\\n  -H \"Authorization: Bearer $DEALERME_TOKEN\" \\\n  -H \"X-DealerMe-Organization-Id: $DEALERME_ORG_ID\" \\\n  -H 'Accept: application\u002Fjson'\n","CURL","bash",[47,82,83,106,121,128,146,164,181],{"__ignoreMap":49},[84,85,88,92,96,99,103],"span",{"class":86,"line":87},"line",1,[84,89,91],{"class":90},"sTEyZ","DEALERME_TOKEN",[84,93,95],{"class":94},"sMK4o","=",[84,97,98],{"class":94},"\"",[84,100,102],{"class":101},"sfazB","your API token",[84,104,105],{"class":94},"\"\n",[84,107,109,112,114,116,119],{"class":86,"line":108},2,[84,110,111],{"class":90},"DEALERME_ORG_ID",[84,113,95],{"class":94},[84,115,98],{"class":94},[84,117,118],{"class":101},"your organization id",[84,120,105],{"class":94},[84,122,124],{"class":86,"line":123},3,[84,125,127],{"emptyLinePlaceholder":126},true,"\n",[84,129,131,135,138,141,143],{"class":86,"line":130},4,[84,132,134],{"class":133},"sBMFI","curl",[84,136,137],{"class":94}," \"",[84,139,140],{"class":101},"https:\u002F\u002Fapi.dealerme.com\u002Fv1\u002Fconsent-management\u002Femail\u002Fconsent?contact_value=jane@example.com",[84,142,98],{"class":94},[84,144,145],{"class":90}," \\\n",[84,147,149,152,154,157,160,162],{"class":86,"line":148},5,[84,150,151],{"class":101},"  -H",[84,153,137],{"class":94},[84,155,156],{"class":101},"Authorization: Bearer ",[84,158,159],{"class":90},"$DEALERME_TOKEN",[84,161,98],{"class":94},[84,163,145],{"class":90},[84,165,167,169,171,174,177,179],{"class":86,"line":166},6,[84,168,151],{"class":101},[84,170,137],{"class":94},[84,172,173],{"class":101},"X-DealerMe-Organization-Id: ",[84,175,176],{"class":90},"$DEALERME_ORG_ID",[84,178,98],{"class":94},[84,180,145],{"class":90},[84,182,184,186,189,191],{"class":86,"line":183},7,[84,185,151],{"class":101},[84,187,188],{"class":94}," '",[84,190,55],{"class":101},[84,192,193],{"class":94},"'\n",[32,195,197],{"id":196},"errors","Errors",[28,199,200],{},"dealerMe uses standard HTTP status codes.",[202,203,204,217],"table",{},[205,206,207],"thead",{},[208,209,210,214],"tr",{},[211,212,213],"th",{},"Status",[211,215,216],{},"Meaning",[218,219,220,235,245,255,265],"tbody",{},[208,221,222,232],{},[223,224,225,228,229],"td",{},[47,226,227],{},"200",", ",[47,230,231],{},"201",[223,233,234],{},"The request succeeded.",[208,236,237,242],{},[223,238,239],{},[47,240,241],{},"401",[223,243,244],{},"The API token is missing or invalid.",[208,246,247,252],{},[223,248,249],{},[47,250,251],{},"403",[223,253,254],{},"The organization doesn't exist, or the token's user isn't a member of it.",[208,256,257,262],{},[223,258,259],{},[47,260,261],{},"422",[223,263,264],{},"The request body didn't pass validation. The response lists each problem by field.",[208,266,267,272],{},[223,268,269],{},[47,270,271],{},"429",[223,273,274],{},"Too many requests. Wait and try again.",[28,276,277],{},"A validation error looks like this:",[40,279,283],{"className":280,"code":281,"language":282,"meta":49,"style":49},"language-json shiki shiki-themes material-theme-lighter material-theme material-theme-palenight","{\n  \"message\": \"The email field is required.\",\n  \"errors\": {\n    \"email\": [\"The email field is required.\"]\n  }\n}\n","json",[47,284,285,290,314,327,351,356],{"__ignoreMap":49},[84,286,287],{"class":86,"line":87},[84,288,289],{"class":94},"{\n",[84,291,292,295,299,301,304,306,309,311],{"class":86,"line":108},[84,293,294],{"class":94},"  \"",[84,296,298],{"class":297},"spNyl","message",[84,300,98],{"class":94},[84,302,303],{"class":94},":",[84,305,137],{"class":94},[84,307,308],{"class":101},"The email field is required.",[84,310,98],{"class":94},[84,312,313],{"class":94},",\n",[84,315,316,318,320,322,324],{"class":86,"line":123},[84,317,294],{"class":94},[84,319,196],{"class":297},[84,321,98],{"class":94},[84,323,303],{"class":94},[84,325,326],{"class":94}," {\n",[84,328,329,332,335,337,339,342,344,346,348],{"class":86,"line":130},[84,330,331],{"class":94},"    \"",[84,333,334],{"class":133},"email",[84,336,98],{"class":94},[84,338,303],{"class":94},[84,340,341],{"class":94}," [",[84,343,98],{"class":94},[84,345,308],{"class":101},[84,347,98],{"class":94},[84,349,350],{"class":94},"]\n",[84,352,353],{"class":86,"line":148},[84,354,355],{"class":94},"  }\n",[84,357,358],{"class":86,"line":166},[84,359,360],{"class":94},"}\n",[32,362,364],{"id":363},"whats-in-the-api","What's in the API",[202,366,367,377],{},[205,368,369],{},[208,370,371,374],{},[211,372,373],{},"Area",[211,375,376],{},"What it's for",[218,378,379],{},[208,380,381,385],{},[223,382,383],{},[69,384,18],{"href":19},[223,386,387],{},"Whether a contact has agreed to be reached by email, text or phone call.",[389,390,391],"style",{},"html pre.shiki code .sTEyZ, html code.shiki .sTEyZ{--shiki-light:#90A4AE;--shiki-default:#EEFFFF;--shiki-dark:#BABED8}html pre.shiki code .sMK4o, html code.shiki .sMK4o{--shiki-light:#39ADB5;--shiki-default:#89DDFF;--shiki-dark:#89DDFF}html pre.shiki code .sfazB, html code.shiki .sfazB{--shiki-light:#91B859;--shiki-default:#C3E88D;--shiki-dark:#C3E88D}html pre.shiki code .sBMFI, html code.shiki .sBMFI{--shiki-light:#E2931D;--shiki-default:#FFCB6B;--shiki-dark:#FFCB6B}html .light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html.light .shiki span {color: var(--shiki-light);background: var(--shiki-light-bg);font-style: var(--shiki-light-font-style);font-weight: var(--shiki-light-font-weight);text-decoration: var(--shiki-light-text-decoration);}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .spNyl, html code.shiki .spNyl{--shiki-light:#9C3EDA;--shiki-default:#C792EA;--shiki-dark:#C792EA}",{"title":49,"searchDepth":108,"depth":108,"links":393},[394,395,396,397],{"id":34,"depth":108,"text":35},{"id":63,"depth":108,"text":64},{"id":196,"depth":108,"text":197},{"id":363,"depth":108,"text":364},"Keep shopper consent in sync between dealerMe and your own systems.","md",{"category":401,"position":87,"version":87},"Getting Started",{"title":5,"description":398},"ZD-ahf_w2Rp5VlxfEAKHKsuzjx6NwVcMcWlSRxcD_Pw",[405,406],null,{"title":9,"path":10,"stem":11,"description":407,"children":-1},"Authenticate with an API token and tell dealerMe which organization a request is for.",1793390153449]