Skip to main content
POST
UpdateDatasetSchemaAPI updates a dataset's schema (add/remove/rename columns,

Authorizations

Authorization
string
header
required

An Erdo API key (erdo_api_...) or scoped token (erdo_token_...).

Path Parameters

datasetSlug
string
required

Body

application/json
class
string

(analysis by-product, hidden from listings by default). Omit to leave the class unchanged. Use this to promote a durable table that was mistakenly filed as scratch, or to demote one. A class-only update needs no operations.

clear_purpose
boolean

an empty one are the same value, so "leave it alone" and "take it away" need distinct fields to stay distinguishable.

dataset_slug
string
operations
UpdateSchemaOperation describes a single schema modification. · object[]
purpose
string

ClearPurpose removes one. Correcting a purpose has to be possible: it is the org's answer to "which dataset holds this kind of data", so one stamped on the wrong dataset points every consumer that resolves through the vocabulary at the wrong rows.

purpose_description
string

purpose is new to the org; ignored when an entry already exists.

Response

Success response

class
string

'scratch'; empty for an unclassified legacy row left unchanged).

columns_added
integer<int64>
columns_removed
integer<int64>
columns_renamed
integer<int64>
columns_retyped
integer<int64>
contract_reconciled_columns
string[]

because the stored file already had them and the contract did not — the drift a promotion to table class would otherwise turn into a write refusal.

current_columns
string[]
purpose
string

it carries none.

warnings
string[]

already has other dataset(s) carrying it, named by slug.