{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/rest/creative_addon","auth":"required","params":[{"name":"creative_addon_name","type":"string","default":"","desc":"Name of the Creative AddOn, e.g. \"MOAT Viewabiity\"","required":true,"in":"body","ref":"","_id":"56c38f9c2d97560d00e23cba"},{"name":"global","type":"boolean","default":"0","desc":"Is this a global addon, available to all Buzz accounts? Only Super Users may create global addons.","required":true,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b6"},{"name":"advertiser_id","type":"int","default":"","desc":"Make the addon only available to a single Advertiser","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b2"},{"name":"include_by_default","type":"boolean","default":"false","desc":"Should this addon always be included when creating a new Creative of the same creative_type","required":false,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b1"},{"name":"active","type":"boolean","default":"1","desc":"Is it active?","required":true,"in":"body","ref":"","_id":"56d0b2e640d36e1d00bc1457"},{"name":"creative_type","type":"int","default":"0","desc":"0 = banner, 1=video","required":false,"in":"body","ref":"","_id":"579104f78bd8eb19008aaf36"},{"name":"creative_addon_type","type":"string","default":"","desc":"Must be wither `PIXEL` or `SCRIPT`","required":true,"in":"body","ref":"","_id":"579104f78bd8eb19008aaf35"},{"name":"creative_addon_content","type":"string","default":"","desc":"Should always be a URL","required":true,"in":"body","ref":"","_id":"579104f78bd8eb19008aaf34"},{"name":"secure","type":"boolean","default":"1","desc":"Is the pixel secure (https)?","required":false,"in":"body","ref":"","_id":"57bb80cc921a7a0e00b646d1"},{"name":"cpm_cost","type":"double","default":"","desc":"Cost to be attributed to use of the pixel.","required":false,"in":"body","ref":"","_id":"579104f78bd8eb19008aaf33"},{"name":"notes","type":"string","default":"","desc":"<255 chars","required":false,"in":"body","ref":"","_id":"56d0b2e640d36e1d00bc1458"}],"results":{"codes":[{"name":"","status":200,"language":"json","code":"{\n    \"success\": true,\n    \"message\": \"creative_addon created with ID = 1\",\n    \"payload\": {\n        \"id\": 1\n    }\n}"}]},"settings":"","examples":{"codes":[{"language":"curl","code":"curl -X POST \"[host]/rest/creative_addon\" -b cookies.txt -d '{\"creative_addon_name\":\"new creative addon\", \"creative_addon_content\":\"http://foo.com/pixel.jpg\", \"creative_type\":-1, \"global\":false, \"creative_addon_type\":\"PIXEL\",\"active\":1}'"}]},"method":"post"},"next":{"description":"","pages":[]},"title":"creative_addon","type":"endpoint","slug":"creative_addon","excerpt":"","body":"","updates":["5d8a3157a1d9db011499eeba"],"order":62,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"579104f78bd8eb19008aaf32","version":{"version":"0.5","version_clean":"0.5.0","codename":"","is_stable":true,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"_id":"56c35c56c0c4630d004e864f","createdAt":"2016-02-16T17:28:54.864Z","project":"56c35c56c0c4630d004e864c","releaseDate":"2016-02-16T17:28:54.864Z","__v":8},"user":"56c39c05bc41330d009f25d7","project":"56c35c56c0c4630d004e864c","parentDoc":null,"__v":3,"githubsync":"","category":{"sync":{"isSync":false,"url":""},"pages":["56cf5bb88629f91300fd97c5","56cf5bf68629f91300fd97c7","56cf5fd2287eb20b009f9f37","56cf631a44c5700b0095c1c8","56cf63ae6c5d7a13005eeb58","56cf6408287eb20b009f9f40","56cf643a287eb20b009f9f43","56cf65ba336aa60b0086a435","56cf66df336aa60b0086a440","56cf69b344c5700b0095c1cf","56cf6a3d44c5700b0095c1d3","56cf6ac6336aa60b0086a44e","56cf6b298acacb13008148c9","56cf6cd68629f91300fd97e3","56cf6e048acacb13008148cd","56cf6eac336aa60b0086a455","56cf6edf287eb20b009f9f5a","56cf6f6b336aa60b0086a462","56cf704e8629f91300fd97f0","56cf70bf6c5d7a13005eeb6f","56cf72c6287eb20b009f9f76","56cf74c86c5d7a13005eeb7f","56cf75f5336aa60b0086a496","56cf76b68629f91300fd9801","56cf76da8629f91300fd9805","56cf776c8acacb13008148dc","56cf77ca6c5d7a13005eeb92","56cf788044c5700b0095c1fe","56cf78c28acacb13008148e5","56cf7a9544c5700b0095c207","56cf7b9b44c5700b0095c20c","56cf7c268629f91300fd980f","56cf7c456c5d7a13005eeba4","56d097b1376b040b005b3029","56d0992940d36e1d00bc13dd","56d099ed167e1e1b008079d2","56d09afa376b040b005b3032","56d09ba01ecc471500f1794a","56d09c13376b040b005b3034","56d09cde167e1e1b008079d7","56d09f30167e1e1b008079e2","56d0a00b376b040b005b303d","56d0a063167e1e1b008079e6","56d0a11a7c2e100b000af929","56d0b072167e1e1b00807a2e","56d0b0fb7c2e100b000af98b","56d0b16d1ecc471500f179af","56d0b1ee7c2e100b000af991","56d0b2407c2e100b000af998","56d0b2e640d36e1d00bc1456","56d0b3511ecc471500f179bc","56d0b3aab2cb7013004de65b","56d0b3d1b2cb7013004de65e","56d0b3fe7c2e100b000af9a1","56d0b4d67c2e100b000af9a5","56d0b52fb2cb7013004de666","56d0b59db2cb7013004de66c","56d0b621167e1e1b00807a4c","56d0b787167e1e1b00807a54","56d0b82d167e1e1b00807a55","56d0b8a8167e1e1b00807a5d","56d0b8fe167e1e1b00807a60","56d0b9951ecc471500f179c7","56d0ba55376b040b005b30a1","56d0bac31ecc471500f179cc","56d0bb6e167e1e1b00807a64","56d0bc95167e1e1b00807a6a"],"title":"Buzz API Reference","slug":"buzz-api-reference","order":1,"from_sync":false,"reference":true,"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","createdAt":"2016-02-25T17:53:10.154Z"},"createdAt":"2016-07-21T17:23:03.147Z"}

postcreative_addon


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

creative_addon_name:
required
string
Name of the Creative AddOn, e.g. "MOAT Viewabiity"
global:
required
boolean0
Is this a global addon, available to all Buzz accounts? Only Super Users may create global addons.
advertiser_id:
integer
Make the addon only available to a single Advertiser
include_by_default:
booleanfalse
Should this addon always be included when creating a new Creative of the same creative_type
active:
required
boolean1
Is it active?
creative_type:
integer0
0 = banner, 1=video
creative_addon_type:
required
string
Must be wither `PIXEL` or `SCRIPT`
creative_addon_content:
required
string
Should always be a URL
secure:
boolean1
Is the pixel secure (https)?
cpm_cost:
double
Cost to be attributed to use of the pixel.
notes:
string
<255 chars

Examples


Result Format