Update data list
curl --request PATCH \
--url http://api.gu1.ai/data-lists/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"type": "<string>",
"source": "<string>",
"config": {},
"fieldMappings": {},
"priority": 123
}
'import requests
url = "http://api.gu1.ai/data-lists/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"type": "<string>",
"source": "<string>",
"config": {},
"fieldMappings": {},
"priority": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
type: '<string>',
source: '<string>',
config: {},
fieldMappings: {},
priority: 123
})
};
fetch('http://api.gu1.ai/data-lists/{id}', 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 => "http://api.gu1.ai/data-lists/{id}",
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' => '<string>',
'description' => '<string>',
'type' => '<string>',
'source' => '<string>',
'config' => [
],
'fieldMappings' => [
],
'priority' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://api.gu1.ai/data-lists/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://api.gu1.ai/data-lists/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/data-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_bodyAPI Reference
Update data list
Update a data list metadata: name, description, type, source, configuration, field mappings, and priority β PATCH /data-lists/.
PATCH
/
data-lists
/
{id}
Update data list
curl --request PATCH \
--url http://api.gu1.ai/data-lists/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"description": "<string>",
"type": "<string>",
"source": "<string>",
"config": {},
"fieldMappings": {},
"priority": 123
}
'import requests
url = "http://api.gu1.ai/data-lists/{id}"
payload = {
"name": "<string>",
"description": "<string>",
"type": "<string>",
"source": "<string>",
"config": {},
"fieldMappings": {},
"priority": 123
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
description: '<string>',
type: '<string>',
source: '<string>',
config: {},
fieldMappings: {},
priority: 123
})
};
fetch('http://api.gu1.ai/data-lists/{id}', 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 => "http://api.gu1.ai/data-lists/{id}",
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' => '<string>',
'description' => '<string>',
'type' => '<string>',
'source' => '<string>',
'config' => [
],
'fieldMappings' => [
],
'priority' => 123
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$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 := "http://api.gu1.ai/data-lists/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
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("http://api.gu1.ai/data-lists/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}")
.asString();require 'uri'
require 'net/http'
url = URI("http://api.gu1.ai/data-lists/{id}")
http = Net::HTTP.new(url.host, url.port)
request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"description\": \"<string>\",\n \"type\": \"<string>\",\n \"source\": \"<string>\",\n \"config\": {},\n \"fieldMappings\": {},\n \"priority\": 123\n}"
response = http.request(request)
puts response.read_bodyOverview
Updates metadata for a list you are allowed to edit. Changingname or description updates what operators see in the dashboard (labels and detail text); it does not change matching behavior. Global lists: only name and description may be changed, and only by system administrators.
Endpoint
PATCH https://api.gu1.ai/data-lists/{id}
Authentication
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
Request Body
All fields optional; send only what changes:string
1β200 characters. Shown in the dashboard for identification.
string
Max 1000 characters. Shown where the app displays list details (internal context for your team).
string
List type enum (same as create).
string
Source enum (same as create).
object
Same shape as create (
autoSync, syncFrequency, externalUrl, visibleItemDataColumns, etc.).object
String map.
number
1β100.
Response
200 with updated list payload on success; 403/401 when attempting restricted changes on global lists.Was this page helpful?
βI