POST
/
api-list
/
list
curl --request POST \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-list/list \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "userId": "33d01d57-4bfa-4a14-bacc-036617ec02b9",
  "name": "Summer List",
  "listType": "Wishlist",
  "notes": "Summer List",
  "attributes": {
    "approver": "Jone Doe"
  }
}'
{
  "_id": "5fee9d59f2f08a1b3cbdea08",
  "createdAt": "2020-12-31T02:09:53.914Z",
  "updatedAt": "2020-12-31T02:09:53.914Z",
  "userId": "33d01d57-4bfa-4a14-bacc-036617ec02b9",
  "name": "Summer List",
  "listType": "Wishlist",
  "notes": "Summer List",
  "count": 10,
  "attributes": {
    "approver": "Jone Doe"
  }
}

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

​
x-api-key
string
Example:

"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"

Body

application/json
​
userId
string
required
Example:

"33d01d57-4bfa-4a14-bacc-036617ec02b9"

​
name
string
required
Minimum length: 3
Example:

"Summer List"

​
listType
string
Example:

"Wishlist"

​
notes
string
Example:

"Summer List"

​
attributes
object
Example:
{ "approver": "Jone Doe" }

Response

200
application/json
Created list
​
_id
string
Example:

"5fee9d59f2f08a1b3cbdea08"

​
createdAt
string
Example:

"2020-12-31T02:09:53.914Z"

​
updatedAt
string
Example:

"2020-12-31T02:09:53.914Z"

​
userId
string
Example:

"33d01d57-4bfa-4a14-bacc-036617ec02b9"

​
name
string
Minimum length: 3
Example:

"Summer List"

​
listType
string
Example:

"Wishlist"

​
notes
string
Example:

"Summer List"

​
count
integer
Example:

10

​
attributes
object
Example:
{ "approver": "Jone Doe" }

Was this page helpful?

Get list by listIdOverview