Create Template
The Create Template method allows you to create a template for sending email.
Request
IMPORTANT: Do not send more than 10 concurrent API requests.
Body Example
{
"name": "Template name",
"subject": "Hello subject",
"html": "Hello, World!"
}
Parameters
Title | Type | Default | Description |
---|---|---|---|
name required
|
string |
Name of your template. |
|
subject required
|
string |
The Email subject. |
|
html required
|
string |
The full HTML or text content of the template. |
Response
{
"result": true,
"templateId": "YOUR_NEW_TEMPLATE_ID"
}
Parameters
Title | Type | Description |
---|---|---|
result |
boolean |
The request is accepted and queued:
|
templateId |
string |
A unique Template ID assigned in the Wooxysystem is used to match the specific Email Template. |
Method Errors
{
"result": false,
"errors": [
"Error description text"
]
}
Error |
---|
“Argument name must be a non-empty string with max length within 255 characters” |
“Argument subject must be a non-empty string” |
“Twig syntax error” |
“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}” |
“Argument subject must be a non-empty string” |
“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/create';
$body = json_encode([
'name' => 'Template name',
'subject' => 'Hello subject',
'html' => 'Hello, World!',
]);
/**
* 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);