Update a data source

PUT

api

data_sources

{heron_id}

curl --request PUT \
  --url https://app.herondata.io/api/data_sources/{heron_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "is_enabled": true
}'

{
  "created": "2025-01-21T17:08:55.724361",
  "data_source_accounts": [
    {
      "account_id": "202348",
      "anomaly_score": 200,
      "enabled": true,
      "max_date": "2022-01-31",
      "min_date": "2022-01-01",
      "num_transactions": 120,
      "transactions_match_balances": true
    }
  ],
  "heron_id": "dso_9Mfqdsdzq8pyqVK3XmpadH",
  "is_enabled": true,
  "last_updated": "2025-03-04T17:08:55.724391",
  "metadata": {
    "filename": "202348_JAN_2022.pdf",
    "status": "processed"
  },
  "reference_id": "pdf_4WfEaPArLwRDerupgZHgF7",
  "status": "new",
  "type": "pdf"
}

Authorizations

Authorization

string

header

required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

heron_id

string

required

Body

application/json

is_enabled

boolean

default:true

Whether or not the data source is enabled. If disabled, hides related transactions from analytics

Example:

true

Response

200 - application/json

created

string

required

When the data source was created in Heron system

Example:

"2025-01-21T17:08:55.724361"

data_source_accounts

object[]

required

List of data source accounts associated with the data source

data_source_accounts.is_enabled

boolean

required

Whether or not the account is enabled. If disabled, hides related transactions from analytics

Example:

true

data_source_accounts.account_id

string

Unique account id associated with the data source account

Example:

"202348"

data_source_accounts.anomaly_score

integer

For pdf bank statement account sources, where the value is between 0 and 1000, with 1000 being the most anomalous

Example:

200

data_source_accounts.balances

object[]

List of balances associated with the account

Example:

[
  {
    "closing_amount": 25000.45,
    "currency": "USD",
    "date": "2022-01-01"
  }
]

data_source_accounts.currency

string

Currency of the account

Example:

"USD"

data_source_accounts.end_date

string

End date of the account

Example:

"2022-01-31"

data_source_accounts.heron_id

string

Unique ID for data source generated by Heron

Example:

"dso_VkXCAcNymkrsLYnhbH76dC"

data_source_accounts.institution_name

string

Name of the institution

Example:

"Chase"

data_source_accounts.max_date

string

Latest date of transactions associated with the data source account

Example:

"2022-01-31"

data_source_accounts.min_date

string

Earliest date of transactions associated with the data source account

Example:

"2022-01-01"

data_source_accounts.name

string

Name of the account

Example:

"Checking Account"

data_source_accounts.num_transactions

integer

Number of transactions associated with the data source account

Example:

120

data_source_accounts.number

string

Number of the account

Example:

"123456789"

data_source_accounts.owner_name

string

Name of the account owner

Example:

"John Doe"

data_source_accounts.reference_id

string

This is the account ID provided as part of the transaction

Example:

"account-202348"

data_source_accounts.start_date

string

Start date of the account

Example:

"2022-01-01"

data_source_accounts.transactions_match_balances

boolean

For pdf bank statements, represents whether all transactions extracted match the balances extracted

Example:

true

data_source_accounts.type

string

Type of the account

Example:

"Checking"

Example:

[
  {
    "account_id": "202348",
    "anomaly_score": 200,
    "enabled": true,
    "max_date": "2022-01-31",
    "min_date": "2022-01-01",
    "num_transactions": 120,
    "transactions_match_balances": true
  }
]

heron_id

string

required

Unique ID for data source generated by Heron

Example:

"dso_9Mfqdsdzq8pyqVK3XmpadH"

last_updated

string

required

When the data source was last updated in Heron system

Example:

"2025-03-04T17:08:55.724391"

reference_id

string

required

Unique ID to identify the data source

Example:

"pdf_4WfEaPArLwRDerupgZHgF7"

type

enum<string>

required

Data source type

Available options:

api,

csv,

pdf,

integration_link,

legacy,

legacy_pdf,

legacy_integration_link

Example:

"pdf"

is_enabled

boolean

default:true

Whether or not the data source is enabled. If disabled, hides related transactions from analytics

Example:

true

metadata

object

Metadata associated with the data source

Example:

{
  "filename": "202348_JAN_2022.pdf",
  "status": "processed"
}

status

enum<string>

Status of the data source entity, where applicable (e.g. pdfs, integration links)

Available options:

new,

parsing,

parsed,

processed,

human_reviewing,

approved,

rejected,

failed,

transactions_loaded,

transactions_unloaded,

pending,

active,

syncing,

erroring,

sync_disabled,

deleted_in_plaid,

unknown

Example:

"new"

Was this page helpful?

Update a data source account Get data source account summary

curl --request PUT \
  --url https://app.herondata.io/api/data_sources/{heron_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "is_enabled": true
}'

{
  "created": "2025-01-21T17:08:55.724361",
  "data_source_accounts": [
    {
      "account_id": "202348",
      "anomaly_score": 200,
      "enabled": true,
      "max_date": "2022-01-31",
      "min_date": "2022-01-01",
      "num_transactions": 120,
      "transactions_match_balances": true
    }
  ],
  "heron_id": "dso_9Mfqdsdzq8pyqVK3XmpadH",
  "is_enabled": true,
  "last_updated": "2025-03-04T17:08:55.724391",
  "metadata": {
    "filename": "202348_JAN_2022.pdf",
    "status": "processed"
  },
  "reference_id": "pdf_4WfEaPArLwRDerupgZHgF7",
  "status": "new",
  "type": "pdf"
}

API Reference

Categories

CrmIntegrations

EndUserDataSourceAccounts

EndUserDataSources

EmailTemplates

EndUsers

EndUserEmails

EndUserEntity

EndUserFiles

EndUserCalculations

EndUserAttributes

EnrichmentFeedback

EndUserFinancials

EndUserRules

Integrations

EndUserIntegrations

ISOApplication

EndUserAccounts

EnrichedTransactions

Transactions

Policy

Testing

Merchants

Rules

ParsedEndUserSubmission

Users

Webhooks

Update a data source

Authorizations

Path Parameters

Body

Response