/api/site/email‑settings

get

Get email settings

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

siteidintegerOptional

populatestringOptionalDefault: 0

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

get

/api/site/email-settings

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'siteid' => '2',
		'populate' => 0
	);

$request = array(
	'method' => 'GET',
	'path' => 'site/email-settings',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

200

success

{
  "success": 1,
  "email_settings": {
    "ALL": [
      {
        "key": "EMAIL_FROM_AFFILIATE",
        "value": "",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "config",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_NICE_AFFILIATE",
        "value": "",
        "nice": "From Name",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_AFFILIATE",
        "value": "",
        "nice": "Reply Email",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_NICE_AFFILIATE",
        "value": "",
        "nice": "Reply Name",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_BCC_TO_AFFILIATE",
        "value": "",
        "nice": "BCC Email",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_MEMBER",
        "value": "test1",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_NICE_MEMBER",
        "value": "test2",
        "nice": "From Name",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_MEMBER",
        "value": "test3",
        "nice": "Reply Email",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_NICE_MEMBER",
        "value": "test4",
        "nice": "Reply Name",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_BCC_TO_MEMBER",
        "value": "test5",
        "nice": "BCC Email",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_OWNER",
        "value": "",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "config",
        "readonly": 1
      },
      {
        "key": "EMAIL_FROM_NICE_OWNER",
        "value": "",
        "nice": "From Name",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_REPLY_OWNER",
        "value": "",
        "nice": "Reply Email",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_REPLY_NICE_OWNER",
        "value": "",
        "nice": "Reply Name",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_BCC_TO_OWNER",
        "value": "",
        "nice": "BCC Email",
        "source": "unset",
        "readonly": 1
      }
    ],
    "AFFILIATE": [
      {
        "key": "EMAIL_FROM_AFFILIATE",
        "value": "",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "config",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_NICE_AFFILIATE",
        "value": "",
        "nice": "From Name",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_AFFILIATE",
        "value": "",
        "nice": "Reply Email",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_NICE_AFFILIATE",
        "value": "",
        "nice": "Reply Name",
        "source": "unset",
        "readonly": 0
      },
      {
        "key": "EMAIL_BCC_TO_AFFILIATE",
        "value": "",
        "nice": "BCC Email",
        "source": "unset",
        "readonly": 0
      }
    ],
    "MEMBER": [
      {
        "key": "EMAIL_FROM_MEMBER",
        "value": "test1",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_FROM_NICE_MEMBER",
        "value": "test2",
        "nice": "From Name",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_MEMBER",
        "value": "test3",
        "nice": "Reply Email",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_REPLY_NICE_MEMBER",
        "value": "test4",
        "nice": "Reply Name",
        "source": "site",
        "readonly": 0
      },
      {
        "key": "EMAIL_BCC_TO_MEMBER",
        "value": "test5",
        "nice": "BCC Email",
        "source": "site",
        "readonly": 0
      }
    ],
    "OWNER": [
      {
        "key": "EMAIL_FROM_OWNER",
        "value": "",
        "default": "[e-mail]",
        "nice": "From Email",
        "source": "config",
        "readonly": 1
      },
      {
        "key": "EMAIL_FROM_NICE_OWNER",
        "value": "",
        "nice": "From Name",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_REPLY_OWNER",
        "value": "",
        "nice": "Reply Email",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_REPLY_NICE_OWNER",
        "value": "",
        "nice": "Reply Name",
        "source": "unset",
        "readonly": 1
      },
      {
        "key": "EMAIL_BCC_TO_OWNER",
        "value": "",
        "nice": "BCC Email",
        "source": "unset",
        "readonly": 1
      }
    ],
    "OWNER_TO": null
  }
}

patch

Update site email settings

Authorizations

api-key & api-username

api-keystringRequired

api-usernamestringRequired

Query parameters

siteidintegerRequired

email_settingsstringRequired

Responses

200

success

text/phpapplication/jsonapplication/xml

successbooleanOptionalExample: true

patch

/api/site/email-settings

PHP (cURL)

<?php

$headers = array( //set your username and API key here
	'api-key: 44b5498dbcb481a0d00b404c0169af62',
	'api-username: tmm1phrvezsbu'
);
$url = 'https://yourdomain.com'; //set your NATS URL here

$data = array(
		'siteid' => '2',
		'email_settings' => json_encode(array ( 0 =>  array (  'key' => 'EMAIL_FROM_MEMBER',  'value' => 'test1',  'default' => '[e-mail]',  'nice' => 'From Email',  'source' => 'site',  'readonly' => 0, ), 1 =>  array (  'key' => 'EMAIL_FROM_NICE_MEMBER',  'value' => 'test2',  'nice' => 'From Name',  'source' => 'site',  'readonly' => 0, ), 2 =>  array (  'key' => 'EMAIL_REPLY_MEMBER',  'value' => 'test3',  'nice' => 'Reply Email',  'source' => 'unset',  'readonly' => 0, ), 3 =>  array (  'key' => 'EMAIL_REPLY_NICE_MEMBER',  'value' => 'test4',  'nice' => 'Reply Name',  'source' => 'unset',  'readonly' => 0, ), 4 =>  array (  'key' => 'EMAIL_BCC_TO_MEMBER',  'value' => 'test5',  'nice' => 'BCC Email',  'source' => 'unset',  'readonly' => 0, ),))
	);

$request = array(
	'method' => 'PATCH',
	'path' => 'site/email-settings',
	'data' => $data
);

/*code below is the same for (almost) every API call */

$curl = curl_init();

$url = $url.'/api/'.$request['path'];

$query = http_build_query($request['data']);

if($request['method'] == 'GET'){
	//add query string parameters to the end of the url
	$url = $url.'?'.$query;
}else{
	//send parameters as POST fields
	curl_setopt($curl, CURLOPT_POST, 1);
	curl_setopt($curl, CURLOPT_POSTFIELDS, $query);

	if($request['method'] != 'POST'){
		$headers[] ='X-HTTP-Method: '.$request['method']; //send custom request method
	}
}
curl_setopt($curl, CURLOPT_URL, $url);
curl_setopt($curl, CURLOPT_HTTPHEADER, $headers);
curl_setopt($curl, CURLOPT_RETURNTRANSFER, true);


$resp = curl_exec($curl);
//dumps an associative array representation of the json
var_dump(json_decode($resp, true));
// Close request to clear up some resources
curl_close($curl);
?>

200

success

{
  "success": true,
  "result": "Email settings updated"
}