/mail/update_domain
POST https://api.sitehost.nz/1.2/mail/update_domain.json
Update the specified domain on the specified server.
Form Parameters
Parameter | Type | Required | Description |
client_id | integer | Yes | The ID for the client that the server belongs to.Example: 1 |
server_name | string | Yes | The name of the server to update the domain on.Example: my-mail-server |
domain | string | Yes | The domain name to update.Example: example.com |
params[catchall] | string | An updated catch-all email address for the domain.Example: catchall@example.com | |
params[state] | integer | The updated active state for the domain. 0 is inactive, 1 is active.Example: 1 |
Code Samples
JavaScript PHP Rails Pythonvar xmlHttp = new XMLHttpRequest();
xmlHttp.open("POST", "https://api.sitehost.nz/1.2/mail/update_domain.json", false);
var data = new FormData();
data.append("apikey", "your_key_here");
data.append("client_id", "1");
data.append("server_name", "my-mail-server");
data.append("domain", "example.com");
data.append("params[catchall]", "catchall@example.com");
data.append("params[state]", "1");
xmlHttp.send(data);
var response = xmlHttp.responseText;
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, "https://api.sitehost.nz/1.2/mail/update_domain.json");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
curl_setopt($ch, CURLOPT_POST, 1);
$body = array(
'apikey' => 'your_key_here',
'client_id' => 1,
'server_name' => 'my-mail-server',
'domain' => 'example.com',
'params[catchall]' => 'catchall@example.com',
'params[state]' => 1,
);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
$response = curl_exec($ch);
$status = curl_getinfo($ch, CURLINFO_HTTP_CODE);
curl_close($ch);
require 'net/http'
require 'uri'
uri = URI.parse("https://api.sitehost.nz/1.2/mail/update_domain.json")
http = Net::HTTP.new(uri.host, uri.port)
request = Net::HTTP::Post.new(uri.request_uri)
body = {"apikey" => "your_key_here",
"client_id" => 1,
"server_name" => "my-mail-server",
"domain" => "example.com",
"params[catchall]" => "catchall@example.com",
"params[state]" => 1,
}
request.set_form_data(body)
response = http.request(request)
import requests
from collections import OrderedDict
uri = 'https://api.sitehost.nz/1.2/mail/update_domain.json'
# We need ordered dictionary because parameters have to be in the right order.
# Refer to Developer Notes for more information.
body = OrderedDict()
body['apikey'] = 'your_key_here'
body['client_id'] = 1
body['server_name'] = 'my-mail-server'
body['domain'] = 'example.com'
body['params[catchall]'] = 'catchall@example.com'
body['params[state]'] = 1
response = requests.post(uri, data=body)
Response
200:application/json