(window.webpackJsonp=window.webpackJsonp||[]).push([[34],{352:function(t,a,s){"use strict";s.r(a);var e=s(28),r=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"campaigns"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#campaigns"}},[t._v("#")]),t._v(" Campaigns")]),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:"list-campaigns"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#list-campaigns"}},[t._v("#")]),t._v(" List Campaigns")]),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/v1/campaigns\n")])])]),a("p",[t._v("Returns a paginated list of broadcast campaigns, ordered by most recent first.")]),t._v(" "),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/v1/campaigns?status=sent&per_page=25" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\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("status")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Filter by status (see possible values below)")])]),t._v(" "),a("tr",[a("td",[t._v("period")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Time range to filter by (see possible values below)")])]),t._v(" "),a("tr",[a("td",[t._v("range")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Custom date range — only used when "),a("code",[t._v("period=between")])])]),t._v(" "),a("tr",[a("td",[t._v("page")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("Page number (default: "),a("code",[t._v("1")]),t._v(")")])]),t._v(" "),a("tr",[a("td",[t._v("per_page")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("Results per page — max "),a("code",[t._v("100")]),t._v(" (default: "),a("code",[t._v("50")]),t._v(")")])])])]),t._v(" "),a("h3",{attrs:{id:"possible-values-for-status"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-values-for-status"}},[t._v("#")]),t._v(" Possible values for "),a("code",[t._v("status")])]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Value")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[a("code",[t._v("draft")])]),t._v(" "),a("td",[t._v("Not yet sent")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("sending")])]),t._v(" "),a("td",[t._v("Currently being sent")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("sent")])]),t._v(" "),a("td",[t._v("Sent successfully")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("scheduled")])]),t._v(" "),a("td",[t._v("Scheduled for later")])]),t._v(" "),a("tr",[a("td",[a("code",[t._v("error")])]),t._v(" "),a("td",[t._v("Sending failed")])])])]),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('"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 punctuation"}},[t._v("{")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"June Newsletter"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subject"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"What\'s new this month 🎉"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from_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('"from_email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@example.com"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sent"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sent_to"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1200")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"recipients_count"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1200")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sent_at"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-06-01T10:00:00.000000Z"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scheduled_for"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n            "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"created_at"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-05-28T09:00:00.000000Z"')]),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("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n    "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"meta"')]),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('"current_page"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"last_page"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"per_page"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("142")]),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("h3",{attrs:{id:"possible-errors"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("INVALID_STATUS")]),t._v(" "),a("td",[t._v("400")]),t._v(" "),a("td",[t._v("Invalid "),a("code",[t._v("status")]),t._v(" value")])]),t._v(" "),a("tr",[a("td",[t._v("INVALID_PERIOD")]),t._v(" "),a("td",[t._v("400")]),t._v(" "),a("td",[t._v("Invalid "),a("code",[t._v("period")]),t._v(" or missing "),a("code",[t._v("range")])])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"retrieve-campaign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-campaign"}},[t._v("#")]),t._v(" Retrieve Campaign")]),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/v1/campaign\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 GET "https://api.wolfeo.me/v1/campaign?campaign_id=42" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("The campaign ID")])])])]),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('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"June Newsletter"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subject"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"What\'s new this month 🎉"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from_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('"from_email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@example.com"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sent"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sent_to"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1200")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"recipients_count"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1200")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sent_at"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-06-01T10:00:00.000000Z"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scheduled_for"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"created_at"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2024-05-28T09:00:00.000000Z"')]),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("h3",{attrs:{id:"possible-errors-2"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-2"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"retrieve-campaign-stats"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-campaign-stats"}},[t._v("#")]),t._v(" Retrieve Campaign Stats")]),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/v1/campaign-stats\n")])])]),a("p",[t._v("Returns send statistics for a campaign. Stats are read from Redis in real time.")]),t._v(" "),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 GET "https://api.wolfeo.me/v1/campaign-stats?campaign_id=42" \\\n  --header "Authorization: Bearer YOUR_API_KEY"\n')])])]),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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("The campaign ID")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),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('"sent_to"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1200")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"opens"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("480")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"clicks"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("192")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unsubscribes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"open_rate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("40.0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"click_rate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("16.0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unsubscribe_rate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.3")]),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("h3",{attrs:{id:"possible-errors-3"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-3"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"create-campaign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-campaign"}},[t._v("#")]),t._v(" Create Campaign")]),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/v1/campaign\n")])])]),a("p",[t._v("Creates a broadcast campaign as a draft. Use "),a("a",{attrs:{href:"#schedule-campaign"}},[t._v("Schedule Campaign")]),t._v(" to send or schedule it.")]),t._v(" "),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 POST "https://api.wolfeo.me/v1/campaign" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{\n    "name": "June Newsletter",\n    "subject": "What\'\\\'\'s new this month 🎉",\n    "from_name": "John",\n    "from_email": "john@example.com"\n  }\'\n')])])]),a("h3",{attrs:{id:"parameters-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-4"}},[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("name*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Internal name for the campaign")])]),t._v(" "),a("tr",[a("td",[t._v("subject")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Email subject line")])]),t._v(" "),a("tr",[a("td",[t._v("from_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Sender display name")])]),t._v(" "),a("tr",[a("td",[t._v("from_email")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Sender email address")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),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("p",[t._v("HTTP "),a("strong",[t._v("201 Created")])]),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('"campaign_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"June Newsletter"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subject"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"What\'s new this month 🎉"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from_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('"from_email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@example.com"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"draft"')]),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("hr"),t._v(" "),a("h2",{attrs:{id:"schedule-campaign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#schedule-campaign"}},[t._v("#")]),t._v(" Schedule Campaign")]),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/v1/campaign-schedule\n")])])]),a("p",[t._v("Schedules an existing draft campaign for sending. The campaign will be sent to all contacts matching the specified filters at the given date and time.")]),t._v(" "),a("h3",{attrs:{id:"example-request-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-5"}},[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/v1/campaign-schedule" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{\n    "campaign_id": 42,\n    "scheduled_for": "2025-06-15T14:00:00",\n    "incl_tag_ids": [12, 34],\n    "excl_tag_ids": [56]\n  }\'\n')])])]),a("h3",{attrs:{id:"parameters-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-5"}},[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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("ID of the draft campaign to schedule")])]),t._v(" "),a("tr",[a("td",[t._v("scheduled_for*")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Send date/time — ISO 8601 or "),a("code",[t._v("Y-m-d H:i")]),t._v(", must be in future")])]),t._v(" "),a("tr",[a("td",[t._v("send_to_all")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Send to all contacts, ignoring filters (default: "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("tr",[a("td",[t._v("incl_tag_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Only send to contacts with these tags")])]),t._v(" "),a("tr",[a("td",[t._v("excl_tag_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Exclude contacts with these tags")])]),t._v(" "),a("tr",[a("td",[t._v("incl_sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Only send to contacts in these sequences")])]),t._v(" "),a("tr",[a("td",[t._v("excl_sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Exclude contacts in these sequences")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("Timezone")]),t._v(" "),a("p",[a("code",[t._v("scheduled_for")]),t._v(" is interpreted in your account's configured timezone (set in Settings → Email). If no timezone is set, "),a("code",[t._v("Europe/Paris")]),t._v(" is used.")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-5"}},[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('"campaign_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"scheduled"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scheduled_for"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2025-06-15 14:00:00"')]),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("h3",{attrs:{id:"possible-errors-4"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-4"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found or already sent")])]),t._v(" "),a("tr",[a("td",[t._v("INVALID_DATE")]),t._v(" "),a("td",[t._v("400")]),t._v(" "),a("td",[a("code",[t._v("scheduled_for")]),t._v(" could not be parsed or is in the past")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"update-campaign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-campaign"}},[t._v("#")]),t._v(" Update Campaign")]),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/v1/campaign\n")])])]),a("p",[t._v("Updates a draft campaign. Only campaigns with a "),a("code",[t._v("draft")]),t._v(" status can be modified.")]),t._v(" "),a("h3",{attrs:{id:"example-request-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-6"}},[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/v1/campaign" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{\n    "campaign_id": 42,\n    "subject": "Updated subject line",\n    "from_name": "Jane"\n  }\'\n')])])]),a("h3",{attrs:{id:"parameters-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-6"}},[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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("The campaign ID to update")])]),t._v(" "),a("tr",[a("td",[t._v("name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Internal name for the campaign")])]),t._v(" "),a("tr",[a("td",[t._v("subject")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Email subject line")])]),t._v(" "),a("tr",[a("td",[t._v("from_name")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Sender display name")])]),t._v(" "),a("tr",[a("td",[t._v("from_email")]),t._v(" "),a("td",[a("em",[t._v("string")])]),t._v(" "),a("td",[t._v("Sender email address")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-6"}},[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('"campaign_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"June Newsletter"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subject"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Updated subject line"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from_name"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Jane"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from_email"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"john@example.com"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"draft"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"updated"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),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("h3",{attrs:{id:"possible-errors-5"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-5"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found or not a draft")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"delete-campaign"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#delete-campaign"}},[t._v("#")]),t._v(" Delete Campaign")]),t._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("DELETE https://api.wolfeo.me/v1/campaign\n")])])]),a("p",[t._v("Permanently deletes a draft campaign. Scheduled campaigns cannot be deleted — cancel the schedule first.")]),t._v(" "),a("h3",{attrs:{id:"example-request-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-7"}},[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 DELETE "https://api.wolfeo.me/v1/campaign" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{"campaign_id": 42}\'\n')])])]),a("h3",{attrs:{id:"parameters-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-7"}},[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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("The campaign ID to delete")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-7"}},[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('"deleted"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),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("h3",{attrs:{id:"possible-errors-6"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-6"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found")])]),t._v(" "),a("tr",[a("td",[t._v("CAMPAIGN_SCHEDULED")]),t._v(" "),a("td",[t._v("409")]),t._v(" "),a("td",[t._v("Campaign is scheduled and cannot be deleted")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"send-campaign-immediately"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#send-campaign-immediately"}},[t._v("#")]),t._v(" Send Campaign Immediately")]),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/v1/campaign-send\n")])])]),a("p",[t._v("Sends an existing draft campaign immediately to the specified audience. Use "),a("a",{attrs:{href:"#schedule-campaign"}},[t._v("Schedule Campaign")]),t._v(" to send at a future date instead.")]),t._v(" "),a("h3",{attrs:{id:"example-request-8"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#example-request-8"}},[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/v1/campaign-send" \\\n  --header "Authorization: Bearer YOUR_API_KEY" \\\n  --header "Content-Type: application/json" \\\n  --data \'{\n    "campaign_id": 42,\n    "incl_tag_ids": [12, 34],\n    "excl_tag_ids": [56]\n  }\'\n')])])]),a("h3",{attrs:{id:"parameters-8"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#parameters-8"}},[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("campaign_id*")]),t._v(" "),a("td",[a("em",[t._v("integer")])]),t._v(" "),a("td",[t._v("ID of the draft campaign to send")])]),t._v(" "),a("tr",[a("td",[t._v("send_to_all")]),t._v(" "),a("td",[a("em",[t._v("boolean")])]),t._v(" "),a("td",[t._v("Send to all contacts, ignoring filters (default: "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("tr",[a("td",[t._v("incl_tag_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Only send to contacts with these tags")])]),t._v(" "),a("tr",[a("td",[t._v("excl_tag_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Exclude contacts with these tags")])]),t._v(" "),a("tr",[a("td",[t._v("incl_sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Only send to contacts in these sequences")])]),t._v(" "),a("tr",[a("td",[t._v("excl_sequence_ids")]),t._v(" "),a("td",[a("em",[t._v("array")])]),t._v(" "),a("td",[t._v("Exclude contacts in these sequences")])])])]),t._v(" "),a("p",[a("em",[t._v("* denotes a required parameter")])]),t._v(" "),a("h3",{attrs:{id:"sample-return-8"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#sample-return-8"}},[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('"campaign_id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("42")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n        "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sending"')]),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("h3",{attrs:{id:"possible-errors-7"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#possible-errors-7"}},[t._v("#")]),t._v(" Possible Errors")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Code")]),t._v(" "),a("th",[t._v("HTTP")]),t._v(" "),a("th",[t._v("Description")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("NOT_FOUND")]),t._v(" "),a("td",[t._v("404")]),t._v(" "),a("td",[t._v("Campaign not found or already sent")])])])]),t._v(" "),a("hr"),t._v(" "),a("h2",{attrs:{id:"what-s-next"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#what-s-next"}},[t._v("#")]),t._v(" What's next")]),t._v(" "),a("ul",[a("li",[a("RouterLink",{attrs:{to:"/reference/contacts/"}},[t._v("Contacts")]),t._v(" — manage contacts and their email stats")],1),t._v(" "),a("li",[a("RouterLink",{attrs:{to:"/reference/sequences/"}},[t._v("Sequences")]),t._v(" — create and manage automated sequences")],1)])])}),[],!1,null,null,null);a.default=r.exports}}]);