CPcpanel
ContactInformation
Contact Information

Set contact email address(es)

Changed on

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

To unset all contact email addresses, call unset_email_addresses.

get/ContactInformation/set_email_addresses

Request

  • Base URL
    https://cpanel-server.tld:2083/execute
  • Auth
    HTTP basic

Query parameters

addressstring[] required

The account’s new contact email addresses.

old_addressstring[] 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.

passwordstring password required
Example:q1df%D9<z0ShqdxRP%^

The account’s password.

Response

Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "set_email_addresses",
  "module": "ContactInformation",
  "result": {
    "status": 1
  }
}

Changes