(window.webpackJsonp=window.webpackJsonp||[]).push([[9],{477:function(t,e,a){"use strict";a.r(e);var s=a(63),r=Object(s.a)({},(function(){var t=this,e=t.$createElement,a=t._self._c||e;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"contacts"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#contacts"}},[t._v("#")]),t._v(" Contacts")]),t._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[t._v("NOTE")]),t._v(" "),a("p",[t._v("The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.")])]),t._v(" "),a("h2",{attrs:{id:"retrieve-contact"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-contact"}},[t._v("#")]),t._v(" Retrieve Contact")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("GET https://api.wolfeo.me/contact\n")])])]),a("h3",{attrs:{id:"example-request"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),a("div",{staticClass:"language-curl extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v('curl --request GET "https://api.wolfeo.me/contact?api_key=demokey&contact_id=1"\n')])])]),a("h3",{attrs:{id:"parameters"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Parameter")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("api_key*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Your secret Wolfeo API key, required for all API calls")])]),t._v(" "),a("tr",[a("td",[t._v("email**")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("A contact's email address")])]),t._v(" "),a("tr",[a("td",[t._v("contact_id**")]),t._v(" "),a("td",[a("em",[t._v("int")])]),t._v(" "),a("td",[t._v("A contact's ID")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")]),a("br"),t._v(" "),a("em",[t._v("** at least one of these parameters must be passed")])]),t._v(" "),a("h3",{attrs:{id:"sample-return"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@ted.com"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"first_name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"John"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"last_name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Doe"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"email_marketing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"GDPR"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"tags"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"59"')]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sequences"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"61"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"70"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"72"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"41"')]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-contact"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-contact"}},[t._v("#")]),t._v(" Create Contact")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("POST https://api.wolfeo.me/contact\n")])])]),a("h3",{attrs:{id:"example-request-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-2"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),a("div",{staticClass:"language-curl extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v('curl --request POST "https://api.wolfeo.me/contact?api_key=demokey&email=john@doe.ie"\n')])])]),a("h3",{attrs:{id:"parameters-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-2"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Parameter")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("api_key*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Your secret Wolfeo API key, required for all API calls")])]),t._v(" "),a("tr",[a("td",[t._v("first_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Contacts first name")])]),t._v(" "),a("tr",[a("td",[t._v("last_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Contacts last/second name")])]),t._v(" "),a("tr",[a("td",[t._v("email*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Contacts email address")])]),t._v(" "),a("tr",[a("td",[t._v("email_marketing")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Boolean value for email marketing")])]),t._v(" "),a("tr",[a("td",[t._v("gdpr")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Boolean value for GDPR permissions")])]),t._v(" "),a("tr",[a("td",[t._v("tag_ids")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("String list of tag IDs for the contact to be added to. For example, "),a("code",[t._v("123,53434,2503")])])]),t._v(" "),a("tr",[a("td",[t._v("sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("String list of sequence IDs for the contact to be added to. For example, "),a("code",[t._v("123,53434,2503")])])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-2"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"contact_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("79")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"update-contact"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-contact"}},[t._v("#")]),t._v(" Update Contact")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("PUT https://api.wolfeo.me/contact\n")])])]),a("h3",{attrs:{id:"example-request-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-3"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),a("div",{staticClass:"language-curl extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v('curl --request PUT "https://api.wolfeo.me/contact?api_key=demokey&contact_id=1&first_name=John"\n')])])]),a("p",[t._v("Any values passed will be updated.")]),t._v(" "),a("h3",{attrs:{id:"parameters-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-3"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Parameter")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("api_key*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Your secret Wolfeo API key, required for all API calls")])]),t._v(" "),a("tr",[a("td",[t._v("first_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Contacts first name")])]),t._v(" "),a("tr",[a("td",[t._v("last_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Contacts last/second name")])]),t._v(" "),a("tr",[a("td",[t._v("email**")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("A contact's email address")])]),t._v(" "),a("tr",[a("td",[t._v("contact_id**")]),t._v(" "),a("td",[a("em",[t._v("int")])]),t._v(" "),a("td",[t._v("A contact's ID")])]),t._v(" "),a("tr",[a("td",[t._v("email_marketing")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Boolean value for email marketing")])]),t._v(" "),a("tr",[a("td",[t._v("gdpr")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Boolean value for GDPR permissions")])]),t._v(" "),a("tr",[a("td",[t._v("tag_ids")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("String list of tag IDs for the contact to be added to. For example, "),a("code",[t._v("123,53434,2503")])])]),t._v(" "),a("tr",[a("td",[t._v("sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("String list of sequence IDs for the contact to be added to. For example, "),a("code",[t._v("123,53434,2503")])])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")]),a("br"),t._v(" "),a("em",[t._v("** at least one of these parameters must be passed")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-3"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"contact_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("79")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"retrieve-count-of-new-contacts-based-on-given-date-range"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-count-of-new-contacts-based-on-given-date-range"}},[t._v("#")]),t._v(" Retrieve count of new contacts based on given date range")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("GET https://api.wolfeo.me/contact-count\n")])])]),a("h3",{attrs:{id:"example-request-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-4"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),a("div",{staticClass:"language-curl extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v('curl --request GET "https://api.wolfeo.me/contact-count?api_key=demo_key&period=all"\n')])])]),a("h3",{attrs:{id:"parameters-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),a("p",[a("strong",[t._v("GET")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Parameter")]),t._v(" "),a("th",[t._v("Type")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("api_key*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Your secret Wolfeo API key, required for all API calls")])]),t._v(" "),a("tr",[a("td",[t._v("period*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Option for filtering contacts, required")])]),t._v(" "),a("tr",[a("td",[t._v("range")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Date range of contact created")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("h3",{attrs:{id:"possible-values-for-period"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-values-for-period"}},[t._v("#")]),t._v(' Possible values for "period"')]),t._v(" "),a("p",[a("code",[t._v("today")]),t._v(", "),a("code",[t._v("yesterday")]),t._v(", "),a("code",[t._v("last7days")]),t._v(", "),a("code",[t._v("last30days")]),t._v(", "),a("code",[t._v("between")])]),t._v(" "),a("h3",{attrs:{id:"example-value-for-range"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-value-for-range"}},[t._v("#")]),t._v(' Example value for "range"')]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("2023-06-01to2023-06-29\n")])])]),a("h3",{attrs:{id:"example-url"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-url"}},[t._v("#")]),t._v(" Example url")]),t._v(" "),a("p",[t._v("for all")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=all")])]),t._v(" "),a("p",[t._v("for today")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=today")])]),t._v(" "),a("p",[t._v("for yesterday")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=yesterday")])]),t._v(" "),a("p",[t._v("for last7days")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=last7days")])]),t._v(" "),a("p",[t._v("for last30days")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=last30days")])]),t._v(" "),a("p",[t._v("for between")]),t._v(" "),a("p",[a("code",[t._v("https://api.wolfeo.me/contact-count?api_key=demo_key&period=between&range=2023-06-01to2023-06-29")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-4"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("906")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);e.default=r.exports}}]);