PUT /api/v1/enterprise/settings

Update all enterprise settings in one request. The request should contain an array of settings with their keys, values, labels, and help texts. The keys must match the existing settings in the database. This endpoint allows for bulk updating of settings, making it efficient for managing multiple settings at once.

application/json

Body

  • settings array[object] Required

    list of settings to update

    Hide settings attributes Show settings attributes object
    • key string

      the key of the setting

    • value string

      the value of the setting

    • label string | null

      the label of the setting (optional|nullable)

    • help_text string | null

      the help text of the setting (optional|nullable)

PUT /api/v1/enterprise/settings
curl \
 --request PUT 'https://api.plannrcrm.com/api/v1/enterprise/settings' \
 --header "Authorization: Bearer $ACCESS_TOKEN" \
 --header "Content-Type: application/json" \
 --data '{"settings":[{"key":"some_setting_key","label":"A Setting","value":"#ffffff","help_text":"This is some help text for the setting."}]}'
Request examples
{
  "settings": [
    {
      "key": "some_setting_key",
      "label": "A Setting",
      "value": "#ffffff",
      "help_text": "This is some help text for the setting."
    }
  ]
}