account::set_notification_settings

Description

Set settings related to balance warning, usage summary and usage level notifications.

Note: all arguments must be provided. Missing arguments will take their default values.

Request details

Arguments

key
API key
balancewarning (boolean)
Enable/disable low balance warning (default: disable)
balancewarninglevel
Balance level, in pence, below which a 'your balance is too low' notification should be sent out (default: none)
monthlysummary (boolean)
Enable/disable monthly usage summary (default: disable)
weeklysummary (boolean)
Enable/disable weekly usage summary (default: disable)
dailysummary (boolean)
Enable/disable daily usage summary (default: disable)
disk90 (boolean)
Enable/disable notifications when hosting accounts reach 90% of their storage limits (default: disable)
disk80 (boolean)
Enable/disable notifications when hosting accounts reach 80% of their storage limits (default: disable)
disk70 (boolean)
Enable/disable notifications when hosting accounts reach 70% of their storage limits (default: disable)
bandwidth90 (boolean)
Enable/disable notifications when hosting accounts reach 90% of their bandwidth limits (default: disable)
bandwidth80 (boolean)
Enable/disable notifications when hosting accounts reach 80% of their bandwidth limits (default: disable)
bandwidth70 (boolean)
Enable/disable notifications when hosting accounts reach 70% of their bandwidth limits (default: disable)

Responses

<?xml version="1.0" encoding="utf-8"?>
<success>true</success>
	

Exceptions

Examples

POST /account/set_notification_settings/
key=acbd18db4cc2f85cedef654fccc4a4d8
&balancewarning=on
&balancewarninglevel=250
&monthlysummary=on
&weeklysummary=on
&dailysummary=off
&disk90=on
&disk80=off
&disk70=off
&bandwidth90=on
&bandwidth80=on
&bandwidth70=off
<?xml version="1.0" encoding="utf-8"?>
<success>true</success>
	

See also

  1. Index
  2. About the API

    1. Summary
    2. Specification
    3. Do not use undocumented features
    4. Change log
  3. Using the API

    1. Requests
      1. Authenticated requests
      2. Limits
      3. Common request value data types
    2. Understanding responses
      1. HTTP status codes used
      2. Exceptions
        1. access
        2. account
        3. database
        4. hostingaccount
        5. server
        6. system
  4. Function reference