API Reference

Fields in list

Fields available in a list.

📘

Things to consider

Fields that are visible but not documented are for internal usage

Fields in list

{
  "lid": "swym generated list ID",
  "lname": "List name. List names need not be unique, i.e. If uniqueness is needed API caller should ensure dupes are not",
  "lty": "_recommends", //To prevent mixing with enduser created wishlists
  "lnote": "Optional. List note, single line of note at the list level",
  "lprops": {}, //Optional. Map or properties - {}. Not available downstream for reporting or segmentation queries
  "anonRead": "Optional. Default - false. Boolean flag if anonymous read is allowed for the given List ID",
  "cnt": 0,
  "_cp": false,
  "cby": "Created by email address",
  "uby": "Updated by email address",
  "cts": "Created at in milliseconds",
  "uts": "Updated at in milliseconds",
  "userinfo": {}
}

Argument

Type

Description

lid

string

List id to be updated

lname

string

List name

listcontents

array

Preview array of list items

lty
(optional)

string

List type - when null, it represents wishlist. When set to a value eg: _saveForLater, gets added to a different type of list separate from the wishlist

lnote (optional)

string

Optional note

lprops
(optional)

object

Optional. Map of custom fields

anonRead
(optional)

boolean

Optional. True if the list can be read anonymously with lid

cnt

number

Number of items in list

  • cp
    (optional)

boolean

Optional. True if list duplication is in progress, copying the list items for large lists

cts

number

Created time at in milliseconds

uts (optional)

number

Last updated time at in milliseconds

cby
(optional)

string

Email address of the user if known when list was created

uby
(optional)

string

Email address of the user if known when list was last updated

userinfo
(optional)

object

User info of the list owner if user is known

userinfo.em

string

Email address of the owner

userinfo.fname

string

First name of the owner

userinfo.lname

string

Last name of the owner