Skip to content

HubSpot: Data sources schemas

4 HubSpot schemas with complete fields and constraints.

← Data sources operations · All schemas

Changes display-name of a datasource — request body — body

FieldTypePresenceDescription and constraints
$objectRoot
datasourceNamestringRequired within parentNew name of datasource. Name cannot be used by another datasource.

Retrieve data source — response body

FieldTypePresenceDescription and constraints
$objectRoot
columnsarrayRequired within parentAn array of FileColumn objects representing the columns in the data source.
columns[]ModelEach itemExpand Retrieve data source — response body — columns item
createdAtstringRequired within parentThe creation date and time of the data source, represented as a string.
datasourceIdstringRequired within parentThe unique identifier for the data source, represented as a 64-bit integer.
datasourceNamestringRequired within parentThe name of the data source, represented as a string.
datasourceTypestringRequired within parentThe type of the data source, which is a string with a valid value of 'FILE'.
Known values: FILE, JSON
lastIngestionStatusstringRequired within parentThe status of the last data ingestion process, represented as a string. Valid values include 'SUCCESSFUL', 'IN_PROGRESS', and 'FAILED'.
Known values: FAILED, IN_PROGRESS, SUCCESSFUL

Referenced models: Retrieve data source — response body — columns item

Retrieve data source — response body — columns item

FieldTypePresenceDescription and constraints
$objectRoot
namestringRequired within parentThe name of the column, represented as a string.
typestringRequired within parentThe data type of the column, represented as a string.

Update data source — response body

FieldTypePresenceDescription and constraints
$objectRoot
createdAtstringOptionalTimestamp when the datasource was created.
datasourceIdstringRequired within parentThe unique identifier for the data source. It is an integer formatted as int64.
datasourceNamestringRequired within parentThe name of the data source. It is a string.
previewLinkstringRequired within parentA URL string that provides a preview link for the data source.
updatedAtstringOptionalTimestamp when the datasource was updated.

Report an issue with this page

Necessary

Required for sign-in, security, authorization, and remembering your choices.

Always active

Analytics

Helps us understand which product and documentation features are useful.

Performance diagnostics

Uses performance tracing and privacy-masked session replay to diagnose problems.

You can change these choices at any time from Cookie settings.