Create 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"
}
}
'import requests
url = "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list"
payload = {
"userId": "33d01d57-4bfa-4a14-bacc-036617ec02b9",
"name": "Summer List",
"listType": "Wishlist",
"notes": "Summer List",
"attributes": { "approver": "Jone Doe" }
}
headers = {
"x-site-context": "<x-site-context>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '33d01d57-4bfa-4a14-bacc-036617ec02b9',
name: 'Summer List',
listType: 'Wishlist',
notes: 'Summer List',
attributes: {approver: 'Jone Doe'}
})
};
fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-list/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '33d01d57-4bfa-4a14-bacc-036617ec02b9',
'name' => 'Summer List',
'listType' => 'Wishlist',
'notes' => 'Summer List',
'attributes' => [
'approver' => 'Jone Doe'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-site-context: <x-site-context>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list"
payload := strings.NewReader("{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list")
.header("x-site-context", "<x-site-context>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_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"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "LIST_TYPE_NOT_FOUND",
"message": "List type ID not found"
}{
"code": "<string>",
"message": "<string>"
}List
Create list
Create list
POST
/
api-list
/
list
Create 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"
}
}
'import requests
url = "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list"
payload = {
"userId": "33d01d57-4bfa-4a14-bacc-036617ec02b9",
"name": "Summer List",
"listType": "Wishlist",
"notes": "Summer List",
"attributes": { "approver": "Jone Doe" }
}
headers = {
"x-site-context": "<x-site-context>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
body: JSON.stringify({
userId: '33d01d57-4bfa-4a14-bacc-036617ec02b9',
name: 'Summer List',
listType: 'Wishlist',
notes: 'Summer List',
attributes: {approver: 'Jone Doe'}
})
};
fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-list/list', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'userId' => '33d01d57-4bfa-4a14-bacc-036617ec02b9',
'name' => 'Summer List',
'listType' => 'Wishlist',
'notes' => 'Summer List',
'attributes' => [
'approver' => 'Jone Doe'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-site-context: <x-site-context>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://prod01-apigw.{customer_name}.fabric.zone/api-list/list"
payload := strings.NewReader("{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-site-context", "<x-site-context>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list")
.header("x-site-context", "<x-site-context>")
.header("Content-Type", "application/json")
.body("{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"userId\": \"33d01d57-4bfa-4a14-bacc-036617ec02b9\",\n \"name\": \"Summer List\",\n \"listType\": \"Wishlist\",\n \"notes\": \"Summer List\",\n \"attributes\": {\n \"approver\": \"Jone Doe\"\n }\n}"
response = http.request(request)
puts response.read_body{
"_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"
}
}{
"code": "<string>",
"message": "<string>"
}{
"code": "LIST_TYPE_NOT_FOUND",
"message": "List type ID not found"
}{
"code": "<string>",
"message": "<string>"
}Headers
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\"}"
Example:
"0LybWR49k95cCwYh3cu0waCYoh4H2Eux2J52wn4k"
Body
application/json
Response
Created list
Example:
"5fee9d59f2f08a1b3cbdea08"
Example:
"2020-12-31T02:09:53.914Z"
Example:
"2020-12-31T02:09:53.914Z"
Example:
"33d01d57-4bfa-4a14-bacc-036617ec02b9"
Minimum string length:
3Example:
"Summer List"
Example:
"Wishlist"
Example:
"Summer List"
Example:
10
Example:
{ "approver": "Jone Doe" }
Was this page helpful?
⌘I
