Sign in

v2

latestOpenAPI 3.1.0CC-BY-SA 2.02026-07-2617789528.6 KB
Parameters

Create a new property

Create a new global property

put/parameters

Request body

idstring required

Name of the parameter

valuestring string or JSON

Value of the parameter

descriptionstring

Description of the parameter

overridableboolean

Is the global parameter overridable by node

Example request

{
  "id": "rudder_file_edit_footer",
  "value": "### End of file managed by Rudder ###",
  "description": "Default inform message put in footer of managed files by Rudder"
}

Response

Settings

idstring required

Id of the property

result'success' | 'error' required

Result of the request

action'createParameter' required

The id of the action

Example response

{
  "id": "rudder_file_edit_footer",
  "data": {
    "parameters": [
      {
        "id": "rudder_file_edit_footer",
        "value": "### End of file managed by Rudder ###",
        "description": "Default inform message put in footer of managed files by Rudder"
      }
    ]
  }
}