cPanel/ContactInformation
cPanel module

ContactInformation

6 functions, invoked through the cpanel_uapi tool.

scope cpanel:uapi
Call any function with cpanel_uapi(service_id, module="ContactInformation", function, params). Live availability depends on the cPanel features JetHost has enabled on your account — call list_cpanel_operations to see what is active.

get_notification_preferences GET#

Return the account's notification preferences.

Use this function to get a cPanel or Webmail account's notification preferences.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

additionalPropertiesstring
descpstring
A description of the notification setting.
enabledinteger
- 1 - Notification is enabled - 0 - Notification is disabled
One of: 0 1
namestring
The notification preference key name.

get_pushbullet_access_token GET#

Return Pushbullet access token

This function retrieves the cPanel account's Pushbullet™ access token.

No parameters.

Response — normalized as { ok, data, errors[], warnings[] }; data contains:

The cPanel account's Pushbullet access token.

set_email_addresses GET#

Set contact email address(es)

Use this function to set an account's contact email address(es).

To unset all contact email addresses, call unset_email_addresses.

addressarray<any>Required
The account’s new contact email addresses.
old_addressarray<any>Required
The account’s existing contact email addresses. If this list does not match the account’s current current email address(es), then the request will fail. This control is here to prevent race conditions.
passwordstringRequired
The account’s password.

set_notification_preferences POST#

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.

preferencesobjectOptional

Response — normalized as { ok, data, errors[], warnings[] }; data is an array of:

additionalPropertiesstring
descpstring
A description of the notification setting.
enabledinteger
- 1 - Notification is enabled - 0 - Notification is disabled
One of: 0 1
namestring
The notification preference key name.

set_pushbullet_access_token GET#

Update Pushbullet access token

This function updates the cPanel account's Pushbullet™ access token.

pushbullet_access_tokenstringRequired
The account’s new Pushbullet access token.

unset_email_addresses GET#

Unset contact email addresses

Use this function to unset all contact email address for an account.

To set contact email address(es), call set_email_addresses.

old_addressarray<any>Required
The account’s existing contact email addresses. If this list does not match the account’s current current email address(es), then the request will fail. This control is here to prevent race conditions.
passwordstringRequired
The account’s password.