cPanel API 2 Functions - CustInfo::contactprefs

Warning:

The cPanel API 2 system is deprecated. We strongly recommend that you use UAPI instead of cPanel API 2.

Description

This function retrieves the account's notification settings.

Warning:

We strongly recommend that you use UAPI instead of cPanel API 2. However, no equivalent UAPI function exists.

Examples

WHM API (JSON)

https://hostname.example.com:2087/cpsess##########/json-api/cpanel?cpanel_jsonapi_user=user&cpanel_jsonapi_apiversion=2&cpanel_jsonapi_module=CustInfo&cpanel_jsonapi_func=contactprefs

Note:

For more information, read our Calls from the WHM API documentation.

LiveAPI PHP Class

$cpanel = new CPANEL(); // Connect to cPanel - only do this once.

// Retrieve the notification settings.
$save_contact = $cpanel->api2(
    'CustInfo', 'contactprefs'
);

Note:

For more information, read our Guide to the LiveAPI System.

LiveAPI Perl Module

my $cpliveapi = Cpanel::LiveAPI->new(); # Connect to cPanel - only do this once.

#  Retrieve the notification settings.
my $save_contact = $cpliveapi->api2(
    'CustInfo', 'contactprefs',
);

Note:

For more information, read our Guide to the LiveAPI System.

cPanel Tag System (deprecated)

Warnings:

cPanel tags are deprecated . We strongly recommend that you only use the LiveAPI system to call the cPanel APIs. Examples are only present in order to help developers move from the old cPanel tag system to our LiveAPI .
cPanel API 2 calls that use cPanel tags vary in code syntax and in their output.
For more information, read our Deprecated cPanel Tag Usage documentation.

Command Line

cpapi2 --user=username CustInfo contactprefs

Notes:

You must URI-encode values.
username represents your account-level username.
You must include the --user=username option.
For more information and additional output options, read our Guide to cPanel API 2 documentation or run the cpapi2 --help command.
If you run CloudLinux™, you must use the full path of the cpapi2 command:
```
/usr/local/cpanel/bin/cpapi2
```

Output (JSON)

 {  
   "cpanelresult":{  
      "apiversion":2,
      "func":"contactprefs",
      "data":[  
         {  
            "value":1,
            "onchangeparent":"",
            "name":"notify_contact_address_change",
            "descp":"My contact email address changes.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"notify_contact_address_change",
            "name":"notify_contact_address_change_notification_disabled",
            "descp":"My preference for contact email address change notifications is disabled.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"",
            "name":"notify_disk_limit",
            "descp":"My account approaches its disk quota.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"",
            "name":"notify_bandwidth_limit",
            "descp":"My account approaches its bandwidth usage limit.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"",
            "name":"notify_email_quota_limit",
            "descp":"Any of my account's email accounts approaches or is over quota.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"",
            "name":"notify_password_change",
            "descp":"My account's password changes.",
            "type":"Boolean",
            "enabled":1
         },
         {  
            "value":1,
            "onchangeparent":"notify_password_change",
            "name":"notify_password_change_notification_disabled",
            "descp":"My preference for account password change notifications is disabled.",
            "type":"Boolean",
            "enabled":1
         }
      ],
      "event":{  
         "result":1
      },
      "module":"CustInfo"
   }
}

Note:

Use cPanel's API Shell interface (cPanel >> Home >> Advanced >> API Shell) to directly test cPanel API calls.

Parameters

This function does not accept parameters.

Returns

Return	Type	Description	Possible values	Example
`enabled`	Boolean	Whether the notification setting is enabled.	`1` — The setting is enabled. `0` — The setting is disabled.	`1`
`onchangeparent`	string	The notification setting to monitor.	`notify_password_change` `notify_contact_address_change`	`notify_password_change`
`value`	string	The notification setting's value.	`1` — The setting is enabled. `0` — The setting is disabled.	`1`
`type`	string	The notification setting's data type.	`Boolean` `string`	`Boolean`
`descp`	string	A notification setting's description.	A string value.	`My contact email address changes.`
`name`	string	The notification setting's name.	A string value.	`notify_disk_limit`
`reason`	string	A reason for failure. This function only returns a `reason` value if it failed.	A string that describes the error.	`This is an error message.`
`result`	Boolean	Whether the function succeeded.	`1` — The function succeeded. `0` — The function failed.	`1`