(window.webpackJsonp=window.webpackJsonp||[]).push([[36],{354:function(t,s,a){"use strict";a.r(s);var e=a(28),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"custom-fields"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#custom-fields"}},[t._v("#")]),t._v(" Custom Fields")]),t._v(" "),s("div",{staticClass:"custom-block warning"},[s("p",{staticClass:"custom-block-title"},[t._v("NOTE")]),t._v(" "),s("p",[t._v("The URI for the API endpoint is often the same for multiple endpoints, the difference being in HTTP methods.")])]),t._v(" "),s("h2",{attrs:{id:"list-custom-fields"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#list-custom-fields"}},[t._v("#")]),t._v(" List Custom Fields")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("GET https://api.wolfeo.me/v1/custom-fields\n")])])]),s("p",[t._v("Returns all custom field definitions for your account.")]),t._v(" "),s("h3",{attrs:{id:"example-request"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-request"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),s("div",{staticClass:"language-curl extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('curl --request GET "https://api.wolfeo.me/v1/custom-fields" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\n')])])]),s("h3",{attrs:{id:"sample-return"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-return"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Company"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"text"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"values"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Plan"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"select"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"values"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Starter,Pro,Elite"')]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("div",{staticClass:"custom-block tip"},[s("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),s("p",[s("code",[t._v("values")]),t._v(" is only populated for "),s("code",[t._v("select")]),t._v(" type fields — it contains a comma-separated list of allowed options.")])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"set-contact-custom-field"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#set-contact-custom-field"}},[t._v("#")]),t._v(" Set Contact Custom Field")]),t._v(" "),s("div",{staticClass:"language- extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v("PUT https://api.wolfeo.me/v1/contact-custom-field\n")])])]),s("p",[t._v("Sets (or updates) a custom field value for a contact. Creates the value if it doesn't exist yet.")]),t._v(" "),s("h3",{attrs:{id:"example-request-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#example-request-2"}},[t._v("#")]),t._v(" Example Request")]),t._v(" "),s("div",{staticClass:"language-curl extra-class"},[s("pre",{pre:!0,attrs:{class:"language-text"}},[s("code",[t._v('curl --request PUT "https://api.wolfeo.me/v1/contact-custom-field" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{"contact_id": 1, "custom_field_id": 1, "value": "Wolfeo Ltd"}\'\n')])])]),s("h3",{attrs:{id:"parameters"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#parameters"}},[t._v("#")]),t._v(" Parameters")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Parameter")]),t._v(" "),s("th",[t._v("Type")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("email**")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("Contact's email address")])]),t._v(" "),s("tr",[s("td",[t._v("contact_id**")]),t._v(" "),s("td",[s("em",[t._v("integer")])]),t._v(" "),s("td",[t._v("Contact's ID")])]),t._v(" "),s("tr",[s("td",[t._v("custom_field_id*")]),t._v(" "),s("td",[s("em",[t._v("integer")])]),t._v(" "),s("td",[t._v("The custom field ID to set")])]),t._v(" "),s("tr",[s("td",[t._v("value*")]),t._v(" "),s("td",[s("em",[t._v("string")])]),t._v(" "),s("td",[t._v("The value to store (max 1000 characters)")])])])]),t._v(" "),s("p",[s("em",[t._v("** at least one of these parameters must be passed — * denotes required")])]),t._v(" "),s("h3",{attrs:{id:"sample-return-2"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-2"}},[t._v("#")]),t._v(" Sample Return")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"contact_id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"custom_field_id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Wolfeo Ltd"')]),t._v("\n    "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("h3",{attrs:{id:"possible-errors"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Code")]),t._v(" "),s("th",[t._v("HTTP")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[t._v("NOT_FOUND")]),t._v(" "),s("td",[t._v("404")]),t._v(" "),s("td",[t._v("Contact or custom field not found")])])])]),t._v(" "),s("hr"),t._v(" "),s("h2",{attrs:{id:"what-s-next"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#what-s-next"}},[t._v("#")]),t._v(" What's next")]),t._v(" "),s("ul",[s("li",[s("RouterLink",{attrs:{to:"/reference/contacts/"}},[t._v("Contacts")]),t._v(" — manage contacts, tags, and sequences")],1)])])}),[],!1,null,null,null);s.default=r.exports}}]);