template_name": "Sample Test_Credit_Card_Renewal_01/05/2022 14", "subject": "Subject from the template", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder anddiscover it will only take a few minutes to launch your first campaign Quantity:{{quantity}},Maket Value:{{dMarketValue}} Symbol {{symbol}}", "html_body": "abc

Hello User

" } ``` Below is the list of parameters used in a email template API request:

Parameter	Data type	Description	Example	Mandatory
template_name	string	Name of the template Note: Only alphanumeric characters, “_”(underscore) and “-”(hyphen) are supported in this field.	“Credit card renewal”	Yes
subject	string	Subject of the email	“Sample subject”	No
from	string	Sender email	“[sender@example.com](mailto:sender@example.com)”	No
text_body	string	Body of the email in text	“Hello”	No
html_body	string	Body of the email in html	"Hello"	No

> 📘 Note: > > The 'template_name’ is the only mandatory parameter for a template creation. > > Make sure to provide values to the other parameters of a template, only when you want to override the corresponding parameter values in the email API request; otherwise, you can skip providing values to the non-mandatory parameters of the template. The following response is displayed. A template with a template_id is created. ```json { "data": [ { "created_at": "2022-04-12T10:18:51.000Z", "template_id": "6ffbe894-d0c2-4159-9f54-26ca774f1a06" } ], "error": {} } ``` ## Create multiple templates You can create multiple templates with different template parameter values. The following template request creates multiple templates at a time. ```json [ { "template_name": "Sample Test_Credit_Card_Renewal_1{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" }, { "template_name": "Sample Test_Credit_Card_Renewal_2{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" }, { "template_name": "Sample Test_Credit_Card_Renewal_3{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" }, { "template_name": "Sample Test_Credit_Card_Renewal_4{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" }, { "template_name": "Sample Test_Credit_Card_Renewal_5{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" }, { "template_name": "Sample Test_Credit_Card_Renewal_6{{currentdate}}", "subject": "Sample Test_Credit_Card_Renewal", "from": "no-reply@kaleyra.com", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign.", "html_body": "" } ] ``` The following response is displayed. ```json { "data": [ { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "0527fd03-3d56-4676-8e7c-294512e0159b" }, { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "7cb7c502-cce1-40e4-a6a5-280b71ad8cbc" }, { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "06286ed2-1add-43bd-9d6d-defbca1fecdc" }, { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "e6baaafb-7e21-4fe3-a810-0b6acba2ddb1" }, { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "47b4a60f-4f97-4c06-afec-3d37cee419a1" }, { "created_at": "2022-04-12T10:46:16.000Z", "template_id": "0eeac02f-5292-4cbc-86ee-21ee045d4b39" } ], "error": [] } ``` ## Fetch a template You can fetch(search) a template by specifying the template_id with 'GET' method. Use the endpoint, **`https:///v1//email/templates//v1//email/templates/all`** **Fetch all the templates with specified pagination** You can fetch multiple templates with pagination by specifying the number of templates to be fetched in each page. To do so, add the parameters, ‘page’ and ‘limit’ to the API call. * Use the ‘page’ parameter to specify the page number. * Use the 'limit' parameter to specify the number of templates to be returned in each response. > 📘 Note: > > Make sure to give a value greater than ‘0’ (zero) for 'page' parameter. To get a specific number of templates with a specific page number, use the following endpoint with 'GET' method: [https://api.kaleyra.io/v1/email/templates?page=\{insert_page_no}&limit=](https://api.kaleyra.io/v1/email/templates?page=\{insert_page_no}\&limit=) \{insert_limit_no} Example 1: [https://api.kaleyra.io/v1//email/templates?page=1&limit=5](https://api.kaleyra.io/v1//email/templates?page=1\&limit=5) This example returns 5 templates in each response as follows: If there are 14 templates, Page 1 -> 5 Page 2 -> 5 Page 3 -> 4 (only 4 are remaining to be displayed on page 3). Example 2: [https://api.kaleyra.io/v1//email/templates?page=1&limit=4](https://api.kaleyra.io/v1//email/templates?page=1\&limit=4) If there are 14 templates, Page 1 -> 4 Page 2 -> 4 Page 3 -> 4 Page 4 -> 2 (only 2 are remaining to be displayed on page 4). ## Update a template You can update the parameter values of an existing template. To update an existing template details, use the endpoint with 'PUT' method. **`https:///v1//email/templates/`/email/templates/6ffbe894-d0c2-4159-9f54-26ca774f1a06 > 📘 Note: > > You can update only one template at a time. The following API script updates the specified template. ```json { "template_id": "6ffbe894-d0c2-4159-9f54-26ca774f1a06", "template_name": "Sample Test_Credit_Card_Renewal_12021_12_08_16_12_74", "from": "no-reply@kaleyra.email", "text_body": "", "html_body": "Hey Buddy, this is updated" } ``` The following message is displayed and the change is updated in the parameter that you specify. ```json { "data": [ { "template_id": "6ffbe894-d0c2-4159-9f54-26ca774f1a06", "updated_at": "2021-12-08T11:22:42.802Z" } ], "error": {} ``` ## Delete a template You can delete a template that you do not need. To delete an existing template details, use the endpoint with 'DELETE' method: **`https:///v1//email/templates//v1//email/templates/all`** For example: `https://api.in.kaleyra.io/v1/HXAP16XXXXXX97IN/email/templates/all` ```json { "data": [ { "deleted_count": 22, "message": "delete transaction executed" } ], "error": {} } ``` > 📘 Note: > > The 'deleted_count' indicates the total number of templates deleted. ## Use a template in an email API You can use a template while sending an email API request. To use a template in the email API request, you must specify the template_id. To send an email with a template, use the email API endpoint with 'POST' method: **`https:///v1//email`** For example: `https://api.in.kaleyra.io/v1/HXAP16XXXXXX97IN/email` **Subject in email API overrides the subject in the template** 1. When the subject in the template is empty, and the email API has a subject, then the email is delivered with the subject passed via the email API. 2. When the template has a subject and the email API does not have a subject, then the email is sent with the subject added from the template. 3. When the template has a subject and the email also has a subject, then the subject in email API takes precedence and the email is delivered with the subject from the email API. 4. When both the template and the email API do not have a subject, the email cannot be delivered as the subject in API is mandatory for the email to be delivered and you must pass a subject in the email API. ```json { "from": "no-reply@kaleyra.com", "from_name": "No Reply Email from Kaleyra", "to": "xxx@kaleyra.com", "subject": "Subject from the Email API", "template_id":"6ffbe894-d0c2-4159-9f54-26ca774f1a06", "text_body": "SMS Try our campaign builder and send a quick test to the phone number you used during the registration process. You will be amazed to discover it will only take a few minutes to launch your first campaign Quantity:{{quantity}},Maket Value:{{dMarketValue}} Symbol {{symbol}}", "html_body": "", "reply_to": "replytoEmai@kaleyra.com", } ``` The following response is shown, an email is sent to the specified recipient and in the example, the subject in the email API overrides the subject from the template. ```json { "data": [ { "message_id": "38df68cb-3096-43c7-9fb4-372beb06fe96:1", "to": "xxx@kaleyra.com", "from": "no-reply@kaleyra.com", "subject": "Subject from the Email API" } ], "error": {} } ```