curl --request PUT \
--url https://app.herondata.io/api/end_users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_user": {
"end_user_id": "70b476cf-992c-4724-a124-71c42805c530",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-20T13:14:52.217646",
"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": "70b476cf-992c-4724-a124-71c42805c530",
"heron_id": "eus_YYjLQupmCW3XreFTjUCxQi",
"is_portfolio": true,
"last_processed_at": "2025-08-01T13:14:52.217891",
"last_updated": "2025-08-01T13:14:52.217673",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Confirm an end user is ready for async processing by sending a status of “ready”. The end_user_id
must have previously been sent with at least one Transaction if attempting to update the status.
curl --request PUT \
--url https://app.herondata.io/api/end_users \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '{
"end_user": {
"end_user_id": "70b476cf-992c-4724-a124-71c42805c530",
"is_portfolio": true,
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}'
{
"end_user": {
"confidence": 0.42,
"created": "2025-06-20T13:14:52.217646",
"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": "70b476cf-992c-4724-a124-71c42805c530",
"heron_id": "eus_YYjLQupmCW3XreFTjUCxQi",
"is_portfolio": true,
"last_processed_at": "2025-08-01T13:14:52.217891",
"last_updated": "2025-08-01T13:14:52.217673",
"name": "Company Name Inc.",
"profit_and_loss_layout": "<any>",
"status": "ready"
}
}
Dictionary representing an EndUser
The body is of type object
.
OK
The response is of type object
.
Was this page helpful?