Set a Setting's value.

Parameters

name

The Setting you want to set.

Default valid values:

  • 'appointment-statuses',
  • 'customer-results-long',
  • 'restrict-appointment-selection',
  • 'disable-appointment-time-in-progress-update',
  • 'timeline-template'.

If Mantis integration is enabled:

  • 'issuetracker-mantis_wsdl',
  • 'issuetracker-mantis_username',
  • 'issuetracker-mantis_password'.

If Xero integration is enabled:

  • 'xero_consumer_key',
  • 'xero_consumer_password',
  • 'xero_api_endpoint_url',
  • 'xero_rsa_public_key'.

If Quickbooks integration is enabled:

  • 'quickbooks_consumer_key',
  • 'quickbooks_consume_password',
  • 'quickbooks_app_token'.

If SMS integration is enabled:

  • 'sms-appointment_create',
  • 'sms-appointment_create_text',
  • 'sms-appointment_hours_before',
  • 'sms-appointment_hours_before_num',
  • 'sms-appointment_hours_before_text',
  • 'sms-appointment_on_route',
  • 'sms-appointment_on_route_text'.

value

The value that you want to set the Setting to.

Example

FM_api('Setting_set', ['name' => 'appointment-statuses', 'value' => 'This would be the value.']);

Result

On Success

{'ok':1}

On Failure

{'error':'refused'}