Skip to main content
POST
/
api
/
end_user_enrichers
/
{end_user_heron_id}
/
enrich
Trigger enricher execution for a specific end user
curl --request POST \
  --url https://app.herondata.io/api/end_user_enrichers/{end_user_heron_id}/enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "enricher_name": "industry_prediction"
}
'
{
  "enriched_at": "2023-11-07T05:31:56Z",
  "enricher_name": "<string>",
  "result": {}
}

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
end_user_heron_id
string
required

The Heron ID of the end user to enrich

Body

application/json
​
enricher_name
string
required

The name of the enricher to execute

Example:

"industry_prediction"

Response

200 - application/json

Enricher executed successfully

​
enriched_at
string<date-time>
required
​
enricher_name
string
required
​
status
enum<string>
required
Available options:
succeeded,
failed,
processing,
missing_input_data
​
result
object