# cPanel API 2 Functions - CustInfo::contactprefs

Warning:
The cPanel API 2 system is deprecated. We **strongly** recommend that you use [UAPI](/cpanel/introduction) instead of cPanel API 2.

## Description

This function retrieves the account's notification settings.

Warning:
We **strongly** recommend that you use [UAPI](/cpanel/introduction/) instead of cPanel API 2. However, no equivalent UAPI function exists.

## Examples

WHM API (JSON)


```undefined syntaxhighlighter-pre
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](/whm/use-whm-api-to-call-cpanel-api-and-uapi) documentation.

LiveAPI PHP Class


```undefined syntaxhighlighter-pre
$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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

LiveAPI Perl Module


```undefined syntaxhighlighter-pre
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](/guides/guide-to-the-liveapi-system/#guide-to-the-liveapi-system).

cPanel Tag System (deprecated)

Warnings:
- cPanel tags are **deprecated**. We **strongly** recommend that you **only** use the [LiveAPI](/guides/guide-to-the-liveapi-system) 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](/guides/guide-to-the-liveapi-system).
- 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](/cpanel-api-2/cpanel-api-2-deprecate-cpanel-tag-usage/) documentation.


Command Line


```undefined syntaxhighlighter-pre
cpapi2 --user=username CustInfo contactprefs
```

div
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](/cpanel-api-2/) documentation or run the `cpapi2 --help` command.
- If you run CloudLinux™, you **must** use the full path of the `cpapi2` command:

```undefined syntaxhighlighter-pre
/usr/local/cpanel/bin/cpapi2
```


br
Output (JSON)


```undefined syntaxhighlighter-pre
 {  
   "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](https://docs.cpanel.net/cpanel/advanced/api-shell-for-cpanel)* interface (*cPanel >> Home >> Advanced >> API Shell*) to directly test cPanel API calls.

## Parameters

This function does not accept parameters.

## Returns

table
colgroup
col
col
col
col
col
thead
tr
th
strong
Return
th
strong
Type
th
strong
Description
th
strong
Possible values
th
strong
Example
tbody
tr
td
code
enabled
td
em
Boolean
td
Whether the notification setting is enabled.
td
ul
li
code
1
 — The setting is enabled.
li
code
0
 — The setting is disabled.
p
br
td
code
1
tr
td
code
onchangeparent
td
em
string
td
The notification setting to monitor.
td
ul
li
code
notify_password_change
li
code
notify_contact_address_change
td
p
code
notify_password_change
tr
td
code
value
td
em
string
td
The notification setting's value.
td
ul
li
code
1
 — The setting is enabled.
li
code
0
 — The setting is disabled.
td
code
1
tr
td
code
type
td
em
string
td
The notification setting's data type.
td
ul
li
code
Boolean
li
code
string
td
code
Boolean
tr
td
code
descp
td
em
string
td
A notification setting's description.
td
A string value.
td
code
My contact email address changes.
tr
td
code
name
td
em
string
td
The notification setting's name.
td
A string value.
td
code
notify_disk_limit
tr
td
code
reason
td
em
string
td
p
A reason for failure.
p
This function only returns a 
code
reason
 value if it failed.
td
p
A string that describes the error.
td
code
This is an error message.
tr
td
code
result
td
em
Boolean
td
p
Whether the function succeeded.
td
ul
li
code
1
 — The function succeeded.
li
code
0
 — The function failed.
td
code
1