PATCH
/
api
/
end_user_files
/
rename_rules
/
{heron_id}
curl --request PATCH \
  --url https://app.herondata.io/api/end_user_files/rename_rules/{heron_id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '{
  "file_name_template": "<string>",
  "is_enabled": true,
  "variables": [
    {
      "description": "<string>",
      "examples": [
        "<string>"
      ],
      "key": "<string>",
      "name": "<string>"
    }
  ]
}'
{
  "end_user_file_class": "<string>",
  "file_name_template": "<string>",
  "heron_id": "<string>",
  "is_enabled": true,
  "variables": [
    {
      "description": "<string>",
      "examples": [
        "<string>"
      ],
      "key": "<string>",
      "name": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
heron_id
string
required

The unique identifier of the rename rule.

Body

application/json
​
file_name_template
string
required
​
is_enabled
boolean
required
​
variables
object[]
required

Response

200 - application/json
The updated file rename rule
​
end_user_file_class
string
required
​
file_name_template
string
required
​
is_enabled
boolean
required
​
variables
object[]
required
​
heron_id
string

Was this page helpful?