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"
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}"
payload = {
"name": "My Portfolio (updated)",
"description": "Updated Q1 2026 watchlist"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My Portfolio (updated)', description: 'Updated Q1 2026 watchlist'})
};
fetch('https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_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 => "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_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' => 'My Portfolio (updated)',
'description' => 'Updated Q1 2026 watchlist'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}"
response = http.request(request)
puts response.read_body{
"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,
"entity_status_breakdown": {
"ready": 4
},
"health_score": 100,
"health_breakdown": {
"company": 100
},
"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"
}{
"detail": "X-API-Key header is required for this endpoint"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Update dataset
Updates the name or description of a 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"
}
'import requests
url = "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}"
payload = {
"name": "My Portfolio (updated)",
"description": "Updated Q1 2026 watchlist"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({name: 'My Portfolio (updated)', description: 'Updated Q1 2026 watchlist'})
};
fetch('https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_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 => "https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_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' => 'My Portfolio (updated)',
'description' => 'Updated Q1 2026 watchlist'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}"
payload := strings.NewReader("{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
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://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://catchall.newscatcherapi.com/catchAll/datasets/{dataset_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"My Portfolio (updated)\",\n \"description\": \"Updated Q1 2026 watchlist\"\n}"
response = http.request(request)
puts response.read_body{
"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,
"entity_status_breakdown": {
"ready": 4
},
"health_score": 100,
"health_breakdown": {
"company": 100
},
"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"
}{
"detail": "X-API-Key header is required for this endpoint"
}{
"detail": "Invalid API key"
}{
"detail": "Invalid API key"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Authorizations
API key for authentication.
Path Parameters
Unique dataset identifier.
Body
Response
Full dataset object with metadata and current status.
Unique identifier of the dataset.
"ccabb755-afc2-4047-b84c-78d1f23d49b2"
Organization that owns this dataset.
"e5d9e9b0-e415-4941-8ef0-916c5ee56207"
Dataset name.
"My Portfolio"
Optional description.
"Companies in our investment portfolio"
Total number of entities in this dataset.
4
Count of entities grouped by processing status. Keys are status values
(ready, pending, enriching, failed); values are entity counts.
Show child attributes
Show child attributes
{ "ready": 4 }
Overall health score of the dataset, from 0 to 100. Reflects how many entities have sufficient identifying information for reliable matching.
100
Health scores broken down by entity type. Keys are entity types
(e.g. company); values are scores from 0 to 100.
Show child attributes
Show child attributes
{ "company": 100 }
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.
pending, enriching, ready, failed ID of the user who created this dataset.
"870e258e-12ec-4a47-8656-e7a43b0265b3"
ISO 8601 timestamp of when the dataset was created. Returned without timezone offset (server-local time).
"2026-04-08T15:21:36.026993"
ISO 8601 timestamp of when the dataset was last updated. Returned without timezone offset (server-local time).
"2026-04-08T15:21:38.401148"
Was this page helpful?

