{"_id":"56d0b9951ecc471500f179c7","user":"56c39c05bc41330d009f25d7","version":{"_id":"56c35c56c0c4630d004e864f","project":"56c35c56c0c4630d004e864c","__v":8,"createdAt":"2016-02-16T17:28:54.864Z","releaseDate":"2016-02-16T17:28:54.864Z","categories":["56c35c57c0c4630d004e8650","56c7b9e5379b311700ed8fe3","56c7bab4606ee717003c4766","56c7bb3613e5400d001e8cbd","56cf3f5a5267d70b00494c4b","56cf3f866c5d7a13005ee894","56fd3956caad892200847bce","599da256e7742b002588bb02"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"0.5.0","version":"0.5"},"__v":6,"githubsync":"","category":{"_id":"56cf3f866c5d7a13005ee894","__v":67,"project":"56c35c56c0c4630d004e864c","version":"56c35c56c0c4630d004e864f","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"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-02-25T17:53:10.154Z","from_sync":false,"order":1,"slug":"buzz-api-reference","title":"Buzz API Reference"},"parentDoc":null,"project":"56c35c56c0c4630d004e864c","updates":["5ae3344f36ee700003a65538","5ae378e3ba91d70003878215"],"next":{"pages":[],"description":""},"createdAt":"2016-02-26T20:46:13.072Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":true,"order":73,"body":"There are two API endpoints for manipulating list items:\n\n* The [list_item](doc:list_item) endpoint allows users to create, edit and delete individual list items\n* The [list_item_bulk](doc:list_item_bulk) endpoint allows users to create multiple list items in a single transaction and supports bulk file upload\n\nBoth endpoints allow users to add List Items, like Domains or App Bundles, to [Custom Lists](doc:custom-lists). \n\nThe Precise Geography list (`lat_long` type), has a slightly different API syntax, as described in [list_item (precise geography)](doc:list_item-precise-geography).\n\nList Items include an optional `value` field, used in conjunction with [Bid Modifiers](doc:bid-modifier-overview). Users can set the `value` of a List Item as a from 0-10. When the `value` field is present and the List is used in a Bid Modifier, the value is used to multiply the bid by the value. For example, if the List Item corresponds to the domain `beeswax.com` and has a value of `2.0`, any bid on an ad on that domain the bid will be double the Line Item's set CPM price.\n\nPreviously, users maintained List Items using the single `custom_list_item` endpoint for both individual and bulk actions, but this has been DEPRECATED and should no longer be used. For backwards compatibility, `custom_list_item` endpoint documentation can be found [here](doc:customlistitem), [here](doc:customlistitem-1), and [here](doc:custom_list_item).\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"list_item endpoint\"\n}\n[/block]\nThe `list_item` endpoint allows manipulation of individual list items.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"GET\",\n    \"0-1\": \"None\",\n    \"1-0\": \"POST\",\n    \"1-1\": \"None\",\n    \"2-0\": \"PUT\",\n    \"2-1\": \"None\",\n    \"3-0\": \"DELETE\",\n    \"3-1\": \"None\",\n    \"h-0\": \"Method\",\n    \"h-1\": \"Restriction\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"list_item_bulk endpoint\"\n}\n[/block]\nThe `list_item_bulk` endpoint allows bulk creation, deletion, and upload of multiple list items in a single transaction. \n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Method\",\n    \"h-1\": \"Restriction\",\n    \"0-0\": \"GET\",\n    \"0-1\": \"Not supported\",\n    \"1-0\": \"POST\",\n    \"1-1\": \"None, also allows for bulk upload with the `/upload` extra\",\n    \"2-0\": \"PUT\",\n    \"2-1\": \"Not supported\",\n    \"3-0\": \"DELETE\",\n    \"3-1\": \"Not supported\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Validation of List Items\"\n}\n[/block]\nList Items are validated in multiple ways:\n* The combination of the List Item and list is unique and duplicates are ignored\n* List types `app_ids` and `app_bundles` are case-sensitive, while `domains` are not\n* Each List Item includes the `pushed_to_server` field, which is set by the server when the item has been pushed to the server. If this field is `null` then the List Item is still pending.","excerpt":"","slug":"custom-lists-items","type":"basic","title":"List Items"}
There are two API endpoints for manipulating list items: * The [list_item](doc:list_item) endpoint allows users to create, edit and delete individual list items * The [list_item_bulk](doc:list_item_bulk) endpoint allows users to create multiple list items in a single transaction and supports bulk file upload Both endpoints allow users to add List Items, like Domains or App Bundles, to [Custom Lists](doc:custom-lists). The Precise Geography list (`lat_long` type), has a slightly different API syntax, as described in [list_item (precise geography)](doc:list_item-precise-geography). List Items include an optional `value` field, used in conjunction with [Bid Modifiers](doc:bid-modifier-overview). Users can set the `value` of a List Item as a from 0-10. When the `value` field is present and the List is used in a Bid Modifier, the value is used to multiply the bid by the value. For example, if the List Item corresponds to the domain `beeswax.com` and has a value of `2.0`, any bid on an ad on that domain the bid will be double the Line Item's set CPM price. Previously, users maintained List Items using the single `custom_list_item` endpoint for both individual and bulk actions, but this has been DEPRECATED and should no longer be used. For backwards compatibility, `custom_list_item` endpoint documentation can be found [here](doc:customlistitem), [here](doc:customlistitem-1), and [here](doc:custom_list_item). [block:api-header] { "type": "basic", "title": "list_item endpoint" } [/block] The `list_item` endpoint allows manipulation of individual list items. [block:parameters] { "data": { "0-0": "GET", "0-1": "None", "1-0": "POST", "1-1": "None", "2-0": "PUT", "2-1": "None", "3-0": "DELETE", "3-1": "None", "h-0": "Method", "h-1": "Restriction" }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "list_item_bulk endpoint" } [/block] The `list_item_bulk` endpoint allows bulk creation, deletion, and upload of multiple list items in a single transaction. [block:parameters] { "data": { "h-0": "Method", "h-1": "Restriction", "0-0": "GET", "0-1": "Not supported", "1-0": "POST", "1-1": "None, also allows for bulk upload with the `/upload` extra", "2-0": "PUT", "2-1": "Not supported", "3-0": "DELETE", "3-1": "Not supported" }, "cols": 2, "rows": 4 } [/block] [block:api-header] { "title": "Validation of List Items" } [/block] List Items are validated in multiple ways: * The combination of the List Item and list is unique and duplicates are ignored * List types `app_ids` and `app_bundles` are case-sensitive, while `domains` are not * Each List Item includes the `pushed_to_server` field, which is set by the server when the item has been pushed to the server. If this field is `null` then the List Item is still pending.