Child pages
  • WHM API 1 Functions - update_contact_email

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description

Excerpt

This function updates the contact email address in the wwwacct.conf file.

 For more information, read our Installation Guide - Customize Your Installation documentation.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone


Expand
titleJSON API


Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/update_contact_email?contact_email=user%40example.com



Expand
titleCommand Line


Code Block
languagebash
whmapi1 update_contact_email contact_email=user%40example.com

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote


Expand
titleOutput (JSON)


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

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote


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.