Skip to main content
PATCH
Update dataset

Authorizations

Authorization
string
header
required

OAuth2 Authorization Code flow

Path Parameters

idOrSlug
string
required

Dataset ID or slug

Body

application/json
name
string

Dataset name

slug
string

Dataset slug

description
string

Dataset description

instructions
string

Instructions to interpret dataset data

status
enum<string>

Dataset status

Available options:
draft,
active,
deprecated,
maintenance,
archived
availability
enum<string>

Dataset availability

Available options:
disabled,
general_availability
targetTypes
enum<string>[]

Dataset target types

Available options:
company,
person,
vehicle,
address,
phone,
email,
property,
lawsuit,
product
location
string

Dataset location/endpoint

price
number

Dataset price

Required range: x >= 0
price_currency
string

Price currency

Whether dataset is featured

allowMock
boolean

Whether mock mode is allowed for this dataset

input_schema
object

Input schema for the dataset

request_schema
object

Request schema

response_schema
object

Response schema

provider_request_schema
object

Original provider OpenAPI request schema (raw, pre-envelope)

provider_response_schema
object

Original provider OpenAPI response schema (raw, pre-envelope)

request_example
object

Request example

response_example
object

Response example

request_envelope
string

Request envelope

response_envelope
string

Response envelope

status_check
string

JSONata healthcheck expression evaluated against raw provider response. Returns { ok, code, message }.

usecases
string[]

Use cases

output_fields
string[]

Output fields

categories
string[]

Dataset category facets

collections
string[]

Dataset collection facets

metadata
object

Additional metadata

upstreams
string[]

Upstream IDs or slugs

provider
string

Provider ID or slug

meteredEvents
string[]

Stripe metered events emitted for each billable query on this dataset

country
string

Country code

freshness
string
ingestionCadence
string
steps
object

Legacy step configurations

Response

200 - application/json
object
string
required

Object type

Example:

"page"

id
string
required

Unique identifier

Example:

"p_abc123"

createdAt
string<date-time>
required

Creation timestamp

Example:

"2024-01-15T10:30:00.000Z"

updatedAt
string<date-time>
required

Last update timestamp

Example:

"2024-01-15T14:45:00.000Z"

status
string
required

Dataset status

Example:

"active"

availability
enum<string>
required

Dataset availability

Available options:
disabled,
general_availability
Example:

"general_availability"

name
string
required

Dataset name

Example:

"Brazilian Companies Registry"

orgId
string
required

Owning organization id

Example:

"org_abc123"

slug
string
required

URL-friendly slug

Example:

"brazilian-companies"

country
string
required

Country code

Example:

"BR"

description
string | null
required

Dataset description

price
number
required

Price per query in cents

Example:

50

customPrice
boolean
required

Whether the returned price comes from billing configuration instead of the dataset row

Example:

false

priceCurrency
string
required

Price currency code

Example:

"USD"

meteredEvents
string[]
required

Stripe metered events emitted for each billable query on this dataset

Example:
queryMode
enum<string>
required

Default query mode before organization settings are applied

Available options:
always,
manual,
hidden
Example:

"manual"

provider
object | null
required
freshness
string | null
required

Data freshness description

targetTypes
string[]
required

Dataset target types

Example:

Whether dataset is featured

Example:

false

allowMock
boolean
required

Whether mock mode is allowed for this dataset

Example:

true

inputSchema
object
required

JSON Schema describing the allowed input parameters for queries to this dataset.

requestSchema
object | null
required

Internal request schema used to map canonical params to provider-specific format.

responseSchema
object | null
required

JSON Schema describing the structure of the data returned by this dataset.

providerRequestSchema
object | null
required

Original provider OpenAPI request schema (raw, pre-envelope). Source of truth for the JSONata request_envelope mapping.

providerResponseSchema
object | null
required

Original provider OpenAPI response schema (raw, pre-envelope). Source of truth for the JSONata response_envelope mapping.

requestExample
object | null
required

Example request payload for testing or documentation.

responseExample
object | null
required

Example response payload for testing or documentation.

usecases
string[] | null
required
outputFields
string[] | null
required
categories
string[]
required
collections
string[]
required
lastIngestion
string<date-time> | null
required
ingestionCadence
string | null
required
providerAccountProviders
string[]
required

Provider slugs that can use organization-scoped custom credentials for this dataset

requestEnvelope
string | null
required
responseEnvelope
string | null
required
statusCheck
string | null
required

JSONata healthcheck expression evaluated against the raw provider response. Must return { ok, code, message }. Overrides provider.statusCheck when set.

createdBy
Created by · object

Principal who created this object

Example:
updatedBy
Updated by · object

Principal who last updated this object

Example:
ownerOrgName
string | null

Owning organization name

Example:

"Base39"

instructions
string

Instructions to interpret dataset data

location
string

Dataset geographic location

Example:

"South America"

metadata
object
upstreams
object[]
incomingShare
object | null
outgoingShares
object[]