Domains-domainName-privateregistration:POST
From Hostway API Documentation
Revision as of 12:34, 31 January 2014 by Mike.robski (Talk | contribs)
POST /domains/{domainName}/privateregistration
Update the privateregistration for a domain - change forwarding e-mail address, upgrade or downgrade between "full" and "light" version of the privateregistration product.
Contents
|
Request
POST /domains/{domainName}/privateregistration
Parameters
None.
URI Parameters
- domainName - string
- The domain name. IE: example.com is a valid domain name, whereas http://www.example.com or www.example.com are not. If the domain name is invalid, or is otherwise not registerable such as for a non-existent or non-supported TLD, an error will be returned. Domain names are case insensitive. The domain name must be an open or suspended product under the authenticated franchise.
Request Headers
Content-Type: application/json
Request Body
The hosts for the domain.
Parameters
- type - string
- (Optional) The privateregistration product type, either "full" or "light". If it's different than the current type, product will be upgraded or downgraded to match the new type.
- email - string
- (Optional) The forwarding e-mail address for "full" type privateregistration.
Response
Status Code
- 204 No Content
- Returned on success
- 404 Not Found
- No domain records found for the given domain name.
- 500 Internal Server Error
- An error has occurred with the registry,
Response Body
None.
Example of updating e-mail address for "full" type of privateregistration.
Request
POST /domains/example.com/privateregistration
{ "email": "test-changed@test.com" }
Response
204 No Content
Example of downgrading "full" type of privateregistration to "light".
Request
POST /domains/example.com/privateregistration
{ "type": "light" }
Response
204 No Content
Example of upgrading "light" type of privateregistration to "full".
Request
POST /domains/example.com/privateregistration
{ "type": "full", "email": "test-forward@test.com" }
Response
204 No Content
See also
