Skip to main content
PATCH
/
catchAll
/
datasets
/
{dataset_id}
Update dataset
curl --request PATCH \
  --url https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "name": "My Portfolio (updated)",
  "description": "Updated Q1 2026 watchlist"
}
'
{
  "id": "ccabb755-afc2-4047-b84c-78d1f23d49b2",
  "organization_id": "e5d9e9b0-e415-4941-8ef0-916c5ee56207",
  "name": "My Portfolio",
  "description": "Companies in our investment portfolio",
  "entity_count": 4,
  "latest_status": "ready",
  "created_by_user_id": "870e258e-12ec-4a47-8656-e7a43b0265b3",
  "created_at": "2026-04-08T15:21:36.026993",
  "updated_at": "2026-04-08T15:21:36.027001"
}

Authorizations

​
x-api-key
string
header
required

API key for authentication.

Path Parameters

​
dataset_id
string<uuid>
required

Unique dataset identifier.

Body

application/json

Updates dataset name or description. At least one field should be provided.

​
name
string

Updated dataset name.

Example:

"My Portfolio (updated)"

​
description
string

Updated description.

Example:

"Updated description"

Response

Full dataset object with metadata and current status.

​
id
string<uuid>
required

Unique identifier of the dataset.

Example:

"ccabb755-afc2-4047-b84c-78d1f23d49b2"

​
organization_id
string<uuid>
required

Organization that owns this dataset.

Example:

"e5d9e9b0-e415-4941-8ef0-916c5ee56207"

​
name
string
required

Dataset name.

Example:

"My Portfolio"

​
description
string | null

Optional description.

Example:

"Companies in our investment portfolio"

​
entity_count
integer
default:0

Total number of entities in this dataset.

Example:

4

​
latest_status
enum<string>

Processing status of a dataset.

  • pending: Dataset created, entities queued for enrichment.
  • enriching: Entities are being enriched.
  • ready: All entities enriched and indexed — ready for use in jobs.
  • failed: One or more entity enrichments failed.
Available options:
pending,
enriching,
ready,
failed
​
created_by_user_id
string<uuid>

ID of the user who created this dataset.

Example:

"870e258e-12ec-4a47-8656-e7a43b0265b3"

​
created_at
string<date-time>

ISO 8601 timestamp of when the dataset was created. Returned without timezone offset (server-local time).

Example:

"2026-04-08T15:21:36.026993"

​
updated_at
string<date-time>

ISO 8601 timestamp of when the dataset was last updated. Returned without timezone offset (server-local time).

Example:

"2026-04-08T15:21:38.401148"