substitutions don't work in transactional templates #638

mckravchyk · 2017-12-08T09:41:12Z

Issue Summary

Substitutions don't work when using this library. It works when using curl.

Steps to Reproduce

Create a transactional email template in your SendGrid account
Have either <%body%> in the template, %firstName% or both (I tried both)
Execute this node code (fill in the config)

`'use strict';

var config = {
	
	apiKey: '',
	from: '',
	to: '',
	templateId: ''

}
 
const sgMail = require('@sendgrid/mail');
sgMail.setApiKey(config.apiKey);
 
async function sendTest() {
 
 var newMsg = {
  
   "from": {
    "name": "Test Script",
    "email": config.from
   },
   "personalizations": [{
    "to": config.to,
    "substitutions": {
     "-firstName-": "Maciejs", 
     "%firstName%": "Maciej",
	 "-first_name": "Maciej",
	 "%first_name%": "Maciej"
    }
   }],
   "subject": "test subject",
   "content": [{
     "type": "text/plain",
     "value": "Hello, %firstName%!"
    },
    {
     "type": "text/html",
     "value": "<html><p>Hello, %firstName%!</html> "
    }],
    "template_id": config.templateId
 }
 
   await sgMail.send(newMsg);
 
}
 
sendTest();`

Notice that nothing will be replaced in the delivered email. Again, it works perfectly with curl.

I'm also attaching a screenshot of the template in SendGrid editor and the email I get

Technical details:

sendgrid-nodejs Version: 6.1.4
Node.js Version: 8.9.2

The text was updated successfully, but these errors were encountered:

kmcurry · 2017-12-12T00:57:03Z

@MaciejKrawczyk Have you tried using setSubstitutionWrapper and omitting the wrappers from the substitutions?

Ex:
sgMail.setSubstitutionWrappers('-', '-');
"substitutions": { "firstName": "Maciejs" }

Not sure how you'd do multiple wrappers at once this way, but I was able to get subs working with this version by not specifying the wrappers in the substitution attribute. My subs look like
emailOptions.substitutions = {}
emailOptions.substitutions.CLIENT_NAME = myClientName

mckravchyk · 2017-12-12T19:01:44Z

It works. Thank you!

thinkingserious · 2017-12-14T06:47:09Z

Thanks for jumping in to help @kmcurry!

I'm glad you are up and running @MaciejKrawczyk!

LASkuma · 2018-01-25T21:39:46Z

This should be definitely put in the README! Cost me 2hrs to figure this out!

thinkingserious · 2018-01-26T03:06:14Z

@LASkuma,

That's no good :(

Does this documentation help? If so, could you point me where you first looked for help so I can make sure we have a clear link there?

Thanks!

With Best Regards,

Elmer

LASkuma · 2018-01-26T04:08:55Z

@thinkingserious Yes. This doc did help a lot. However, since I came from the official website, where the substitution keys should include the wrapper, I didn't pay too much attention to the use cases.

thinkingserious · 2018-01-26T04:34:31Z

Hi @LASkuma,

When you say you came from the official website, could you please let me know what URL you are referring to? Thanks!

LASkuma · 2018-01-26T20:56:17Z

Hi @thinkingserious,
I was referring to this page. Even the try it out section have substitution keys with the wrappers included. After reading the documentation, I thought the Node library was naturally consistent with the documentation.

thinkingserious · 2018-01-26T22:36:13Z

Thanks @LASkuma!

That's really helpful feedback.

I'm not quite sure on the solution though. Those documents are for those who wish to interact with our API directly vs. use one of our helper libraries.

Earlier you mentioned that we should include this documentation in the README. Do you mean here? Should we specifically call out the substitution use case there?

Thanks again for your help!

With Best Regards,

Elmer

mckravchyk · 2018-01-28T11:37:06Z

This should definitely be on the readme. I tried everything, I read all docs on the SendGrid api reference , everything that's on GitHub (I thought), contacted support and I would be making my own api wrapper if not for @kmcurry I think it would be much more easier and less confusing if the helper library would work exactly like the API itself (see my code at the beginning of the thread).

thinkingserious · 2018-01-31T00:30:46Z

Thanks @MaciejKrawczyk,

This is very good feedback and I've added this to our team's backlog for a deeper dive. We will provide updates on this thread.

Thanks!

With Best Regards,

Elmer

sriharrsha · 2018-03-21T06:23:47Z

Is this done? I'm having the same issue;

thinkingserious · 2018-03-22T20:15:08Z

Hi @sriharrsha,

Have you tried @kmcurry's suggestion?

harrshasri · 2018-03-28T04:44:35Z

Not yet. I will update if it works or not soon.
Sorry for the late reply.

tkafka · 2018-08-07T07:38:43Z

To everyone as desperate as me yesterday: in v3 API you need to use dynamic_template_data instead of substitutions, this isn't yet documented anywhere!

Then use {{var_name}} in email template and dynamic_template_data: { var_name: "var_value" } in API call.

nunsie · 2018-08-17T11:21:00Z

@tkafka oh my god! thanks for this man, been pulling my hair out on this for the past 2 days.

crysxd · 2018-08-18T17:19:22Z

@tkafka Thanks a lot! This is so frustrating! Took me 3hrs of my day...

Here is the entire code in case somebody is looking for the same:

var sendgrid = require('@sendgrid/mail');
sendgrid.setApiKey(env.sendgridApiKey);
sendgrid.setSubstitutionWrappers('{{', '}}');

var newMsg = {
      "from": {
       "name": "Your Company",
       "email": env.businessEmail
      },
      "personalizations": [{
       "to": order.email,
       "dynamic_template_data": {"order_id": "1234", "first_name": "Max", "last_name": "Mustermann"}
      }],
      "subject": "test subject",
      "content": [{
        "type": "text/plain",
        "value": "Hello, {{firstName}}!"
       },
       {
        "type": "text/html",
        "value": "<html><p>Hello, {{'firstName}}!</html> "
       }],
       "template_id": env.sendgridOrderConfirmationTemplateId
    };
    console.log("Sending confirmation email...")
    return sendgrid.send(newMsg);

The documentation of sendgrid is horrible to say the least.

thinkingserious · 2018-08-21T00:47:43Z

Hello Everyone,

Please see this issue for progress. We are currently working on the update for C#, then Java, then this SDK is right after that. Thanks for your patience and my apologies for the delay.

With Best Regards,

Elmer

xduseko · 2018-10-18T12:08:49Z

Hah, dynamic_template_data. I solved your little puzzle! 😄

For other typescript users - Create file mail.d.ts:

import {MailData} from "@sendgrid/helpers/classes/mail";

// see https://github.com/sendgrid/sendgrid-nodejs/issues/638

declare module "@sendgrid/helpers/classes/mail" {
	export interface MailData {
		dynamic_template_data: {[key: string]: string};
	}
}

kvarela · 2018-10-22T18:33:13Z

Thank you @xduseko !

thinkingserious added type: community enhancement feature request not on Twilio's roadmap status: help wanted requesting help from the community difficulty: medium fix is medium in difficulty up-for-grabs labels Mar 5, 2018

thinkingserious closed this as completed Aug 30, 2018

robertu7 mentioned this issue Oct 16, 2020

fix(verification): use dynamic template data instead of substitutions thematters/matters-email#47

Merged

childish-sambino removed the help wanted label Mar 31, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

substitutions don't work in transactional templates #638

substitutions don't work in transactional templates #638

mckravchyk commented Dec 8, 2017

kmcurry commented Dec 12, 2017

mckravchyk commented Dec 12, 2017

thinkingserious commented Dec 14, 2017

LASkuma commented Jan 25, 2018

thinkingserious commented Jan 26, 2018

LASkuma commented Jan 26, 2018

thinkingserious commented Jan 26, 2018

LASkuma commented Jan 26, 2018

thinkingserious commented Jan 26, 2018

mckravchyk commented Jan 28, 2018

thinkingserious commented Jan 31, 2018

sriharrsha commented Mar 21, 2018 •

edited

Loading

thinkingserious commented Mar 22, 2018

harrshasri commented Mar 28, 2018

tkafka commented Aug 7, 2018

nunsie commented Aug 17, 2018 •

edited

Loading

crysxd commented Aug 18, 2018

thinkingserious commented Aug 21, 2018

xduseko commented Oct 18, 2018 •

edited

Loading

kvarela commented Oct 22, 2018

substitutions don't work in transactional templates #638

substitutions don't work in transactional templates #638

Comments

mckravchyk commented Dec 8, 2017

Issue Summary

Steps to Reproduce

Technical details:

kmcurry commented Dec 12, 2017

mckravchyk commented Dec 12, 2017

thinkingserious commented Dec 14, 2017

LASkuma commented Jan 25, 2018

thinkingserious commented Jan 26, 2018

LASkuma commented Jan 26, 2018

thinkingserious commented Jan 26, 2018

LASkuma commented Jan 26, 2018

thinkingserious commented Jan 26, 2018

mckravchyk commented Jan 28, 2018

thinkingserious commented Jan 31, 2018

sriharrsha commented Mar 21, 2018 • edited Loading

thinkingserious commented Mar 22, 2018

harrshasri commented Mar 28, 2018

tkafka commented Aug 7, 2018

nunsie commented Aug 17, 2018 • edited Loading

crysxd commented Aug 18, 2018

thinkingserious commented Aug 21, 2018

xduseko commented Oct 18, 2018 • edited Loading

kvarela commented Oct 22, 2018

sriharrsha commented Mar 21, 2018 •

edited

Loading

nunsie commented Aug 17, 2018 •

edited

Loading

xduseko commented Oct 18, 2018 •

edited

Loading