Function /domain/add
Function invocation
https://json.aftermarket.pl/domain/add
Function description
Register domain.
Input parameters
This function takes the following input parameters:
| Parameter | Type | Required | Default value | Description |
|---|---|---|---|---|
| string | "" | Domain name to register (deprecated, please use 'name' parameter) | ||
| name | string | YES | Domain name to register | |
| contactId | integer | 0 | Contact profile id to use for registration (/contact/list) | |
| integer | 0 | Contact profile id to use for registration (deprecated, please use 'contactId' parameter) | ||
| integer | 0 | Folder id to use to store registered domain (deprecated and unused) | ||
| ns | string[] | [] | Pointing nameservers for example ['ns1.domain.com', 'ns2.domain.com']) | |
| ips | string[] | [] | Optional IP Addresses for pointing nameserver | |
| private | boolean | false | Domain WHOIS privacy setting | |
| tags | string | "" | Domain tags, separeted by commas | |
| integer | 0 | Years (deprecated and unused, please use 'period' parameter) | ||
| period | integer | 1 | Registration period, depends on domain TLD. For periodType 'years' allowed values for most domains are from 1 to 10, default 1 year. For periodType 'days' the only allowed value is 30. | |
| periodType | string | "years" | Period unit (one of years, days) | |
| useCode | boolean | false | Use bonus code |
Return value
Domain registration result (structure with the following fields):
| Field name | Type | Description |
|---|---|---|
| amount | float | Optional amount |
| currency | string | Currency of optional amount |
| string | Status message (deprecated) | |
| myAmount | float | Amount in member currency of optional amount |
| myCurrency | string | Member's currency |
| name | string | Domain name (in Punycode) |
| nameIDN | string | Domain name (internationalized) |