Child pages
  • WHM API 1 Functions - update_contact_email
Skip to end of metadata
Go to start of metadata

Description

This function updates the contact email address in the wwwacct.conf file. For more information, read our Installation Guide - Customize Your Installation documentation.

Examples 


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/update_contact_email?contact_email=user%40example.com
 Command Line
whmapi1 update_contact_email contact_email=user%40example.com


Notes:

  • You must URI-encode values.
  • For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
  • If you run CloudLinux™, you must use the full path of the whmapi1 command:

    /usr/local/cpanel/bin/whmapi1

 Output (JSON)


   "metadata":{ 
      "reason":"OK",
      "result":1,
      "command":"update_contact_email",
      "version":1
   },
   "data":{ 
   }
}


Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

ParameterTypeDescriptionPossible valuesExample
contact_emailstring

Required

The contact email address to add as the wwwacct.conf file's CONTACTEMAIL setting.

A valid email address.

user@example.com

Returns

This function only returns metadata.