CrmIntegrations
Patch a CRM integration
API Reference
Categories
EndUserDataSourceAccounts
EndUsers
- GETGet EndUser emails
- GETList EndUsers
- PUTUpdate EndUser
- POSTCreate EndUser
- GETList EndUsers with Summary Information
- GETGet EndUser by heron_id or end_user_id
- DELDelete EndUser by heron_id or end_user_id
- GETGet EndUser emails
- GETGet EndUser information
- PATCHPatch EndUser information
- POSTEnrich transactions of EndUser
- GETGet EndUser physical location
- GETRetrieve CRM sync events for an end user
- POSTTrigger a CRM Sync for an End User
EndUserEmails
EndUserEnricherFields
EndUserEntity
- GETGet the definitions for all end user entities
- POSTCreate an end user entity
- PATCHSet the display order of end user entities
- POSTCreate an end user entity attribute
- PATCHSet the display order of end user entity attributes
- DELDelete an EndUserEntityAttribute
- PATCHUpdate an end user entity
- POSTCreate an end user entity attribute
- POSTCreate an end user entity attribute source
- DELDelete an EndUserEntityAttribute
- PATCHUpsert an end user entity
- DELDelete an EndUserEntity
- PATCHUpdate an end user entity
- GETGet the materialised end user entities for an end user
- POSTUpsert the attribute value for an end user entity attribute source
EndUserFiles
- GETAll EndUserFiles
- GETGet recent files by file class
- GETGet file rename rules
- POSTCreate a file rename rule
- GETGet file rename rule variable slugs
- PATCHUpdate a file rename rule
- PATCHUpdate the end user file's class
- GETGet EndUserFile as a base64 string
- POSTTrigger async parsing of an end user file
- PATCHUpdate Parsed Results
- GETGet parsed results from uploaded files
- POSTTrigger file's rename rule
- POSTTrigger splitting a combined end user file into its child files based on its page_classes
- GETGet EndUserFiles
- POSTPost EndUserFile
- GETDownload EndUserFiles
- GETDownload xlsx of parsed results from uploaded files
FileClass
EndUserCalculations
- GETGet EndUser balance
- GETGet EndUser forecasts
- GETGet EndUser statistics
- GETRun industry classification on end user files
- GETGet EndUser anomalies
- GETGet EndUser bank statement summary
- GETGet EndUser metric benchmarks
- GETExport as a spreadsheet
- GETGet EndUser transactions grouped by counterparty or merchant
- GETGet EndUser Heron Score (beta)
- GETGet EndUser merchant summary
- GETGet EndUser named dates
- GETGet EndUser cashflow P&L
- PUTUpdate EndUser P&L layout
- GETGet EndUser recurring transactions report
- GETGet EndUser scorecard
- POSTRequest EndUser scorecard
- GETGet EndUser transaction data coverage
EndUserAttributes
EnrichmentFeedback
EndUserFinancials
EndUserRules
Integrations
- POSTSend a Finicity Connect email to an end user
- POSTTrigger a cashflow report generation for an end user
- POSTTrigger a statement reports generation for an end user
- POSTTrigger a Finicity VOE transactions report generation for an end user
- PUTUpdate an Integration Link
- GETList Integrations
- POSTCreate an integration
- PUTUpdate Integration
- GETGet IntegrationLinks by Integration
- POSTCreate an integration Link
- DEL(Soft-)Delete an integration link
- POSTRefresh an IntegrationLink
EndUserIntegrations
- POSTUpload Inscribe
- GETGet Integration Links
- POSTUpload Ocrolus
- GETGet PDFs
- POSTParse all PDF
- POSTUpload PDF
- POSTUpload Plaid assets
- POSTUpload Plaid transactions
- POSTUpload Yodlee
- PUTUpdate PDF attributes including status
- PATCHSend patch transactions for a pdf statement
- POSTReloads transactions for a pdf
- POSTUnloads transactions for a pdf
ISOApplication
- POSTUpload an ISO application PDF for for an end user
- GETGet EndUser ISO Applications
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds
- POSTUpload an ISO application PDF for automated scrubbing in under 15 seconds (base64)
- POSTReprocess a single ISO application
- GETGet the scrubbed results and data validations of an uploaded ISO application by its heron_id (prefixed "iso_")
EndUserAccounts
EnrichedTransactions
Transactions
Merchants
ParsedEndUserSubmission
UserMerchantGroups
Users
CrmIntegrations
Patch a CRM integration
patch a CRM integration
PATCH
/
api
/
crm_integrations
/
{heron_id}
curl --request PATCH \
--url https://app.herondata.io/api/crm_integrations/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"auth": {},
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce",
"secret": "<string>"
}'
{
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"heron_id": "<string>",
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce"
}
Authorizations
Path Parameters
Body
application/json
Response
200 - application/json
Ok
The response is of type object
.
Was this page helpful?
curl --request PATCH \
--url https://app.herondata.io/api/crm_integrations/{heron_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"auth": {},
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce",
"secret": "<string>"
}'
{
"config": {
"data_source_accounts_config": {
"description": "A company or person",
"external_lookup_config": {
"external_lookup_fields_and": [
"<string>"
],
"external_lookup_fields_or": [
"<string>"
],
"sort_field_name": "CreatedDate",
"sort_order": "ASC"
},
"external_name": "Account",
"field_mappings": [
{
"external_lookup_field_name": "<string>",
"external_object_name_for_id": "Account",
"field_name": "Name",
"heron_company_attribute_label": "owner_1_first_name",
"max_length": 255,
"overwrite_on_update": true,
"regex_remove": "pattern",
"required": true,
"static_value": "static value",
"static_value_key": "date_today",
"value_mapping_name": "state",
"value_type": "Text"
}
],
"is_optional": false,
"key": "Account",
"required_ids": [
{
"alias": "Company",
"external_name": "Account"
}
],
"static_data": [
{
"key": "status",
"value": "<any>"
}
]
},
"default_id": {
"alias": "Company",
"external_name": "Account"
},
"object_configs": [],
"policy_evaluation_config": {
"external_object_name": "Opportunity",
"failure_reason_external_name": "Failure_Reason__c",
"result_external_name": "Submission_Result_from_Heron__c"
},
"sync_file_classes": {},
"value_mappings": []
},
"failure_notification_channel": null,
"heron_id": "<string>",
"instance_url": "https://sandbox.salesforce.com",
"is_enabled": true,
"is_live": true,
"provider": "salesforce"
}