Skip to main content
PUT
/
api
/
end_users
Update EndUser
curl --request PUT \
  --url https://app.herondata.io/api/end_users \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '{}'
import requests

url = "https://app.herondata.io/api/end_users"

payload = {}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'PUT',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({})
};

fetch('https://app.herondata.io/api/end_users', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.herondata.io/api/end_users",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://app.herondata.io/api/end_users"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("x-api-key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.put("https://app.herondata.io/api/end_users")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_users")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
{
  "end_user": {
    "end_user_id": "b07cf25e-1ae3-4699-8064-322b0dd33854",
    "confidence": 0.42,
    "created": "2026-05-30T16:07:04.236834",
    "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": 42.42
      }
    ],
    "data_sources": [
      {
        "type": "pdf",
        "status": "new"
      }
    ],
    "heron_id": "eus_WgpXknX2f7wGMkViNykLwi",
    "is_portfolio": true,
    "last_processed_at": "2026-07-11T16:07:04.237130",
    "last_updated": "2026-07-11T16:07:04.236900",
    "meta": {},
    "name": "Company Name Inc.",
    "profit_and_loss_layout": null,
    "status": "ready"
  }
}

Authorizations

x-api-key
string
header
required

Body

application/json

Dictionary representing an EndUser

end_user
object

Callbacks

POST
$yourWebhookUrlonData

Body

application/json

Webhook payload with end_user

created
string<date-time>

When the webhook was fired

data
object

End user details

meta
object | null

Customer-provided metadata from the end user, if any

topic
string

Webhook topic, e.g. end_user.processed

Response

200

Your webhook implementation should return this HTTP status code if the data was received successfully.

Response

200 - application/json

OK

end_user
object