Remove Template
The Remove Template method allows you to remove a template using his identoficator.
Request
IMPORTANT: Do not send more than 10 concurrent API requests.
Body Example
{
"templateId": "YOUR_TEMPLATE_ID"
}
Parameters
| Title | Type | Default | Description |
|---|---|---|---|
|
templateId required
|
string |
YOUR_TEMPLATE_ID from the Wooxy system. |
Response
{
"result": true,
"templateId":"YOUR_TEMPLATE_ID"
}
Parameters
| Title | Type | Description |
|---|---|---|
|
result |
boolean |
The request is accepted and queued:
|
|
templateId |
string |
YOUR_TEMPLATE_ID from the Wooxy system. |
Method Errors
{
"result": false,
"errors": [
"Error description text"
]
}
| Error |
|---|
|
“Argument templateId must be a non-empty string” |
|
“Template {templateId} not found in account” |
|
“Invalid authorization token!” |
|
“Internal server error” |
|
“Bad Request” |
|
“no matches found for access token {accessToken}” |
|
“user {id} not enabled” |
|
“no data found for key {userId}” |
|
“access token check failed for key\/secret $key\/$accessToken” |
|
“Argument {argument} required” |
Code Examples
$accessToken = "YOUR_API_KEY";
$url = 'https://api.wooxy.com/v3/template/email/remove';
$body = json_encode([
'templateId' => 'YOUR_TEMPLATE_ID'
]);
/**
* Request Example
*/
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTP_VERSION, CURL_HTTP_VERSION_1_1);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, false);
//curl_setopt($ch, CURLOPT_HEADER, true);
curl_setopt($ch, CURLOPT_INFILESIZE, null);
curl_setopt($ch, CURLOPT_POSTFIELDS, $body);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
"Access-Token: $accessToken",
'Content-Type: application/json',
'Content-Length: ' . strlen($body),
]);
$result = curl_exec($ch);
if ($result === false) {
echo 'cURL error:' . curl_error($ch) . PHP_EOL;
} else {
echo strval($result) . PHP_EOL;
}
curl_close($ch);