Create Custom List Item

Summary

A list item can be created via two different methods - either as multi-part form data with a JSON file attached and the API key as a parameter, or as JSON content on it's own, with the API key supplied within the JSON.

The 'create item' method accepts an array of list items to be added to the system. If the 'update_existing' parameter is set, then any existing list items will be updated in the system. If set to false or not provided..

Multi Part Form Data

Create Item
URL	http://base_url/api_path/version/list/item/create
Type	POST
Params:	api_key	required
	file	required
	update_existing	optional (default = false)
Response	JSON

JSON As Body

Create Item - JSON
URL	https://base_url/api_path/version/list/item/create
Type	POST
	JSON {key, update_existing(optional), items[]}	required
Response	JSON

JSON Contents

The JSON file is passed in the post as the "file"

Standard Fields
Field	Expected Data	Required
list_key	varchar(255)
name	varchar(255)	✓
notes	text
order_position	int(11)
external_id	varchar(255)
triggers	varchar(255)

Fields exclusive to JSON body format:

Standard Fields
Field	Expected Data	Required
key	string - company api key	✓
update_existing	boolean

Example Input

Multi Part Form Data

{"items":[{
"external_id":"ss303",
"name":"Rolfe Centre",
"notes":"Medium size",
"list_key":"site_list",
"order_position": 1
}]}

JSON As Body

{
   "key":"darrenwebapi",
   "update_existing":true,
   "items":[
      {
        "external_id":"ss303",
"name":"Rolfe Centre",
"notes":"Medium size",
"list_key":"site_list",
"order_position": 1
      }
   ]
}

Example Curl Requests

Multi Part Form Data

curl -F update_existing=true -F api_key=darrenwebapi -F file=@/Users/darrenatherton/Desktop/webAPICurling/create_item.txt https://api.mymobileworkers.com:8181/api/1/list/item/create

JSON As Body

curl -X POST -H "Content-Type: application/json" -d '{"key":"darrenwebapi","update_existing":true,"items":[{"external_id":"ss303","name":"Rolfe Centre","notes":"Medium size","list_key":"site_list","order_position":1}]} https://api.mymobileworkers.com:8181/api/1/list/item/create

Responses

Example JSON

{
  "failed": [],
  "successful": [
    {
      "item_name": "Rolfe Centre"
    }
  ]
}