WAPI
The following operations are supported. For a formal definition, please review the Service Description.
-
Cancel
Used for cancelling existing resources. -
CheckAvailability
Checks the availability of domains, hosts and name servers. -
CheckDomains
Checks the availability of domains, supports IDN domain checks. -
CheckUser
Used for checking whether the account information for the specified user is valid or not. -
CreateNewShopper
Used for creating a new reseller sub-account. -
Describe
Returns activity timeout and version information from the server. -
DomainForwarding
This method is used for forwarding a domain to a specified URL. -
GetAutoResponderForEmail
Retrieve the Auto Response/Vacation settings for an email address. -
GetAvailableBalance
Used to get the available balance for a given Private Label ID. -
GetCatchallStatusForEmail
Determine if an email address is a catchall for its domain. -
GetDiskUsageForEmail
Retrieve the Disk Space Used and Quota for an email address. -
GetDomainAlertCredits
Used for querying the number of domain alert, private backorder, and backorder credits. -
GetEmailAddressInfoForShopper
Get detailed information about a single, or all email addresses associated with the given shopper. -
GetEmailAddressesForDomain
Get a list of email addresses associated with a domain ordered by username. -
GetEmailAddressesForPlan
Get a list of email addresses associated with a resource id. -
GetEmailAddressesForShopper
Get email addresses associated with the given shopper. -
GetEmailPlanInfoForShopper
Get detailed information about a single, or all email/forwarding plans associated with the given shopper. -
GetEmailPlansForDomain
Get a list of email and email forwarding resource ids associated with the given domain name. -
GetEmailPlansForShopper
Get a list of email and email forwarding resource ids associated with the given shopper. -
GetExpiringNameList
This method is used to get the list of expiring domain names for users that have an Investors Edge subscription. -
GetIDNLanguageList
This method is used for retrieving languages for IDN TLDs. -
GetIMAPForEmail
Get a list of email and email forwarding resource ids associated with the given shopper. -
GetLegalAgreementContent
Used to get the legal agreement content that resellers need to display and get approval from their customers. -
GetLegalAgreementUrl
Used to get the legal agreement url that resellers need to display and get approval from their customers. -
GetMonitoredDomainList
Used for querying a list of monitored domains. -
GetPunycodeIDN
This method encodes a Unicode (UTF-8) domain to Punycode format. -
GetRIMForEmail
Retrieve the RIM status for an email address. -
GetSMTPRelayInfoForShopper
Get detailed info about a single SMTP relay product, or for every SMTP relay products associated with the given shopper. -
GetSMTPRelayPlansForDomain
Get a list of SMTP relay resource ids associated with the given domain. -
GetSMTPRelayPlansForEmail
Get a list of SMTP relay resource ids associated with the given email address. -
GetSMTPRelaysForEmail
Retrieve the SMTP relays allotted and used for the given email address. -
GetSMTPRelaysForShopper
Get a list of SMTP relays associated with the given shopper. -
GetStatusForEmail
Retrieve the current status of an email. -
GetUnicodeIDN
This method decodes a Punycode domain to Unicode (UTF-8) format. -
Info
Gets information about items that have been previously ordered. -
ManageTransfer
This method is used for managing the transfer of domains. -
ModifyDNS
This method is used for modifying DNS settings for a given domain. -
MoveEmailAccount
Reassign an email address to a different email plan. -
NameGen
Used to get the list of alternative domain names based on a given name. -
NameGenDB
Used to get the list of alternative domain names based on a given name (Domains Bot Service). -
NameGenDBWithTimeLimit
Used to get the list of alternative domain names based on a given name (Domains Bot Service). -
OrderCredits
Used to place an order on items that do not require customization (non-domain). -
OrderDomainBackOrders
Used for back ordering an existing (public or private) domain name. -
OrderDomainPrivacy
Used for adding privacy to a domain registration. -
OrderDomainRedemptions
Used for redeeming expired domains. -
OrderDomainRenewals
Used for renewing registration for existing public domain names. -
OrderDomainTransfers
Used for transfering ownership of a domain from one user to another. -
OrderDomains
Used for registering new domain names. -
OrderPrivateDomainRenewals
Used for renewing registration for existing private domain names. -
OrderResourceRenewals
Used for renewing non-domain items. -
OrderServiceRenewals
Used for renewing service items. -
OrderServices
Used to place an order for services (e.g. email) and/or service add-ons. -
Poll
Used to retrieve status notifications about pending orders. -
ProcessRequest
Provide support for calling WWD services using legacy WAPI request XMLs. -
RemoveDomainAlert
Used for removing an existing domain alert record. -
RemoveEmailAddress
Deletes an email address. -
RemoveRIMAccount
Unsubscribe an email address from RIM. -
RemoveSmtpRelay
Remove a specific SMTP relay fom an email address by the given resource id. -
RenameEmailPlan
Change the customer facing description of an email or email forwarding plan. -
ResendContactValidation
Used to resend RAA verification to the resellers customer or the domain registrant. -
ResetPassword
Used for resetting the user's password in the WWD system. -
SetAutoResponder
Create/Update and email/forwarding account’s Auto Responder. -
SetDomainLocking
This method is used for setting or clearing the lock on a list of domains. -
SetEmailAccount
Create/Update and email/forwarding account. -
SetRIMAccount
Email products management method. -
SetServiceAddOnQty
Sets a service add-on's quantity, which either downgrades or submit new add-on orders. -
SetShopperInfo
Used for allowing the reseller to modify the user information for either their top-level account or any of its sub-accounts. -
SetSmtpRelays
Email products management method. -
SetupDomainAlert
Used for setting domain alert credit or backorder a domain. -
TestEmailPassword
Email products management method. -
UpdateDomainAlert
Used for updating an existing domain alert record. -
UpdateDomainContact
This method is used for modifying associated contact information for the given domains. -
UpdateDomainForwarding
This method is used for performing multiple domain forwarding. -
UpdateDomainMasking
This method is used for performing multiple domain masking. -
UpdateDomainOwnership
Used for changing the ownership of a resource from one end user to another (both must be end-users of the currently logged in reseller). -
UpdateNameServer
This method is used for modifying associated name servers for the given domains. -
ValidateRegistration
This method is used for validating a domain's period and contacts.