Skip to main content
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
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.gu1.ai/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

Updates metadata for a list you are allowed to edit. Changing name 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:
​
name
string
1–200 characters. Shown in the dashboard for identification.
​
description
string
Max 1000 characters. Shown where the app displays list details (internal context for your team).
​
type
string
List type enum (same as create).
​
source
string
Source enum (same as create).
​
config
object
Same shape as create (autoSync, syncFrequency, externalUrl, visibleItemDataColumns, etc.).
​
fieldMappings
object
String map.
​
priority
number
1–100.

​
Response

200 with updated list payload on success; 403/401 when attempting restricted changes on global lists.