Update list by Id

Updates list details by its Id. Updating a list does not does not update item details. To add or delete items to or from a list, use POST/{listId}/items endpoint.

PATCH /list/{listId}

Try it

Update list by Id

cURL

curl --request PATCH \
  --url https://prod01.oms.fabric.inc/api/v2/list/{listId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Wishlist",
  "userId": null,
  "listId": "5349b4ddd2781d08c09890f4",
  "listType": "Wish list",
  "notes": "Add items to your wishlist to purchase later",
  "attributes": {
    "attr1": "value1",
    "attr2": "value2"
  },
  "count": 0,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}
'

200

{
  "name": "Wishlist",
  "userId": null,
  "listId": "5349b4ddd2781d08c09890f4",
  "listType": "Wish list",
  "notes": "Add items to your wishlist to purchase later",
  "attributes": {
    "attr1": "value1",
    "attr2": "value2"
  },
  "count": 0,
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

listId · string · required

Id of the list that is updated.

Example:

"62fa3796841ea417fa71d2a9"

Body

application/json

List details

name · string · required

Example:

"Wishlist"

userId · string · required

Example:

null

listId · string

Example:

"5349b4ddd2781d08c09890f4"

listType · string

Example:

"Wish list"

notes · string

Example:

"Add items to your wishlist to purchase later"

attributes · object

Show child attributes

attributes. {key} · object

Example:

{ "attr1": "value1", "attr2": "value2" }

Example:

{ "attr1": "value1", "attr2": "value2" }

count · integer<int32>

Number of items added to the list.

Required range: x >= 0

Example:

0

createdAt · string<date-time>

updatedAt · string<date-time>

Response

200

application/json

List object Updated

List details

name · string · required

Example:

"Wishlist"

userId · string · required

Example:

null

listId · string

Example:

"5349b4ddd2781d08c09890f4"

listType · string

Example:

"Wish list"

notes · string

Example:

"Add items to your wishlist to purchase later"

attributes · object

Show child attributes

attributes. {key} · object

Example:

{ "attr1": "value1", "attr2": "value2" }

Example:

{ "attr1": "value1", "attr2": "value2" }

count · integer<int32>

Number of items added to the list.

Required range: x >= 0

Example:

0

createdAt · string<date-time>

updatedAt · string<date-time>