curl --request POST \
--url https://app.herondata.io/api/end_users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_user": {
"crm_sync_result": {
"crm_record_url": "<string>",
"error_message": "<string>",
"heron_id": "<string>",
"name": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"result": "success"
},
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"files": [
{
"file_class": "<string>",
"filename": "<string>",
"heron_id": "<string>",
"renamed_filename": "<string>"
}
],
"is_portfolio": true,
"name": "Company Name Inc.",
"policy_evaluations": [
"passed"
],
"profit_and_loss_layout": "<any>"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-09T21:52:58.632691",
"criteria": [
{
"context": "higher_is_better",
"currency": "<string>",
"date_range": "last_180_days",
"description": "The number of unique transactions with a timestamp",
"group": "data_quality",
"label": "unique_transactions",
"status": "not_available",
"unit": "n",
"value": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"is_portfolio": true,
"last_processed_at": "2025-07-21T21:52:58.632901",
"last_updated": "2025-07-21T21:52:58.632720",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Create a new end user. If transactions have previously been sent for this end_user_id
, use PUT end_users
to update instead.
curl --request POST \
--url https://app.herondata.io/api/end_users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_user": {
"crm_sync_result": {
"crm_record_url": "<string>",
"error_message": "<string>",
"heron_id": "<string>",
"name": "<string>",
"occurred_at": "2023-11-07T05:31:56Z",
"provider": "<string>",
"result": "success"
},
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"files": [
{
"file_class": "<string>",
"filename": "<string>",
"heron_id": "<string>",
"renamed_filename": "<string>"
}
],
"is_portfolio": true,
"name": "Company Name Inc.",
"policy_evaluations": [
"passed"
],
"profit_and_loss_layout": "<any>"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-09T21:52:58.632691",
"criteria": [
{
"context": "higher_is_better",
"currency": "<string>",
"date_range": "last_180_days",
"description": "The number of unique transactions with a timestamp",
"group": "data_quality",
"label": "unique_transactions",
"status": "not_available",
"unit": "n",
"value": "<any>"
}
],
"data_sources": [
{
"status": "new",
"type": "pdf"
}
],
"end_user_id": "e4be922c-f69f-474c-8e3d-b20aafb38398",
"heron_id": "eus_82aJ3W55xESAbaF7mF5pZX",
"is_portfolio": true,
"last_processed_at": "2025-07-21T21:52:58.632901",
"last_updated": "2025-07-21T21:52:58.632720",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
OK
The response is of type object
.
Was this page helpful?