API endpoint to create an email template and associate it with the notification template

ujwal1373 · 2023-04-05T19:48:23.409Z

I was looking at the API documentation and couldn't find an API to create an email template. There is an API to create notification template and we can specify steps in the payload. The steps array has a placeholder for template object but not sure what is the format of it. I see that we can create layout and associate a step to the layout in the UI but not sure how we can do it using API. I have an email template in HTML that I wanted to use to trigger an email notification. Can someone please let me know the list of API calls required to create the template using the HTML content.

G

Gali Baum•4/9/23, 8:35 AM

{
      name: 'test email template',
      description: 'This is a test description',
      tags: ['test-tag'],
      notificationGroupId: session.notificationGroups[0]._id,
      steps: [
        {
          template: {
            name: 'Message Name',
            subject: 'Test email subject',
            preheader: 'Test email preheader',
            content: [{ type: 'text', content: 'This is a sample text block' }],
            type: 'email',
            layoutId: <LAYOUT_ID>,
          },
          filters: [
            {
              isNegated: false,
              type: 'GROUP',
              value: 'AND',
              children: [
                {
                  on: FilterPartTypeEnum.SUBSCRIBER,
                  field: 'firstName',
                  value: 'test value',
                  operator: 'EQUAL',
                },
              ],
            },
          ],
        },
      ],
    }

{
      name: 'test email template',
      description: 'This is a test description',
      tags: ['test-tag'],
      notificationGroupId: session.notificationGroups[0]._id,
      steps: [
        {
          template: {
            name: 'Message Name',
            subject: 'Test email subject',
            preheader: 'Test email preheader',
            content: [{ type: 'text', content: 'This is a sample text block' }],
            type: 'email',
            layoutId: <LAYOUT_ID>,
          },
          filters: [
            {
              isNegated: false,
              type: 'GROUP',
              value: 'AND',
              children: [
                {
                  on: FilterPartTypeEnum.SUBSCRIBER,
                  field: 'firstName',
                  value: 'test value',
                  operator: 'EQUAL',
                },
              ],
            },
          ],
        },
      ],
    }

{
      name: 'test email template',
      description: 'This is a test description',
      tags: ['test-tag'],
      notificationGroupId: session.notificationGroups[0]._id,
      steps: [
        {
          template: {
            name: 'Message Name',
            subject: 'Test email subject',
            preheader: 'Test email preheader',
            content: [{ type: 'text', content: 'This is a sample text block' }],
            type: 'email',
            layoutId: <LAYOUT_ID>,
          },
          filters: [
            {
              isNegated: false,
              type: 'GROUP',
              value: 'AND',
              children: [
                {
                  on: FilterPartTypeEnum.SUBSCRIBER,
                  field: 'firstName',
                  value: 'test value',
                  operator: 'EQUAL',
                },
              ],
            },
          ],
        },
      ],
    }

{
      name: 'test email template',
      description: 'This is a test description',
      tags: ['test-tag'],
      notificationGroupId: session.notificationGroups[0]._id,
      steps: [
        {
          template: {
            name: 'Message Name',
            subject: 'Test email subject',
            preheader: 'Test email preheader',
            content: [{ type: 'text', content: 'This is a sample text block' }],
            type: 'email',
            layoutId: <LAYOUT_ID>,
          },
          filters: [
            {
              isNegated: false,
              type: 'GROUP',
              value: 'AND',
              children: [
                {
                  on: FilterPartTypeEnum.SUBSCRIBER,
                  field: 'firstName',
                  value: 'test value',
                  operator: 'EQUAL',
                },
              ],
            },
          ],
        },
      ],
    }

G

Gali Baum•4/9/23, 8:36 AM

Something like this structure

G

Gali Baum•4/9/23, 8:37 AM

For the layout , you should use the layout creation api call https://docs.novu.co/api/layout-creation/

G

Gali Baum•4/9/23, 8:38 AM

and then you could use the layout id you get in the response either in the create notification->steps->template inside layoutId

G

Gali Baum•4/9/23, 8:40 AM

Or use the update notification template to update the layoutId for a step

G

Gali Baum•4/9/23, 8:42 AM

You could look at some examples in our tests like: https://github.com/novuhq/novu/blob/8eeb340982b1e4abb363f7b4643bb479c7088739/apps/api/src/app/notification-template/e2e/create-notification-templates.e2e.ts

G

Gali Baum•4/9/23, 8:43 AM

https://github.com/novuhq/novu/blob/7e689da12e248b9fa4cb73611e0fbbd597692bce/apps/api/src/app/notification-template/e2e/update-notification-template.e2e.ts

G

Gali Baum•4/9/23, 8:45 AM

@Ujwal Let me know how it goes

P

Pawan Jain•4/16/23, 7:19 PM

Hi @Ujwal
do you need more help in this?

U

ujwal1373OP•4/18/23, 12:16 PM

@galiainouz Thanks for your help. That worked!

U

ujwal1373OP•4/18/23, 12:17 PM

@Pawan Jain Hi Pawan. I'm good, don't need anymore help on this.

API endpoint to create an email template and associate it with the notification template

Similar Threads

Similar Threads

Similar Threads