Skip to main content
PATCH
/
api
/
end_user_entities
/
{heron_id}
Update an end user entity
curl --request PATCH \
  --url https://app.herondata.io/api/end_user_entities/{heron_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "display_order": 123,
  "entity_description": "<string>",
  "entity_name": "<string>",
  "entity_post_processor_configs": [
    {}
  ],
  "is_list": true,
  "saved_query_heron_id": "<string>"
}
'
import requests

url = "https://app.herondata.io/api/end_user_entities/{heron_id}"

payload = {
    "display_order": 123,
    "entity_description": "<string>",
    "entity_name": "<string>",
    "entity_post_processor_configs": [{}],
    "is_list": True,
    "saved_query_heron_id": "<string>"
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)
const options = {
  method: 'PATCH',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    display_order: 123,
    entity_description: '<string>',
    entity_name: '<string>',
    entity_post_processor_configs: [{}],
    is_list: true,
    saved_query_heron_id: '<string>'
  })
};

fetch('https://app.herondata.io/api/end_user_entities/{heron_id}', 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_user_entities/{heron_id}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'display_order' => 123,
    'entity_description' => '<string>',
    'entity_name' => '<string>',
    'entity_post_processor_configs' => [
        [
                
        ]
    ],
    'is_list' => true,
    'saved_query_heron_id' => '<string>'
  ]),
  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_user_entities/{heron_id}"

	payload := strings.NewReader("{\n  \"display_order\": 123,\n  \"entity_description\": \"<string>\",\n  \"entity_name\": \"<string>\",\n  \"entity_post_processor_configs\": [\n    {}\n  ],\n  \"is_list\": true,\n  \"saved_query_heron_id\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.herondata.io/api/end_user_entities/{heron_id}")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"display_order\": 123,\n  \"entity_description\": \"<string>\",\n  \"entity_name\": \"<string>\",\n  \"entity_post_processor_configs\": [\n    {}\n  ],\n  \"is_list\": true,\n  \"saved_query_heron_id\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://app.herondata.io/api/end_user_entities/{heron_id}")

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

request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"display_order\": 123,\n  \"entity_description\": \"<string>\",\n  \"entity_name\": \"<string>\",\n  \"entity_post_processor_configs\": [\n    {}\n  ],\n  \"is_list\": true,\n  \"saved_query_heron_id\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
{
  "display_order": 123,
  "entity_description": "<string>",
  "entity_name": "<string>",
  "entity_post_processor_configs": [],
  "heron_id": "<string>",
  "is_list": true,
  "saved_query_heron_id": "<string>"
}

Authorizations

x-api-key
string
header
required

Path Parameters

heron_id
string
required

Body

application/json
display_order
integer
entity_description
string
entity_name
string
entity_post_processor_configs
object[]
is_list
boolean
saved_query_heron_id
string | null

Response

200 - application/json

OK

display_order
integer
entity_description
string
entity_name
string
entity_post_processor_configs
object[]
heron_id
string
is_list
boolean
saved_query_heron_id
string | null