View source for NATS5 REST API Mailing PATCH restore-queue

{{NATS5 Manual
| show_api_admin_section = true
}}
== '''PATCH /mailing/restore-queue''' ==

'''Description''' 
* Restore mail queue entry 
'''Resource URL'''
*<nowiki>http://domain/api/mailing/restore-queue</nowiki>
*Replace domain with the nats domain

'''[[NATS5_REST_API_Overview#Allowed_HTTP_Request_Methods|Request Method''']]
*PATCH
'''Response Format'''
*JSON

'''[[NATS5_REST_API_Overview#Authentication|Authentication]]'''
*HTTP headers

== '''Parameters''' ==

'''''Parameters can be sent as url encoded params

* '''queueid'''
** type: digit_list (Either a comma-separated string of digits, or a JSON array of digits)
** required

== '''Example Request''' ==
Method: '''PATCH'''<br/>
URL: <nowiki>http://domain/api/mailing/restore-queue</nowiki><br/>
Form Data:<br/>
* queueid: 1

Response:
<pre>
{
    "success": true,
    "result": "queue entries restored"
}
</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(
	'queueid' => '1',
);

$request = Array(
	'method' => 'PATCH',
	'path' => 'v1/mailing/restore-queue',
	'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_mailing_Collection]]
[[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 -->