{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/rest/list_item","auth":"required","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"success\": true,\n    \"payload\": {\n        \"id\": 1\n    },\n    \"message\": \"list_item created with ID = 1\"\n}","name":""}]},"settings":"","examples":{"codes":[{"code":"curl -X POST \"[host]/rest/list_item\" -b cookies.txt -d '{\"list_id\":1, \"list_item\":{\"lat\":-89.0122,\"long\":78.92,\"radius_km\":0.5},\"list_item_name\":\"Starbucks on Main St\",\"value\":0.9}'","language":"curl"}]},"method":"post","params":[{"name":"list_id","type":"int","default":"","desc":"The unique ID of the list. List must be active.","required":true,"in":"body","ref":"","_id":"56c38f9c2d97560d00e23cba"},{"name":"list_item","type":"array_string","default":"","desc":"The latitude, longitude, and radius passed as json (see example below)","required":true,"in":"body","ref":"","_id":"56c39b11e1e4190d003429b6"},{"name":"value","type":"double","default":"","desc":"A numeric value assigned to the list item that can be used by a Bid Modifier","required":false,"in":"body","ref":"","_id":"5ae3274fba91d70003877cec"},{"name":"list_item_name","type":"string","default":"","desc":"Optional name for the list item","required":false,"in":"body","ref":"","_id":"5b5b254ed8add30003eeca50"},{"name":"active","type":"boolean","default":"1","desc":"Whether the item is active","required":false,"in":"body","ref":"","_id":"57447b3bc0ec922400d14fad"}]},"next":{"description":"","pages":[]},"title":"list_item (precise geography)","type":"endpoint","slug":"list_item-precise-geography","excerpt":"","body":"Note, while all other `list_item` endpoints require the `list_item` field to be a string, when working with precise geo lists (`lat_long` list type), the `list_item` field is a json object that must include a `lat` and a `long` element, and optionally, a `radius_km`. If the `radius_km` is omitted the radius set for the list will be used.\n[block:api-header]\n{\n  \"title\": \"GETs\"\n}\n[/block]\nWhen `GET`ting a `list_item` of this type, the `list_item` field will also be returned as json, instead of a string as shown in the example below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"success\\\": true,\\n    \\\"payload\\\": [\\n        {\\n            \\\"list_item_id\\\": 1,\\n            \\\"list_id\\\": 5,\\n            \\\"list_item\\\": {\\n                \\\"lat\\\": -89.0122,\\n                \\\"long\\\": -170.98001,\\n                \\\"radius_km\\\": 11\\n            },\\n            \\\"list_item_name\\\": \\\"Starbucks on Main Street\\\",\\n            \\\"create_date\\\": \\\"2018-08-08 09:56:16\\\",\\n            \\\"update_date\\\": \\\"2018-08-08 09:56:16\\\",\\n            \\\"active\\\": true,\\n            \\\"value\\\": 1.2,\\n            \\\"pushed_to_server\\\": null,\\n            \\\"account_id\\\": 1,\\n            \\\"buzz_key\\\": \\\"stinger\\\"\\n        }\\n    ]\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","updates":[],"order":93,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5b76c2947d0df8000369a570","project":"56c35c56c0c4630d004e864c","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},"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"},"user":"56c39c05bc41330d009f25d7","createdAt":"2018-08-17T12:41:56.460Z","__v":4,"parentDoc":null}

postlist_item (precise geography)


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

list_id:
required
integer
The unique ID of the list. List must be active.
list_item:
required
array of strings
The latitude, longitude, and radius passed as json (see example below)
value:
double
A numeric value assigned to the list item that can be used by a Bid Modifier
list_item_name:
string
Optional name for the list item
active:
boolean1
Whether the item is active

Examples


Result Format


Documentation

Note, while all other `list_item` endpoints require the `list_item` field to be a string, when working with precise geo lists (`lat_long` list type), the `list_item` field is a json object that must include a `lat` and a `long` element, and optionally, a `radius_km`. If the `radius_km` is omitted the radius set for the list will be used. [block:api-header] { "title": "GETs" } [/block] When `GET`ting a `list_item` of this type, the `list_item` field will also be returned as json, instead of a string as shown in the example below: [block:code] { "codes": [ { "code": "{\n \"success\": true,\n \"payload\": [\n {\n \"list_item_id\": 1,\n \"list_id\": 5,\n \"list_item\": {\n \"lat\": -89.0122,\n \"long\": -170.98001,\n \"radius_km\": 11\n },\n \"list_item_name\": \"Starbucks on Main Street\",\n \"create_date\": \"2018-08-08 09:56:16\",\n \"update_date\": \"2018-08-08 09:56:16\",\n \"active\": true,\n \"value\": 1.2,\n \"pushed_to_server\": null,\n \"account_id\": 1,\n \"buzz_key\": \"stinger\"\n }\n ]\n}", "language": "json" } ] } [/block]