Skip to main content
POST
/
api
/
end_user_enrichers
/
definitions
/
{enricher_definition_name}
/
start_enrich
Start enricher execution for a specific end user asynchronously
curl --request POST \
  --url https://app.herondata.io/api/end_user_enrichers/definitions/{enricher_definition_name}/start_enrich \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "end_user_heron_id": "eun_abc123"
}
'
{
  "end_user_id": 123,
  "enricher_name": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.herondata.io/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
enricher_definition_name
string
required

The name of the enricher definition to execute

Body

application/json
​
end_user_heron_id
string
required

The Heron ID of the end user to enrich

Example:

"eun_abc123"

Response

Enrichment task dispatched successfully

​
end_user_id
integer
required
​
enricher_name
string
required