Difference between revisions of "NATS5 REST API Site PATCH email-settings"
From TMM Wiki
Jump to navigationJump to search (Created page with "{{NATS4 Manual | show_api_admin_section = true }} == '''PATCH /site/email-settings''' == '''Description''' * Update site email settings '''Resource URL''' *<nowiki>http://do...") |
|||
| (5 intermediate revisions by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_site_section = true |
}} | }} | ||
== '''PATCH /site/email-settings''' == | == '''PATCH /site/email-settings''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Update site email settings | * Update site email settings | ||
| Line 9: | Line 10: | ||
*Replace domain with the nats domain | *Replace domain with the nats domain | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']] |
*PATCH | *PATCH | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 28: | Line 29: | ||
** required | ** required | ||
| − | [[Category: | + | == '''Example Request''' == |
| − | [[Category: | + | Method: '''PATCH'''<br/> |
| + | URL: <nowiki>http://domain/api/site/email-settings</nowiki><br/> | ||
| + | Form Data:<br/> | ||
| + | * siteid: 2 | ||
| + | * email_settings: [{"key":"EMAIL_FROM_MEMBER","value":"test1","default":"change@changeme.com","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":"unset","readonly":0},{"key":"EMAIL_REPLY_NICE_MEMBER","value":"test4","nice":"Reply Name","source":"unset","readonly":0},{"key":"EMAIL_BCC_TO_MEMBER","value":"test5","nice":"BCC Email","source":"unset","readonly":0}] | ||
| + | |||
| + | Response: | ||
| + | <pre> | ||
| + | { | ||
| + | "success": true, | ||
| + | "result": "Email settings updated" | ||
| + | } | ||
| + | </pre> | ||
| + | |||
| + | |||
| + | |||
| + | |||
| + | == '''Example Code''' == | ||
| + | |||
| + | '''PHP''' | ||
| + | <pre> | ||
| + | <?php | ||
| + | |||
| + | $headers = array( //set your username and API key here | ||
| + | 'api-key: 44b5498dbcb481a0d00b404c0169af62', | ||
| + | 'api-username: tmm1phrvezsbu' | ||
| + | ); | ||
| + | $url = 'http://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' => 'change@changeme.com', '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' => 'v1/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); | ||
| + | ?> | ||
| + | </pre> | ||
| + | |||
| + | [[Category:NATS5_REST_APIs]] | ||
| + | [[Category:NATS5_REST_site_Collection]] | ||
[[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | [[Category:Autogenerated_Wiki_Article]]<!-- Remove this tag when customizing a wiki article. The article will no longer be automatically updated --> | ||
| + | [[Category:Autogenerated_Rest_Sample]]<!-- This article has a generated REST API Sample from our unit testing system. Also remove if customizing the wiki article --> | ||
Latest revision as of 16:01, 9 August 2019
PATCH /site/email-settings
Description
- Update site email settings
Resource URL
- http://domain/api/site/email-settings
- Replace domain with the nats domain
- PATCH
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- siteid
- type: digit
- required
- email_settings
- type: json (JSON Object)
- required
Example Request
Method: PATCH
URL: http://domain/api/site/email-settings
Form Data:
- siteid: 2
- email_settings: [{"key":"EMAIL_FROM_MEMBER","value":"test1","default":"change@changeme.com","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":"unset","readonly":0},{"key":"EMAIL_REPLY_NICE_MEMBER","value":"test4","nice":"Reply Name","source":"unset","readonly":0},{"key":"EMAIL_BCC_TO_MEMBER","value":"test5","nice":"BCC Email","source":"unset","readonly":0}]
Response:
{
"success": true,
"result": "Email settings updated"
}
Example Code
PHP
<?php
$headers = array( //set your username and API key here
'api-key: 44b5498dbcb481a0d00b404c0169af62',
'api-username: tmm1phrvezsbu'
);
$url = 'http://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' => 'change@changeme.com', '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' => 'v1/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);
?>
