Email 2.0 and Email API FAQ's | Community
Skip to main content
Kenneth_Law
Kenneth_Law
Level 6
June 2, 2016

Email 2.0 and Email API FAQ's

  • June 2, 2016
  • 13 replies
  • 8653 views

 

  • What is the Email API?
  • What is the Email API used for?
  • What is Email 2.0?
  • Does the Email API Work on Email 2.0 Assets?
  • Will the Email API Break when Enabling Email Experience 2.0?
  • How Are 1.0 Assets Upgraded to 2.0 Assets?
  • What to Do When an Email Was Accidentally Converted to Email 2.0 format?

 

 

What is the Email API?

API stands for Application Programming Interface and the Email API allows an automated process to create and edit emails in Marketo. There are also other API calls that involve emails, such as Approve Snippet (assuming the Snippet is used in an Email) and Clone Program (assuming the Program contains Emails). There are also API calls to create and update Email Templates. Essentially, the API can do many things that you can also do through the Marketo user interface, but then in an automated fashion.

 

 

What is the Email API used for?

There are many scenarios: an external system could create Emails in Marketo using data that lives outside of Marketo. A translation service provider could clone a master Email, translate it to many languages, then save them back into Marketo as localized Emails. A reporting system could extract Emails from Marketo to use in reports that are generated outside of Marketo. An external system could Clone a Program that contains Emails, then populate the Program Tokens and schedule the Email to be sent out at a specific time. There could be an external email template creation system that creates new Email templates in Marketo through the API.

 

 

What is Email 2.0?

“Email Experience 2.0” is the new Marketo product feature with the enhanced email editor, documented here: docs.marketo.com/display/public/DOCS/Email+Editor+v2.0+Overview. It can be switched on in Admin > Email > Edit Email Editor Settings. All Emails and Email Templates also have a version number, either 1.0 (the old version) or 2.0 (the new version). If we refer to “Email 2.0 asset” we mean an email or email template in the new upgraded 2.0 format.

 

 

Does the Email API Work on Email 2.0 Assets?

Yes.

 

 

Will the Email API Break when Enabling Email Experience 2.0?

No. Enabling Email 2.0 will not automatically upgrade Emails or Email Templates to the new 2.0 format. The Email API can still create new Emails and Email Templates in the 1.0 format.  However – after enabling Email 2.0 – any Email or Email Template that is created or edited and approved through the Marketo User Interface will automatically be upgraded to the 2.0 format.

 

 

How Are 1.0 Assets Upgraded to 2.0 Assets?

If you edit an “Approved" or “Approved with Draft” 1.0 Email with Email 2.0 enabled, the draft is converted to the 2.0 format. You can still discard the draft to go back to the approved 1.0 format. Once you approve the email and it becomes 2.0, the Email cannot be converted back to 1.0. If you edit a “Draft” 1.0 Email (never been approved), this will automatically be converted to 2.0 with no option to revert back to the 1.0 format. The same applies to Email Templates.

 

 

What to Do When an Email Was Accidentally Converted to Email 2.0 format?

If an Email or Email Template was accidentally converted to the 2.0 format, you’d have to copy the asset contents to a text editor, disable Email 2.0, then create a new 1.0 asset using the content that you copied.


    13 replies

    Grégoire_Miche2
    Grégoire_Miche2
    Level 10
    June 2, 2016

    This is probably a very important feature for template providers, MRM solutions, content management software, etc... More important than for most of mere users.

    -Greg

    Dory_Viscoglio
    Dory_Viscoglio
    Level 10
    June 8, 2016

    There could be a huge impact for us, unfortunately... At least they notified us!

    Vlada_Prasolova
    Vlada_Prasolova
    Level 5
    July 6, 2016

    that's a huge disappointment. is there a way i can create both emails v.1 AND v.2 in our instance?

    Dory_Viscoglio
    Dory_Viscoglio
    Level 10
    July 6, 2016

    Hey Vlada, as far as I understand the new editor is either on or off -- and if it's off, you can't use 2.0 templates. But I could be wrong if @Justin Cooperman​ wants to chime in here.

    Vlada_Prasolova
    Vlada_Prasolova
    Level 5
    July 6, 2016

    yes, Dory, that's how it works. Unfortunatelly, in order to use emails through API, i need v1 template and v1 email. so i have to turn 2.0 off, create it and that turn in on again. and that's very frustrating

    Dory_Viscoglio
    Dory_Viscoglio
    Level 10
    July 6, 2016

    Agreed. This is what we would have to do as well, since our daily newsletters are generated via the API. I actually haven't tested out the new templates because I'm too nervous of altering anything else that we have set up as a very large portion of our business is reliant upon our daily newsletter. They did say the ability is coming out, though. Later in Q3 probably.

    Justin_Cooperm2
    Justin_Cooperm2
    Level 10
    July 6, 2016

    I don't think that workflow you described is totally necessary. Here's what I would recommend in the interim:

    • With the feature off, create a template program with campaigns and email assets within it.
    • Turn the feature on
    • Use our API to clone that program, update your email contents, and schedule campaigns to send it. The API will work fine on that program since all the contents are 1.0 emails. Furthermore, you could even still create new emails programmatically through the API (they'll just be 1.0 emails).

    So there isn't a huge need to go back-and-forth, just set the assets up once that you are going to be using programmatically. Tons of our customers have it working like this.

    A
    Anonymous
    July 19, 2016

    Has there been any determination, or when might there be a determination in what release the Email API will support 2.0 emails?

    I'm trying to plan some Q3, Q4 projects on which the new email editor will make an impact,  but we can't enable it due to use of the Email API from an external tool.

    Even a notional time frame (narrower than "will be in 2016") would be a big help.

    A
    Anonymous
    July 21, 2016

    Is there a way to distinguish 1.0 and 2.0 emails in the list returned by REST Get Emails endpoint ?

    Justin_Cooperm2
    Justin_Cooperm2
    Level 10
    July 27, 2016

    There will be once we release the update to the API to work with both 1.0 and 2.0 emails.

    Justin

    Show more replies
    Terms & ConditionsAccessibility statement

    Loading footer...