Preconfigure


Definition

Configure the extended attributes for the Active domains in a shopping cart. Most

commonly, extended attributes are added for certain country codes, including .us,

.ca, .co.uk, and .org.uk.

Usage

Use this command when registering domains that require extended attributes (information required by some registries for some TLDs). To retrieve extended attributes, use the GetExtAttributes command.

This command operates only if you use our shopping cart, and only on the domains in the cart that have status Active. If you use the Purchase command instead of our shopping cart, supply the extended attributes in the Purchase command.

Optionally, you can also use this command to configure many universal attributes for domains in your shopping cart that are in status Active. Preconfigurable attributes include the Auto Renew setting, Registrar-Lock setting, IDN codes, name servers, host records, access passwords, and contacts.

Many of the universal attributes that this command can set in a cart can also be set for all future registrations by using the UpdateCusPreferences command.

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/domains/PreConfigure.asp

With a configurable domain in the cart, click the configure button below the list of cart contents. On the Pre-configure page, one or more specific information boxes contain text boxes that set values for the Preconfigure command when you click save changes.

Constraints

The query must meet the following requirements:

  • This command operates only if you use our shopping cart, and only on the domains in the cart that have status Active.
  • The login ID and password must be valid.
  • There must be at least one configurable domain in the cart.
  • The extended attributes (configuration parameters) you provide in the query must match those required for the current TLD. For example, configuring a .us name requires that you provide the attributes for .us, not those for .ca.

Input parameters

Build the query string using this syntax:

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
Load Required .ca, .co.uk, and .org.uk 1 use the previously configured values for all preconfiguration information
2 submit new preconfiguration information (contacts, name servers, extended attributes)
1
ExtendedAttributes Required for some country codes Data required by the Registry for some country codes. Use GetExtAttributes to determine whether this TLD requires extended attributes. If extended attributes are required, the GetExtAttributes return supplies parameter names tagged as <Name> and permitted values tagged as <Value> varies
AutoRenew Required Set to Auto Renew. Permitted values are:
1 Set the preconfigured domains to renew automatically (recommended)
0 Set the domains to not auto-renew
1
RegLock Required Set Registrar-Lock. Permitted values are:
1 Set the preconfigured domains to registrar lock (recommended, to prevent unauthorized transfers)
0 Do not lock the domains
1
IDNX X = 1 to NumberOfLanguages Required for PUNY encoded names that use characters other than the English alphabet, numbers, and hyphen International Domain Name code for each language used by a domain in the cart that has status Active. To retrieve the Active domains in the cart, use command GetCartContent . For a list of IDN codes, go to http://www.enom.com/resellers/newdocumentation.asp 3
PreConfigDNS Required Which name servers this domain uses: default our name servers other name servers specified in this query using the NSX parameter 7
NSX X=1 . . . 12 Required if you want to use name servers other than ours Names of the name servers a domain is using. Maximum of 12 name servers. 2
UseHostRecords Optional Use host records provided in this query string. Permitted values are: 0 Use this account’s default host records 1 Store the host records provided in this string 1
HostNameX Optional Name of host record X, for example, www 60
RecordTypeX Optional Record type of host record X. 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
AddressX Optional Address to redirect to.
If RecordTypeX=A, AddressX must be an IP address
If RecordTypeX=AAAA, AddressX must be an IPv6 address
If RecordTypeX=CNAME, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain
If RecordTypeX=URL, AddressX must be the exact URL of the page you redirect to, or an IP address, or a fully qualified domain name (see Note)
If RecordTypeX=FRAME, AddressX 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 RecordTypeX=MX, AddressX must be a fully qualified domain name (see Note) or a host name defined in this domain
If RecordTypeX=MXE, AddressX must be an IP address
If RecordTypeX=TXT, AddressX is a text (SPF) record.
For help writing an SPF record, go to http://spf.pobox.com/wizard.html
260
AccessPassword1 Optional Domain name password 50
AccessPassword2 Optional Domain name password. Must be identical to AccessPassword1. 50
ExpressCheckout Either ExpressCheckout or all four Opt* parameters are Required If ExpressCheckout=1, the account’s default contacts will be applied. If ExpressCheckout=0 or is not used, supply contact information using the Opt* and ContactType* parameters below. 1
OptContactReg Either ExpressCheckout or all four Opt* parameters are Required Permitted values are:
UseBilling Use the account billing contact as the Registrant contact for this domain
UseRegistrant Use the account default Registrant contact as the Registrant contact for this domain
UseExisting Use the Registrant contact information supplied in this query string
1
OptTechnical Either ExpressCheckout or all four Opt* parameters are Required Permitted values are:
UseBilling Use the account billing contact as the Technical contact for this domain
UseRegistrant Use the account default Registrant contact as the Technical contact for this domain
UseExisting Use the Technical contact information supplied in this query string
1
OptAdministrative Either ExpressCheckout or all four Opt* parameters are Required Permitted values are:
UseBilling Use the account billing contact as the Administrative contact for this domain
UseRegistrant Use the account default Registrant contact as the Administrative contact for this domain
UseExisting Use the Administrative contact information supplied in this query string
1
OptContactAux Either ExpressCheckout or all four Opt* parameters are Required Permitted values are:
UseBilling Use the account billing contact as the Auxiliary Billing contact for this domain
UseRegistrant Use the account default Registrant contact as the Auxiliary Billing contact for this domain
UseExisting Use the Auxiliary Billing contact information supplied in this query string
1
ContactTypeOrg Optional Name of Contact’s organization. ContactType can be REGISTRANT, AUXBILLING, TECH, ADMIN. Supply ContactType parameters for any contact type where you supplied Opt*=UseExisting. 60
ContactTypeJobTitle Optional Contact’s job title 60
ContactTypeFName Optional Contact’s first name 60
ContactTypeLName Optional Contact’s last name 60
ContactTypeAddress Optional Contact’s address 60
ContactTypeAddress2 Optional Contact’s address, second line 60
ContactTypeCity Optional Contact’s city 60
ContactTypeState Optional Contact’s state 60
ContactTypeProvince Optional Contact’s province 60
ContactTypeStateProvinceChoice Optional Contact’s state or province choice. Use value S if Contact is located in a state; use P if a province. 1
ContactTypeZip Optional for most TLDs; Required for .org Contact’s postal code 16
ContactTypeCountry Optional Contact’s country. 2-letter country code is a permitted format 60
ContactTypePhone Optional Contact’s phone number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL-encoded as a plus sign (%2B). 17
ContactTypePhoneExt Optional Contact’s phone extension 6
ContactTypeFax Optional Contact’s fax number. Required format is +CountryCode.PhoneNumber, where CountryCode and PhoneNumber use only numeric characters and the + is URL-encoded as a plus sign (%2B). 17
ContactTypeEmail Optional Contact’s email address 128
ResponseType Optional Format of response. Permitted values are Text (default), HTML, or XML. 4

 

Returned parameters and values

Parameter Description
PreConfigSuccess 1 indicates no extended attributes required. 2 indicates query failed at Registry.
Count Number of TLDs affected
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.
IsLockable 0 indicates the domain is not lockable; 1 indicates the domain is lockable
IsRealTimeTLD Indicates whether this is a TLD that registers in real time. 0 indicates no; 1 indicates yes.
Done True indicates this entire response has reached you successfully.

 

Notes

  • A fully qualified domain name is expressed in the format “hostname.SLD.TLD.”. Note that the trailing period is an essential component of a fully qualified domain name.
  • 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