UpdateCusPreferences


Definition

Update the customer preference settings for an account.

Usage

Use this command to update account-level settings that are applied to all domain names you register.

For most settings, if no value is supplied for an individual setting, this command reverts that setting to its default value, with two exceptions:

For host records, the UseParentDefault parameter allows you to choose between persisting current host records, and setting new host records.

Name servers are always persisted by default, unless new name servers are specified in the query string.

You can use the GetCusPreferences command to retrieve the current settings for an account, and to supply the current values for the UpdateCusPreferences query string.

Availability

All resellers have access to this command.

Implementation on eNom.com

Log on to resellertest.enom.com with Login ID resellid, password resellpw.

https://resellertest.enom.com/myaccount/Settings.asp

On the my enom > settings page, the UpdateCusPreferences command sets any changes that a user enters in the Default Domain Options section.

Constraints

The query must meet the following requirements:

  • The login ID and password must be valid.

Input parameters

Build the query string using this syntax:

Query

https://resellertest.enom.com/interface.asp?
command=nameofcommand&uid=yourloginid&pw=yourpassword &paramname=paramvalue&nextparamname=nextparamvalue

 

Parameter Status Description Max Size
UID Required Account login ID 20
PW Required Account password 20
DefPeriod Optional; default is 1 Default period for auto-renew and registrar lock settings, in years. A domain’s registration period cannot extend more than 10 years beyond today. 2
RegLock Optional; default is off RegLock=on prevents a domain from being transferred to a new registrar.
RegLock=off allows unrestricted transfer of a domain from one registrar to another.
3
AutoRenew Optional; default is off AutoRenew=on renews domain names automatically.
AutoRenew=off does not renew domain names automatically.
3
IDProtect Optional; default is off IDProtect=on automatically purchases ID Protect for all eligible domains. Permitted values are on and off 3
DefIDProtectRenew Optional; default is off DefIDProtectRenew=on automatically renews ID Protect before it expires. Permitted values are on and off 3
DefWBLRenew Optional; default is off DefWBLRenew=on automatically renews Business Listing before it expires. Permitted values are on and off 3
AutoPakRenew Optional; default is off AutoPakRenew=on renews POP email paks automatically.
AutoPakRenew=off does not renew POP paks automatically.
Note: This parameter displays in the UI only if auto-renewal of POP paks is enabled as a for-pay feature for this account.
3
EMailForwardRenew Optional; default is off EMailForwardRenew=on renews email forwarding automatically.
EMailForwardRenew=off does not renew email forwarding automatically.
Note: This parameter displays in the UI only if email forwarding is enabled as a for-pay feature for this account.
3
URLForwardingRenew Optional; default is off URLForwardingRenew=on renews URL forwarding automatically.
URLForwardingRenew=off does not renew URL forwarding automatically.
3
AllowDNS Optional; default is 0 Allow domain name servers. Options are 0 and 1. Appears to be an inactive parameter. 1
UseDNS Optional; default is 1 Which name servers a domain is using.
If UseDNS=1, use our name servers.
If UseDNS=0, use the name servers specified in this query string.
Note: If UseDNS or DNSY are present in the UpdateCusPreferences other settings (DefPeriod through AllowDNS) will be updated.
1
DNSY
Y=1, 2, 3, . . .
Optional Use name of domain name server. For example, DNS1=ns1.name-services.com.
Note: If UseDNS or DNSY are present in the UpdateCusPreferences other DNS settings (DefPeriod through AllowDNS) will be updated.
16
UseParentDefault Optional; default is 1 Which host records should be used for this account’s defaults. Permitted values are: 0 Use the host records in this query string 1 Persist the existing host records 1
HostName Optional Name of host record, for example, HostName1=www Permitted format is a comma-delimited list. 60
RecordType Optional Record type of host record. Permitted format is comma-delimited list of record types for each of the host records specified with the HostName parameter. List record types in the same order as the host name they correspond to. Permitted values are:
A IP address
AAAA IPv6 address
CNAME Alias record type, to associate a host name with another host
URL URL redirect
FRAME Frame redirect
MX Mail. Can be a host name under this domain name or the name of a mail server
MXE Mail Easy (email forwarding)
TXT Text (SPF) record
5
Address Optional Address to redirect to. Permitted format is a comma-delimited list of the record types for each host record. List addresses in the same order as the host name they correspond to. Permitted values are:
If RecordType=A, Address must be an IP address
If RecordType=AAAA, Address must be an IPv6 address
If RecordType=CNAME, Address must be a fully qualified domain name (see Note) or a host name defined in this domain
If RecordType=URL, Address must be the exact URL of the page you redirect to, or an IP address, or a fully qualified domain name (see Note)
If RecordType=FRAME, Address is the actual URL, or the IP address, or the fully qualified domain name (see Note) of the page you want to display when someone types Your_Domain.com
If RecordType=MX, Address must be a fully qualified domain name (see Note) or a host name defined in this domain
If RecordType=MXE, Address must be an IP address
If RecordType=TXT, Address is a text (SPF) record.
For help writing an SPF record, go to http://spf.pobox.com/wizard.html
260
ShowPopUps Optional; default is 0 Show menus.
ShowPopUps=0 hides menus.
ShowPopUps=1 shows menus.
Appears to be an inactive parameter.
1
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
Update A return value of Successful indicates that customer preferences were successfully updated.
Command Name of command executed
ErrCount The number of errors if any occurred. If greater than 0 check the Err(1 to ErrCount) values.
ErrX Error messages explaining the failure. These can be presented as is back to the client.
Done True indicates this entire response has reached you successfully.

 

Notes

  • The default response format is plain text. To receive the response in HTML or XML format, send ResponseType=HTML or ResponseType=XML in your request.
  • Check the return parameter ErrCount. If greater than 0 the transaction failed. The parameter Err(ErrCount) can be presented to the client. Otherwise process the returned parameters as defined above.

Example