{"_id":"5ae32a8186c32f00036463bd","project":"56c35c56c0c4630d004e864c","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"},"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"},"user":"56c39c05bc41330d009f25d7","githubsync":"","__v":11,"parentDoc":null,"updates":["5b17adffac58100003e3ceca"],"next":{"pages":[],"description":""},"createdAt":"2018-04-27T13:49:53.671Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"method":"post","examples":{"codes":[{"code":"#Bulk upload\ncurl -X POST \"[host]/rest/list_item_bulk\" -b cookies.txt -d '{\"list_id\":1, \"list_items\":[{\"list_item\":\"foo\",\"value\":1.2},{\"list_item\":\"bar\"}]}'\n\n#File upload using list ID in format /upload/LIST_ID\ncurl -X POST \"[host]/rest/list_item_bulk/upload/123\" -b cookies.txt -F 'list_item=:::at:::/local/path/foo.csv'","language":"curl"}]},"settings":"","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"success\": true,\n    \"payload\": {\n        \"id\": 60\n    },\n    \"message\": \"list_item creation: 2 created successfully\"\n}","name":""}]},"auth":"required","params":[{"_id":"56c38f9c2d97560d00e23cba","ref":"","in":"body","required":true,"desc":"The unique ID of the list. List must be active.","default":"","type":"int","name":"list_id"},{"_id":"56c39b11e1e4190d003429b6","ref":"","in":"body","required":true,"desc":"An array of items and optional values in format `{\"list_item\":\"foo\",\"value\":1.2}`. Items are validated based on the type of the corresponding Custom List","default":"","type":"array_string","name":"list_items"}],"url":"/rest/list_item_bulk"},"isReference":true,"order":79,"body":"When using the `upload` extra to upload bulk files of list items, the following considerations should be taken:\n* Uploading a bulk file will replace any existing list items that are duplicates, and will add new list items \n* File formats supported are `csv`, `txt`, `xls` and `xlsx`.\n* See details below on formatting of files\n[block:api-header]\n{\n  \"title\": \"TXT Uploads\"\n}\n[/block]\nText files are expected to be pipe separated with fields in specific order and separated by newlines. For example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"one_list_item,\\na list item with a value|0.4\\na list item with a value and a name|0.4|a name goes here\\na list item with a name but no value||a name goes here\",\n      \"language\": \"text\",\n      \"name\": \"txt example\"\n    }\n  ]\n}\n[/block]\nFor `lat_long` text files, the order of fields is `lat|long|radius|value|name` as shown below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"10|10|0.5\\n10|13|0.5|0.9|Starbucks on Main St\\n10|15||0.9|Starbucks with default radius\\n10|16|||Starbucks with default radius and no value\",\n      \"language\": \"text\",\n      \"name\": \"txt lat_long example\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"CSV Uploads\"\n}\n[/block]\nFor csv files each list_item should be a single string in quotes with pipes delimiting the values. Examples below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"one_list_item\\\",\\n\\\"a list item with a value|0.4\\\"\\n\\\"a list item with a value and a name|0.4|a name goes here\\\"\\n\\\"a list item with a name but no value||a name goes here\\\"\",\n      \"language\": \"text\",\n      \"name\": \"csv example\"\n    }\n  ]\n}\n[/block]\nFor `lat_long` csv files, the order of fields is `lat|long|radius|value|name` as shown below:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\\\"10|10|0.5\\\",\\n\\\"10|13|0.5|0.9|Starbucks on Main St\\\",\\n\\\"10|15||0.9|Starbucks with default radius\\\",\\n\\\"10|16|||Starbucks with default radius and no value\\\",\",\n      \"language\": \"text\",\n      \"name\": \"csv lat_long example\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Excel Uploads\"\n}\n[/block]\nFor excel bulk uploads (other than `lat_long` list type), the values must be in the first tab of the file and the file should not have a header row. The values must be in the following order, with only the `list_item` as a required field:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"list_item\",\n    \"0-1\": \"value\",\n    \"0-2\": \"list_item_name\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\nFor `lat_long` lists, the values should be in the following order, with the `lat` and `long` as required fields:\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"lat\",\n    \"0-1\": \"long\",\n    \"0-2\": \"radius_km\",\n    \"0-3\": \"value\",\n    \"0-4\": \"list_item_name\"\n  },\n  \"cols\": 5,\n  \"rows\": 1\n}\n[/block]","excerpt":"","slug":"list_item_bulk","type":"endpoint","title":"list_item_bulk"}

postlist_item_bulk


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Body Params

list_id:
required
integer
The unique ID of the list. List must be active.
list_items:
required
array of strings
An array of items and optional values in format `{"list_item":"foo","value":1.2}`. Items are validated based on the type of the corresponding Custom List

Examples


Result Format


Documentation

When using the `upload` extra to upload bulk files of list items, the following considerations should be taken: * Uploading a bulk file will replace any existing list items that are duplicates, and will add new list items * File formats supported are `csv`, `txt`, `xls` and `xlsx`. * See details below on formatting of files [block:api-header] { "title": "TXT Uploads" } [/block] Text files are expected to be pipe separated with fields in specific order and separated by newlines. For example: [block:code] { "codes": [ { "code": "one_list_item,\na list item with a value|0.4\na list item with a value and a name|0.4|a name goes here\na list item with a name but no value||a name goes here", "language": "text", "name": "txt example" } ] } [/block] For `lat_long` text files, the order of fields is `lat|long|radius|value|name` as shown below: [block:code] { "codes": [ { "code": "10|10|0.5\n10|13|0.5|0.9|Starbucks on Main St\n10|15||0.9|Starbucks with default radius\n10|16|||Starbucks with default radius and no value", "language": "text", "name": "txt lat_long example" } ] } [/block] [block:api-header] { "title": "CSV Uploads" } [/block] For csv files each list_item should be a single string in quotes with pipes delimiting the values. Examples below: [block:code] { "codes": [ { "code": "\"one_list_item\",\n\"a list item with a value|0.4\"\n\"a list item with a value and a name|0.4|a name goes here\"\n\"a list item with a name but no value||a name goes here\"", "language": "text", "name": "csv example" } ] } [/block] For `lat_long` csv files, the order of fields is `lat|long|radius|value|name` as shown below: [block:code] { "codes": [ { "code": "\"10|10|0.5\",\n\"10|13|0.5|0.9|Starbucks on Main St\",\n\"10|15||0.9|Starbucks with default radius\",\n\"10|16|||Starbucks with default radius and no value\",", "language": "text", "name": "csv lat_long example" } ] } [/block] [block:api-header] { "title": "Excel Uploads" } [/block] For excel bulk uploads (other than `lat_long` list type), the values must be in the first tab of the file and the file should not have a header row. The values must be in the following order, with only the `list_item` as a required field: [block:parameters] { "data": { "0-0": "list_item", "0-1": "value", "0-2": "list_item_name" }, "cols": 3, "rows": 1 } [/block] For `lat_long` lists, the values should be in the following order, with the `lat` and `long` as required fields: [block:parameters] { "data": { "0-0": "lat", "0-1": "long", "0-2": "radius_km", "0-3": "value", "0-4": "list_item_name" }, "cols": 5, "rows": 1 } [/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 }}