PUT /api/settings/:id
Update a setting

Examples

PUT /api/settings/login_text
{
  "setting": {
    "value": ""
  }
}
200
{
  "description": "Text to be shown in the login-page footer. Keyword $VERSION is replaced by current version.",
  "settings_type": "string",
  "default": "Version $VERSION",
  "updated_at": "2022-09-06 15:06:02 UTC",
  "id": "login_text",
  "name": "login_text",
  "full_name": "Login page footer text",
  "value": "",
  "category": "general",
  "category_name": "General",
  "readonly": false,
  "config_file": null,
  "encrypted": false,
  "select_values": null
}

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 a String
setting
required

Validations:

  • Must be a Hash
setting[value]
optional

Validations:

  • Must be a String