PUT /api/common_parameters/:id
Update a global parameter

Examples

PUT /api/common_parameters/636252244-test
{
  "common_parameter": {
    "name": "special_key",
    "value": "123"
  }
}
200
{
  "created_at": "2021-05-19 07:27:44 UTC",
  "updated_at": "2021-05-19 07:27:52 UTC",
  "hidden_value?": false,
  "hidden_value": "*****",
  "id": 636252244,
  "name": "special_key",
  "parameter_type": "string",
  "value": "123"
}

Params

Param name Description
location_id
optional

Set the current location context for the request

Validations:

  • Must be a Integer
organization_id
optional

Set the current organization context for the request

Validations:

  • Must be a Integer
id
required

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hypen(-) with no leading or trailing space.
common_parameter
required

Validations:

  • Must be a Hash
common_parameter[name]
optional

Validations:

  • Must be a String
common_parameter[value]
optional

Validations:

  • Must be a String
common_parameter[parameter_type]
optional

Type of value

Validations:

  • Must be one of: string, boolean, integer, real, array, hash, yaml, json.
common_parameter[hidden_value]
optional , nil allowed

Validations:

  • Must be one of: true, false.