{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/campaigns/<campaignID>/launch","auth":"required","examples":{"codes":[{"language":"json","code":"{\n      \"content\": {\n          \"subject_line\": \"Here is an example of a name-value pair that I can use to populate my subject line\",\n          \"message_body1\": \"Maybe this could be used to populate some other part of the message somewhere.\"\n      },\n      \"audience\": [\n          {\n              \"version_number\": 1,\n              \"exclude\": [\n                  \"Active\"\n              ],\n              \"include\": [\n                  \"Slipping away\"\n              ]\n          },\n          {\n              \"version_number\": 2,\n              \"include\": [\n                  \"Active\"\n              ],\n              \"exclude\": [\n                  \"Slipping away\"\n              ]\n          }\n      ]\n    }"}]},"method":"post","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"message\": \"Success\"\n}","name":""}]},"settings":"5c6d8979a96ba90033cbf5bb","params":[{"name":"content","type":"array_object","default":"","desc":"A set of name value pairs that can be used in the message itself to populate content for this occurrence of the broadcast. Example: \"headline\":\"New Product Feature\" can be referenced in the template by inserting {{headline}} similar to a standard personalization tag.","required":false,"in":"body","ref":"","_id":"575b25d51b12630e0083d352"},{"name":"audience","type":"array_mixed","default":"","desc":"An array of audiences assigned per version","required":false,"in":"body","ref":"","_id":"575b290057b1c00e00556fb2"},{"name":"audience.version_number","type":"int","default":"","desc":"Indicator of which version to assign segments to.  Required only if including segments via the API.","required":false,"in":"body","ref":"","_id":"5c6d8ef872d41800308fc282"},{"name":"audience.include","type":"array_string","default":"","desc":"An array of segments to override existing included segments.  The segments must already exist in the platform.","required":false,"in":"body","ref":"","_id":"5c740ccf2016b1005d932726"},{"name":"audience.exclude","type":"array_string","default":"","desc":"An array of segments to override existing excluded segments.  The segments must already exist in the platform.","required":false,"in":"body","ref":"","_id":"5887af8ad9d79c3b00c4032c"},{"name":"Content-Type","type":"string","default":"application/json","desc":"Must be set to application/json","required":true,"in":"header","ref":"","_id":"588284cbb660480f00c0f292"},{"name":"Accept","type":"string","default":"application/json","desc":"Must be set to application/json","required":true,"in":"header","ref":"","_id":"588284cbb660480f00c0f291"}]},"next":{"description":"","pages":[]},"title":"Send API-Broadcast Campaign","type":"endpoint","slug":"send-api-broadcast-campaign","excerpt":"Trigger an existing Multi-Version Campaign that is set to \"Broadcast when an API request is made\".","body":"[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Required Headers\",\n    \"h-1\": \"Value\",\n    \"0-0\": \"Content-Type\",\n    \"0-1\": \"application/json\",\n    \"1-1\": \"application/json\",\n    \"1-0\": \"Accept\",\n    \"2-0\": \"Authorization\",\n    \"2-1\": \"Basic <Auth Key>\"\n  },\n  \"cols\": 2,\n  \"rows\": 3\n}\n[/block]","updates":[],"order":10,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5c8fe022039ac500629a42b4","project":"56aff08c3a5b810d00745d99","version":{"version":"1","version_clean":"1.0.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56aff08d3a5b810d00745d9d","56aff24f3a5b810d00745da0","56aff25dbc304a0d00ace207","56aff287e0b1e40d00c53798","56aff2b260a37a0d00ed8883","56aff2b8e0b1e40d00c53799","56aff2bd5b1f01170014dc7b","56aff2c9d21e9c0d00b62993","56aff493aef9a21700da0e67","56aff4ce1486990d009c0f64","56aff4da5b1f01170014dc7d","56aff4dfe0b1e40d00c537a2","56aff4e59d32e30d0006d3e9","56aff4e91486990d009c0f65","56aff4f93a5b810d00745da2","56aff4fe9d32e30d0006d3ea","56b91c7ab1e03e0d001057c5","56c4f51aba4a540d0091b9a2","56cd09488c4a331d002c1e44","56d4ec4773dcd20b00fb8769","56e79bc515f96b2200878e54","56ec25c538ff1d2200d56cc2","56ec3a6f36bc8e0e00f190c8","56ec3e308ea7ce0e00a3d8b0","5724d8fe4255580e005938b2","5724dc842ad0bc1700122803","5776ef2a04f7500e0095dc37","57ab9f70b5e8742000e17eb9","57d7117646dcc30e007dd21f","58e6abd5b1eece19008b7d31","59288c65e2653627003e1221","5a8f4797a44f8600128e75ee","5bbf8833eb416300039a2c14","5ea811617bf4b5007328a0af"],"_id":"56aff08c3a5b810d00745d9c","project":"56aff08c3a5b810d00745d99","releaseDate":"2016-02-01T23:55:56.544Z","__v":34,"createdAt":"2016-02-01T23:55:56.544Z"},"category":{"sync":{"isSync":false,"url":""},"pages":["56ec26de1b16a3290030cf58"],"title":"Zeta REST API","slug":"bme-rest-api","order":2,"from_sync":false,"reference":true,"_id":"56ec25c538ff1d2200d56cc2","version":"56aff08c3a5b810d00745d9c","__v":1,"createdAt":"2016-03-18T15:59:01.460Z","project":"56aff08c3a5b810d00745d99"},"user":"5c6d878b750bf101764da244","createdAt":"2019-03-18T18:14:58.682Z","__v":5,"parentDoc":null}

postSend API-Broadcast Campaign

Trigger an existing Multi-Version Campaign that is set to "Broadcast when an API request is made".

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

content:
array of objects
A set of name value pairs that can be used in the message itself to populate content for this occurrence of the broadcast. Example: "headline":"New Product Feature" can be referenced in the template by inserting {{headline}} similar to a standard personalization tag.
audience:
array of mixed
An array of audiences assigned per version
audience.version_number:
integer
Indicator of which version to assign segments to. Required only if including segments via the API.
audience.include:
array of strings
An array of segments to override existing included segments. The segments must already exist in the platform.
audience.exclude:
array of strings
An array of segments to override existing excluded segments. The segments must already exist in the platform.

Headers

Content-Type:
required
stringapplication/json
Must be set to application/json
Accept:
required
stringapplication/json
Must be set to application/json

Examples


Result Format


Documentation

[block:parameters] { "data": { "h-0": "Required Headers", "h-1": "Value", "0-0": "Content-Type", "0-1": "application/json", "1-1": "application/json", "1-0": "Accept", "2-0": "Authorization", "2-1": "Basic <Auth Key>" }, "cols": 2, "rows": 3 } [/block]

User Information

Try It Out

post
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}