Setting up email templates

From DreamFactory
Jump to: navigation, search
DreamFactoryTutorialsSetting up email templates
(Tutorial)
(Setup Email Templates using admin console.)
Line 4: Line 4:
 
templates using the admin console or by calling API endpoints directly.
 
templates using the admin console or by calling API endpoints directly.
  
=== Setup Email Templates using admin console. ===
+
=== Set up Email Templates using admin console. ===
  
Login to the admin console and click on the 'Config' tab. Click on 'Email Templates' from the left navigation menu. The  
+
Log in to the admin console and click on the 'Config' tab. Click on 'Email Templates' from the left navigation menu. The  
 
'Email Templates Overview' form lets you create a new template as well as edit an existing template. You can edit an existing  
 
'Email Templates Overview' form lets you create a new template as well as edit an existing template. You can edit an existing  
 
template by selecting it from the '-- Select Email Template --' drop down box. Or click on the [+] (plus) button to create  
 
template by selecting it from the '-- Select Email Template --' drop down box. Or click on the [+] (plus) button to create  
a new template. Fill in the template form and create your template.  
+
a new template. Fill in the template form and create your template.
  
 
=== API Endpoints ===
 
=== API Endpoints ===

Revision as of 22:33, 15 July 2016

Tutorial

DreamFactory supports email templates that you can use in your email sent out by the email services. You can set up email templates using the admin console or by calling API endpoints directly.

Set up Email Templates using admin console.

Log in to the admin console and click on the 'Config' tab. Click on 'Email Templates' from the left navigation menu. The 'Email Templates Overview' form lets you create a new template as well as edit an existing template. You can edit an existing template by selecting it from the '-- Select Email Template --' drop down box. Or click on the [+] (plus) button to create a new template. Fill in the template form and create your template.

API Endpoints

Creating new Email Template

POST http://{url}/api/v2/system/email_template

Request Body:

{
    "resource": [
        {
            "name": "",
            "description": "",
            "to": "",
            "cc": "",
            "bcc": "",
            "subject": "",
            "body_text": "",
            "body_html": "",
            "from_name": "",
            "from_email": "",
            "reply_to_name": "",
            "reply_to_email": ""
        }
    ]
}

Editing an existing Email Template

PATCH http://{url}/api/v2/system/email_template/{template_id}

Request Body:

{
    "name": "",
    "description": "",
    "to": "",
    "cc": "",
    "bcc": "",
    "subject": "",
    "body_text": "",
    "body_html": "",
    "from_name": "",
    "from_email": "",
    "reply_to_name": "",
    "reply_to_email": ""
}

Example - Creating a new Email Template

  • Request Body:
{
    "resource":[
        {
            "name": "sales",
            "description": "An email template for sending out sales email.",
            "to": "[email protected]",
            "cc": "[email protected]",
            "bcc": "[email protected]",
            "subject": "Weekly sales report",
            "body_text": "Text body goes here",
            "body_html": "Html body goes here",
            "from_name": "Jane Doe",
            "from_email": "[email protected]",
            "reply_to_name": "Jane Doe",
            "reply_to_email": "[email protected]"
        }
    ]
}
  • Request URL:
POST http://foo.com/api/v2/system/email_template

Example - Editing an existing Email Template

  • ID of the template to edit: 1
  • Request Body:
{
    "name": "sales",
    "description": "An email template for sending out sales email.",
    "to": "[email protected]",
    "cc": "[email protected]",
    "bcc": "[email protected]",
    "subject": "Weekly sales report",
    "body_text": "Text body goes here",
    "body_html": "Html body goes here",
    "from_name": "Jane Doe",
    "from_email": "[email protected]",
    "reply_to_name": "Jane Doe",
    "reply_to_email": "[email protected]"
}
  • Request URL:
PATCH http://foo.com/api/v2/system/email_template/1

Example - Editing a single field of an existing Email Template

  • ID of the template to edit: 1
  • Field to edit: from_email
  • Request Body:
{
    "from_email": "[email protected]"
}
  • Request URL:
PATCH http://foo.com/api/v2/system/email_template/1