Skip to main content
PATCH
/
api
/
apps
/
{app_id}
/
collections
/
{collection_id}
cURL
curl --request PATCH \
  --url https://api.example.com/api/apps/{app_id}/collections/{collection_id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "api_config": {
    "authentication": "None",
    "base_url": "<string>",
    "query_mapping": {
      "field_mappings": {},
      "method": "<string>",
      "path_template": "<string>"
    },
    "response_mapping": {
      "field_mappings": {},
      "records_path": "<string>"
    }
  },
  "collection_type": "<string>",
  "default_sort_column": "<string>",
  "description": "<string>",
  "public": true,
  "retention_days": 1
}
'

Path Parameters

​
app_id
string
required

Application ID

​
collection_id
string
required

Collection ID or name

Body

application/json

Update collection properties PATCH /api/apps/:app_id/collections/:collection_name

​
api_config
object

API configuration (for API and Hybrid collections)

​
collection_type
string | null

Collection type: "local", "offline", "api", or "hybrid"

​
default_sort_column
string | null

Default sort column

​
description
string | null

Collection description

​
public
boolean | null

Whether the collection is publicly accessible through auto-generated endpoints

​
retention_days
integer<int32> | null

Data retention period in days (None = permanent)

Required range: x >= 0

Response

Collection updated successfully