Email Activity Format

The version 2 email activity, also known as send email activity, allows you to send email messages from within your journeys. This activity type can’t be used in a custom activity.

Existing version 1 email activities remain in the legacy format and function as normal until they are edited. When a marketer edits and saves a send email activity, Journey Builder automatically upgrades the activity by mapping the data to the version 2 format.

Warning

Journey Specification Format

The activity must be formatted as specified below. The following JSON object is included in the activities array of a journey, as defined in the Journey Specification.

Helpful Hints

The email activity creates a triggered send which it uses during runtime to deliver the email message.
- When a journey is unpublished, the triggered send is set to inactive.
- If the activity is republished, the triggered send is reactivated to keep reporting numbers for accurate versions.
You can obtain the sender profile ID and delivery profile ID by going to Email Studio > Admin > Delivery Settings.
The email you configure for use with this activity must meet certain delivery standards.
- Contain a Profile Center link
- Pass validations
- Contain only valid AmpScript and SSJS
- Must not contain any errors
If an exception occurs while publishing the journey containing an invalid email, the errors will display in the Journey Builder UI.

Sample Request

1{
2    "type": "EMAILV2",
3    "key": "<activity key>",
4    "name": "<activity name>",
5    "applicationId": "<GUID>",
6    "outcomes": [
7        {
8            "key": "<outcome key>",
9            "next": "<key of next activity>"
10        }
11    ],
12    "metaData":{
13        "icon":"/img/email-icon.svg",
14        "iconSmall":"/img/email-icon.svg",
15        "category":"message",
16        "version":"1.0",
17        "isConfigured":true
18    },
19    "configurationArguments":{
20        "triggeredSend":{
21            "emailId":"<email id>",
22            "emailSubject": "<subject>",
23            "preHeader":"<preheader>",
24            "description":"<description>",
25            "campaigns":[
26                {
27                    "id":"<campaign id>",
28                    "name":"<campaign name>",
29                    "color":"<campaign color>"
30                }
31            ],
32            "sendClassificationId":"<send classification id>",
33            "senderProfileId":"<sender profile id>",
34            "deliveryProfileId":"<delivery profile id>",
35            "publicationListId":"<publication list id>",
36            "suppressionLists":[
37                {
38                    "name":"<suppression list name>",
39                    "id":"<suppression list id>"
40                }
41            ],
42            "domainExclusions":[
43                {
44                    "name":"<domain exclusion name>",
45                    "id":"<domain exclusion id>"
46                }
47            ],
48            "exclusionFilter":"<exclusion script>",
49            "isTrackingClicks":true,
50            "isMultipart":true,
51            "isSendLogging":true,
52            "suppressTracking":true,
53            "ccEmail":"<cc email>",
54            "bccEmail":"<bcc email>",
55            "keyword":"<keyword>",
56            "throttleLimit":500,
57            "throttleOpens":"12:00",
58            "throttleCloses":"12:30",
59            "isSalesforceTracking":true
60        }
61    }
62}

Sample Response

1{
2     "id": "<GUID>",
3     "key":"<activity key>",
4     "name":"<activity name>",
5     "type":"EMAILV2",
6     "outcomes":[
7         {
8             "next": "<key of next activity>"
9             "arguments":{},
10             "metaData":{}
11         }
12     ],
13     "arguments":{
14
15     },
16     "configurationArguments":{
17         "triggeredSend":{
18             "emailId":"<email id>",
19             "emailSubject": "<subject>",
20             "preHeader":"<preheader>",
21             "description":"<description>",
22             "campaigns":[
23                 {
24                     "id":"<campaign id>",
25                     "name":"<campaign name>",
26                     "color":"<campaign color>"
27                 }
28             ],
29             "sendClassificationId":"<send classification id>",
30             "senderProfileId":"<sender profile id>",
31             "deliveryProfileId":"<delivery profile id>",
32             "publicationListId":"<publication list id>",
33             "suppressionLists":[
34                 {
35                     "name":"<suppression list name>",
36                     "id":"<suppression list id>"
37                 }
38             ],
39             "domainExclusions":[
40                 {
41                     "name":"<domain exclusion name>",
42                     "id":"<domain exclusion id>"
43                 }
44             ],
45             "exclusionFilter":"<exclusion script>",
46             "isTrackingClicks":true,
47             "isMultipart":true,
48             "isSendLogging":true,
49             "suppressTracking":true,
50             "ccEmail":"<cc email>",
51             "bccEmail":"<bcc email>",
52             "keyword":"<keyword>",
53             "throttleLimit":500,
54             "throttleOpens":"12:00",
55             "throttleCloses":"12:30",
56             "isSalesforceTracking":true
57         }
58     },
59     "metaData":{
60         "icon":"/img/email-icon.svg",
61         "iconSmall":"/img/email-icon.svg",
62         "category":"message",
63         "version":"1.0",
64         "isConfigured":true
65     }
66}

Related Items

Journey Specification