Update list

Update list

PATCH /api-list/list/{listId}

Update list

cURL

curl --request PATCH \
  --url https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId} \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '
{
  "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/{listId}"

payload = {
    "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.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'x-site-context': '<x-site-context>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'Summer List',
    listType: 'Wishlist',
    notes: 'Summer List',
    attributes: {approver: 'Jone Doe'}
  })
};

fetch('https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}', 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/{listId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    '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/{listId}"

	payload := strings.NewReader("{\n  \"name\": \"Summer List\",\n  \"listType\": \"Wishlist\",\n  \"notes\": \"Summer List\",\n  \"attributes\": {\n    \"approver\": \"Jone Doe\"\n  }\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://prod01-apigw.{customer_name}.fabric.zone/api-list/list/{listId}")
  .header("x-site-context", "<x-site-context>")
  .header("Content-Type", "application/json")
  .body("{\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/{listId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["x-site-context"] = '<x-site-context>'
request["Content-Type"] = 'application/json'
request.body = "{\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

200

{
  "_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

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"

Path Parameters

listId · string · required

Body

application/json

Option 1

Option 2

Option 3

Option 4

name · string · required

Minimum string length: 3

Example:

"Summer List"

listType · string

Example:

"Wishlist"

notes · string

Example:

"Summer List"

attributes · object

Example:

{ "approver": "Jone Doe" }

Response

200

application/json

list updated

_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 string length: 3

Example:

"Summer List"

listType · string

Example:

"Wishlist"

notes · string

Example:

"Summer List"

count · integer

Example:

10

attributes · object

Example:

{ "approver": "Jone Doe" }