API Reference

List Config

Configure your list creation.

A simple Javascript object containing parameters required for creating a new list

let listConfig = {
  "lname": "Todo List", // list name
  "lty": "wl", // List type  wl - wishlist, sfl - save for later
  "fromlid": "list Id", // list id to duplicate from
  "lnote": "This list is for my todo list", // optional note
  "lprops": {} // optional. Map of custom fields
};
--data-urlencode 'lname={{lname}}' \
--data-urlencode 'lty={{lty}}' \
--data-urlencode 'fromlid={{fromlid}}' \
--data-urlencode 'lnote={{lnote}}' \
--data-urlencode 'lprops={{JSON stringified lprops}}' \

Argument

Type

Description

listConfig.lname

string

List name - unique for a given user, allows 3-50 characters.

listConfig.lty
(optional)

string

specifies the type of list you want to create, wl - wishlist, sfl - save for later, this is used to create a different type of list separate from the wishlist

listConfig.fromlid
(optional)

string

List id to duplicate from, lname has to be different from original list

listConfig.lnote (optional)

string

Optional note.

listConfig.lprops
(optional)

object

Optional. Map of custom fields