ContactInformation
Contact Information
notifications

Set the account's notification preferences.

Use this function to set the logged in cPanel or Webmail account's notification preferences.

Note:

To set a cPanel account's notification email address, call set_email_addresses. To return the list of account notification preferences you can set with set_notification_preferences, call get_notification_preferences.

post/ContactInformation/set_notification_preferences

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Request body

preferencesobject

Response

Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_notification_preferences",
  "module": "ContactInformation",
  "result": {
    "data": [
      {
        "descp": "Someone logs in to my account.",
        "enabled": 1,
        "name": "notify_account_login"
      }
    ],
    "status": 1
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.