Skip to main content
POST
/
api
/
end_user_files
/
{heron_id}
/
trigger_rename
Trigger file's rename rule
curl --request POST \
  --url https://app.herondata.io/api/end_user_files/{heron_id}/trigger_rename \
  --header 'x-api-key: <api-key>'
{
  "bank_statement": null,
  "created": "2023-11-07T05:31:56Z",
  "email": null,
  "file_class": "<string>",
  "file_source_metadata": {},
  "filename": "<string>",
  "heron_id": "<string>",
  "iso_application": {
    "heron_id": "iso_6hBjQT9k6KP2rLCXwjUJff",
    "processing_status": "processed"
  },
  "num_pages": 123,
  "page_classes": {},
  "parent_heron_id": "<string>",
  "parsed_results": [],
  "processing_error": "<string>",
  "reference_id": "<string>",
  "renamed_filename": "<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

​
heron_id
string
required

The file's heron_id - starting with euf_

Response

200 - application/json

OK

​
bank_statement
object
Example:

null

​
created
string<date-time>
​
email
object
Example:

null

​
file_class
string
​
file_source_metadata
object
read-only
​
filename
string
​
heron_id
string
​
iso_application
object
​
num_pages
integer
​
page_classes
object
​
parent_heron_id
string | null
​
parsed_results
object[]
read-only
​
processing_error
string | null
read-only
​
reference_id
string
​
renamed_filename
string