Difference between revisions of "NATS5 REST API Mailing POST mailing-rule"
From TMM Wiki
Jump to navigationJump to searchm (TMMJoe moved page NATS4 REST API Mailing POST mailing-rule to NATS5 REST API Mailing POST mailing-rule: Renaming NATS5 API pages) |
|||
| (One intermediate revision by the same user not shown) | |||
| Line 1: | Line 1: | ||
| − | {{ | + | {{NATS5 Manual |
| − | | | + | | show_api_admin_mailing_section = true |
}} | }} | ||
== '''POST /mailing/mailing-rule''' == | == '''POST /mailing/mailing-rule''' == | ||
| + | |||
'''Description''' | '''Description''' | ||
* Add new mailer rule | * Add new mailer rule | ||
| 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''']] |
*POST | *POST | ||
'''Response Format''' | '''Response Format''' | ||
*JSON | *JSON | ||
| − | '''[[ | + | '''[[NATS5_REST_API_Overview#Authentication|Authentication]]''' |
*HTTP headers | *HTTP headers | ||
| Line 46: | Line 47: | ||
** optional | ** optional | ||
* '''mailok''' | * '''mailok''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''trial''' | * '''trial''' | ||
| Line 52: | Line 53: | ||
** optional | ** optional | ||
* '''all_email''' | * '''all_email''' | ||
| − | ** type: boolean_digit | + | ** type: boolean_digit (0 or 1) |
** optional | ** optional | ||
* '''status''' | * '''status''' | ||
| Line 103: | Line 104: | ||
* mailid: 1 | * mailid: 1 | ||
* rule_type: 1 | * rule_type: 1 | ||
| + | * login: 1 | ||
| + | * program: 1 | ||
| + | * mailok: 1 | ||
| + | * all_email: 0 | ||
| + | * status: -1 | ||
| + | * start_time: NOW | ||
| + | * end_time: FOREVER | ||
| + | * trial: 0 | ||
| + | * signup: 5 | ||
| + | * amount: 5 | ||
| + | * traffic: 100 | ||
| + | * amount_range: 1 | ||
| + | * traffic_range: 0 | ||
Response: | Response: | ||
| Line 130: | Line 144: | ||
'mailid' => 1, | 'mailid' => 1, | ||
'rule_type' => 1, | 'rule_type' => 1, | ||
| + | 'login' => '1', | ||
| + | 'program' => '1', | ||
| + | 'mailok' => 1, | ||
| + | 'all_email' => 0, | ||
| + | 'status' => -1, | ||
| + | 'start_time' => 'NOW', | ||
| + | 'end_time' => 'FOREVER', | ||
| + | 'trial' => 0, | ||
| + | 'signup' => 5, | ||
| + | 'amount' => 5, | ||
| + | 'traffic' => 100, | ||
| + | 'amount_range' => 1, | ||
| + | 'traffic_range' => 0, | ||
); | ); | ||
| Line 171: | Line 198: | ||
</pre> | </pre> | ||
| − | [[Category: | + | [[Category:NATS5_REST_APIs]] |
| − | [[Category: | + | [[Category:NATS5_REST_mailing_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 --> | [[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 15:59, 9 August 2019
POST /mailing/mailing-rule
Description
- Add new mailer rule
Resource URL
- http://domain/api/mailing/mailing-rule
- Replace domain with the nats domain
- POST
Response Format
- JSON
- HTTP headers
Parameters
Parameters can be sent as url encoded params
- mailid
- type: digit
- required
- rule_type
- type: trinary_digit (0, 1, or 2)
- required
- login
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- option
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- program
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- site
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- tour
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- biller
- type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
- optional
- mailok
- type: boolean_digit (0 or 1)
- optional
- trial
- type: trinary_digit (0, 1, or 2)
- optional
- all_email
- type: boolean_digit (0 or 1)
- optional
- status
- type: digit (negative numbers allowed)
- optional
- status_compare
- type: string
- optional
- signup
- type: digit
- optional
- signup_compare
- type: string
- optional
- signup_timeframe
- type: digit
- optional
- amount
- type: digit
- optional
- amount_compare
- type: string
- optional
- amount_range
- type: digit
- optional
- traffic
- type: digit
- optional
- traffic_compare
- type: string
- optional
- traffic_range
- type: digit
- optional
- mailing_list_id
- type: digit
- optional
- start_time
- type: string
- optional (default value: NOW)
- end_time
- type: string
- optional (default value: FOREVER)
Example Request
Method: POST
URL: http://domain/api/mailing/mailing-rule
Form Data:
- mailid: 1
- rule_type: 1
- login: 1
- program: 1
- mailok: 1
- all_email: 0
- status: -1
- start_time: NOW
- end_time: FOREVER
- trial: 0
- signup: 5
- amount: 5
- traffic: 100
- amount_range: 1
- traffic_range: 0
Response:
{
"success": true,
"result": "mailer rule added"
}
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(
'mailid' => 1,
'rule_type' => 1,
'login' => '1',
'program' => '1',
'mailok' => 1,
'all_email' => 0,
'status' => -1,
'start_time' => 'NOW',
'end_time' => 'FOREVER',
'trial' => 0,
'signup' => 5,
'amount' => 5,
'traffic' => 100,
'amount_range' => 1,
'traffic_range' => 0,
);
$request = Array(
'method' => 'POST',
'path' => 'v1/mailing/mailing-rule',
'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);
?>
