Skip to content

Salesforce Marketing Cloud Connector ReferenceΒΆ

The following operations allow you to work with the Salesforce Marketing Cloud connector. Click an operation name to see parameter details and samples on how to use it.

Initialize the connectorΒΆ

To use the Salesforce Marketing Cloud connector, first create the connection with your configuration. When calling a Salesforce Marketing Cloud operation, ensure the connection is referenced using the configKey attribute.

init

The init operation initializes the connection to Salesforce Marketing Cloud REST API.

Parameter Name Description Required
connectionName The name for the Salesforce Marketing Cloud connection. Yes
subdomain Your Salesforce Marketing Cloud subdomain. Yes
clientId Client ID issued when you create the API integration in Installed Packages. Yes
clientSecret Client secret issued when you create the API integration in Installed Packages. Yes
accountId Account identifier, or MID, of the target business unit. No

Sample configuration

    <salesforceMarketingCloud.init>
        <connectionType>SALESFORCEMARKETINGCLOUD</connectionType>
        <subdomain>REPLACE_WITH_SUB_DOMAIN</subdomain>
        <clientId>REPLACE_WITH_CLIENT_ID</clientId>
        <clientSecret>REPLACE_WITH_CLIENT_SECRET</clientSecret>
        <name>SFMC_CON</name>
    </salesforceMarketingCloud.init>

OperationsΒΆ

createAsset

The createAsset operation creates a new asset.

Parameter Name Description Required
payload The properties required to create a new asset. Required if inputStructure is INLINE
customerKey Reference to customer's private ID/name for the asset. Required if inputStructure is FORM
contentType The type that the content attribute will be in. No
data Property bag containing the asset data. No
assetType The type of the asset saved as a name/ID pair. Required if inputStructure is FORM
version The version of the asset. No
locked Specifies if the asset can be modified or not. No
fileProperties Properties referred to by the asset if it is a file type. No
name Name of the asset, set by the client. 200 character maximum. Required if inputStructure is FORM
description Description of the asset, set by the client. No
category ID of the category the asset belongs to. No
tags List of tags associated with the asset. No
content The actual content of the asset. No
design Fallback for display when neither content nor supercontent are provided. No
superContent Content that supersedes content in terms of display. No
customFields Custom fields within an asset. No
views Views within an asset. No
blocks Blocks within the asset. No
minBlocks Minimum number of blocks within an asset. No
maxBlocks Maximum number of blocks within an asset. No
channels List of channels that are allowed to use this asset. No
allowedBlocks List of blocks that are allowed in the asset. No
slots Slots within the asset. No
businessUnitAvailability A dictionary of member IDs that have been granted access to the asset. No
template Template the asset follows. No
file Base64-encoded string of a file associated with an asset. No
generateFrom Indicates which view to use to generate this view’s content. No
sharingProperties Allows you to share content with business units with Content Builder Sharing enabled. No
sharingProperties.sharedWith List of MID IDs the asset is shared with. No
sharingProperties.sharingType Permission granted to MIDs in sharedWith (view, edit, or local). No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createAsset configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createAsset>

Sample request

{
    "body": {
        "assetType": {
            "name": "htmlemail",
            "id": 208
        },
        "name": "Example Email Created via API",
        "customerKey": "MyUniqueEmailAssetKey",
        "views": {
            "html": {
                "content": "<html><body><p>Hello, this is an email from the SFMC API!</p></body></html>"
            }
        }
    }
}
Create Campaign

The Create Campaign operation creates a new marketing campaign with defined objectives, target audience, and parameters.

Parameter Name Description Required
payload The properties required to create a new campaign. Required if inputStructure is INLINE
name The name of the campaign. Required if inputStructure is FORM
description A description of the campaign. No
campaignCode A campaign code to associate with the campaign. No
color The color used to identify the campaign in the Marketing Cloud Engagement web interface, expressed as an HTML color code. No
favorite Indicates whether to identify the campaign as a favorite. No

Sample configuration for "INLINE"

<SalesforceMarketingCloud.createCampaign configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</SalesforceMarketingCloud.createCampaign>

Sample request

{
    "body": {
        "name": "Final Hours for Summer Sale",
        "description": "Invite our most engaged customers to shop our Summer Sale before it ends.",
        "campaignCode": "summer2023",
        "color": "800080",
        "favorite": false
    }
}
createCategory

The createCategory operation creates a category (folder) in content builder.

Parameter Name Description Required
payload The properties required to create a new category. Required if inputStructure is INLINE
name Name of the category. Required if inputStructure is FORM
parentId ID of the parent category. Required if inputStructure is FORM
categoryType The type of category, either asset or asset-shared, automatically set to match the parent. If asset-shared, include SharingProperties. No
enterpriseId ID of the enterprise this business unit belongs to. No
memberId ID of the member who creates the category. No
description Description of the category. No
sharingProperties Allows sharing the category with business units with Content Builder Sharing enabled. Includes MIDs and sharing type. No
sharingProperties.sharedWith List of up to 100 MID IDs the category is shared with. Use 0 to share across the enterprise if enabled. No
sharingProperties.sharingType Permission for MIDs in sharedWith. Only possible value for categories is edit. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createCategory configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createCategory>

Sample request

{
    "body": {
        "name": "My New Folder",
        "parentId": 50923,
        "enterpriseId": 123456,
        "categoryType": "asset"
    }
}
createContact

The createContact operation creates a new contact with the specified information in the specified attribute groups.

Parameter Name Description Required
payload The properties required to create a new contact. Required if inputStructure is INLINE
contactKey Primary address for the contact. You must provide either a value for contactKey or contactID. Required if inputStructure is FORM
contactID Unique ID for the contact. You must provide either a value for contactKey or contactID. No
attributeSets Array of information used to create a new contact. Required if inputStructure is FORM
attributeSets.name Required. Name of attribute group to which to add the contact information. Required if inputStructure is FORM
attributeSets.values Name and value pairs indicating the attribute and applicable value. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createContact configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createContact>

Sample request

{
    "body": {
        "contactKey": "[email protected]",
        "attributeSets": [
            {
                "name": "Email Addresses",
                "items": [
                    {
                        "values": [
                            {
                                "name": "Email Address",
                                "value": "[email protected]"
                            },
                            {
                                "name": "HTML Enabled",
                                "value": true
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
createJourney

The createJourney operation creates or saves a journey.

Parameter Name Description Required
payload The properties required to create a new journey. Required if inputStructure is INLINE
key Required. The customer key as a GUID (UUID) to be used while referencing this journey. Required if inputStructure is FORM
name Required. The name of this journey. Required if inputStructure is FORM
description A description of this journey. No
workflowApiVersion Required. The Journey Spec version to use for this journey. Possible values: 0.5, 1.0. Required if inputStructure is FORM
goals The goal for this particular journey. Expressed as an object of type ContactDecision from the Journey Spec. No
triggers The trigger for this particular journey. Expressed as an object of type ContactEvent from the Journey Spec. No
activities The activities which compose this particular journey. Expressed as objects of types supported by the Journey Spec. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createJourney configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createJourney>

Sample request

{
    "body": {
        "key": "b3102b1f-3fa1-478f-9ca9-665b551e13e6",
        "name": "My Journey",
        "workflowApiVersion": 1.0,
        "description": "A journey created via the API",
        "goals": [],
        "triggers": [],
        "activities": []
    }
}
createEmailDefinition

The createEmailDefinition operation creates a long-living send definition object that references the email template, subscriber list, sending options, journey, and metadata.

Parameter Name Description Required
payload The properties required to create a new email definition. Required if inputStructure is INLINE
definitionKey Required. Unique, user-generated key to access the definition object. Required if inputStructure is FORM
name Required. Name of the definition. Must be unique. Required if inputStructure is FORM
content.customerKey Required. Unique identifier of the content asset. Required if inputStructure is FORM
status Operational state of the definition: active, inactive, or deleted. No
description User-provided description of the send definition. No
classification The external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. No
subscriptions.list Required. The external key of the list or all subscribers. Contains the subscriber keys and profile attributes. Required if inputStructure is FORM
subscriptions.dataExtension The external key of the triggered send data extension. No
subscriptions.autoAddSubscriber Adds the recipient’s email address and contact key as a subscriber key to subscriptions.list. Default is true. No
subscriptions.updateSubscriber Updates the recipient’s contact key as a subscriber key. Default is true. No
options.trackLinks Wraps links for tracking and reporting. Default is true. No
options.cc Include CC email addresses with every send. Can use %%attribute%% syntax for dynamic CCs. No
options.bcc Include BCC email addresses with every send. Can use %%attribute%% syntax for dynamic BCCs. No
options.createJourney Marks the definition as available for use in Journey Builder as a Transactional Send Journey. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createEmailDefinition configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createEmailDefinition>

Sample request

{
    "body": {
        "definitionKey": "MySendDefinitionKey",
        "name": "MySendDefinition",
        "content": {
            "customerKey": "2ac9d669-59d0-4cf0-aa1f-da6cbf667f1f"
        },
        "status": "Active",
        "description": "Send definition for marketing emails",
        "classification": "default transactional",
        "subscriptions": {
            "list": "MY_PUBLICATION_LIST_KEY",
            "dataExtension": "AB8F0F80-065C-4B1C-85FC-545DB1D55768",
            "autoAddSubscriber": true,
            "updateSubscriber": true
        },
        "options": {
            "trackLinks": true
        }
    }
}
createSmsDefinition

The createSmsDefinition operation creates an sms send definition.

Parameter Name Description Required
payload The properties required to create a new SMS definition. Required if inputStructure is INLINE
definitionKey Required. Unique, user-generated key to access the definition object. Required if inputStructure is FORM
name Required. Name of the definition. Must be unique. Required if inputStructure is FORM
content.message Required. The message content that you want sent with each message. Use substitution strings and AMPscript to personalize the message. Required if inputStructure is FORM
status Operational state of the definition: active, inactive, or deleted. No
description User-provided description of the send definition. No
subscriptions.shortCode Required. The short or long code for the mobile transmissions for each message on this definition. Required if inputStructure is FORM
subscriptions.countryCode The country code associated with the shortCode. Don't use for long codes unless required by your account configuration. No
subscriptions.keyword Required. The keyword used to track messages. Required if inputStructure is FORM
subscriptions.autoAddSubscriber Allows you to add a recipient as a subscriber using contactKey. When false, the message is rejected if contactKey doesn't exist as a subscriber. No
options.urlShortenerOptions.IsLinkShorteningEnabled Indicates if URL shortening is enabled for URLs in the message body. No
options.urlShortenerOptions.isSubscriberTrackingEnabled Indicates if subscriber-level tracking is enabled. Required if shortenerType is SFMC. No
options.urlShortenerOptions.shortenerType The type of URL shortener. The value is SFMC. No
options.SmsMessageRegulatoryAuthorityTemplateId The ID of the DLT template used in the SMS. Available only for customers in India. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.createSmsDefinition configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.createSmsDefinition>

Sample request

{
    "body": {
        "definitionKey": "account-reset",
        "name": "account-reset",
        "description": "Using SMS Transactional API",
        "content": {
            "message": "%%FirstName%%, your 2FA token is %%password%%"
        },
        "subscriptions": {
            "shortCode": "8201221",
            "countryCode": "US",
            "keyword": "PASSWORD"
        },
        "options": {
            "urlShortenerOptions": {
                "isLinkShorteningEnabled": true,
                "isSubscriberTrackingEnabled": true,
                "shortenerType": "SFMC"
            },
            "smsMessageRegulatoryAuthorityTemplateId": "1107170833298425627"
        }
    }
}
getAssets

The getAssets operation retrieves an asset collection by simple filter parameters.

Parameter Name Description Required
page Page number to return from the paged results. No
pagesize Number of results per page to return. No
orderBy Determines which asset property to use for sorting, and also determines the direction in which to sort the data. No
filter Filter by an asset's property using a simple operator and value. No
fields Comma-delimited string of asset properties used to reduce the size of your results to only the properties you need. No

Sample configuration

<salesforceMarketingCloud.getAssets configKey="SFMC_CON">
    <page>{${payload.page}}</page>
    <pagesize>{${payload.pagesize}}</pagesize>
    <orderBy>{${payload.orderBy}}</orderBy>
    <filter>{${payload.filter}}</filter>
    <fields>{${payload.fields}}</fields>
</salesforceMarketingCloud.getAssets>

Sample request

{
    "page": 1,
    "pagesize": 10,
    "orderBy": "assetId asc",
    "filter": "status eq 'active'",
    "fields": "assetId,name,status"
}
getCampaigns

The getCampaigns operation retrieve a list of campaigns in your account.

Parameter Name Description Required
page Page number to return from the paged results. No
pagesize Number of results per page to return. No
orderBy The field and sort method to use to sort the results. No

Sample configuration

<SalesforceMarketingCloud.getCampaigns configKey="SFMC_CON">
    <page>{${payload.page}}</page>
    <pagesize>{${payload.pagesize}}</pagesize>
    <orderBy>{${payload.orderBy}}</orderBy>
</SalesforceMarketingCloud.getCampaigns>

Sample request

```json { "page": 1, "pagesize": 10, "orderBy": "assetId asc", "filter": "status eq 'active'", "fields": "assetId,name,status" }

getContactDeleteRequests

The getContactDeleteRequests operation retrieves details of contact delete requests for a date range.

Parameter Name Description Required
startdateutc Start date and time in UTC of the date range. No
enddateutc End date and time in UTC of the date range. No
statusid Delete request status ID. No
page Page number to return from the paged results. No
pagesize Number of results per page to return. No
orderBy Determines which asset property to use for sorting, and also determines the direction in which to sort the data. No

Sample configuration

<salesforceMarketingCloud.getContactDeleteRequests configKey="SFMC_CON">
    <startdateutc>{${payload.startdateutc}}</startdateutc>
    <enddateutc>{${payload.enddateutc}}</enddateutc>
    <statusid>{${payload.statusid}}</statusid>
    <page>{${payload.page}}</page>
    <pagesize>{${payload.pagesize}}</pagesize>
    <orderBy>{${payload.orderBy}}</orderBy>
</salesforceMarketingCloud.getContactDeleteRequests>

Sample request

{
    "startdateutc": "2021-01-01T00:00:00Z",
    "enddateutc": "2021-01-31T23:59:59Z",
    "statusid": 1,
    "pagesize": 50,
    "page": 1,
    "orderBy": "status asc"
}
getJourneys

The getJourneys operation retrieves a list of journeys.

Parameter Name Description Required
page The page number of results to retrieve. No
pageSize The number of items to return on a page of results. No
orderBy The field and sort method to use to sort the results. You can sort on these fields: ModifiedDate, Name, Performance. No

Sample configuration

<salesforceMarketingCloud.getJourneys configKey="SFMC_CON">
    <page>{${payload.page}}</page>
    <pageSize>{${payload.pageSize}}</pageSize>
    <orderBy>{${payload.orderBy}}</orderBy>
</salesforceMarketingCloud.getJourneys>

Sample request

{
    "orderBy": "modifiedDate DESC",
    "page": 1,
    "pageSize": 50
}
getCategories

The getCategories operation returns one or more content builder categories that are owned by or reside in your mid.

Parameter Name Description Required
page Page number to return from the paged results. Start with 1 and continue until you get zero results. Typically provided along with the pagesize parameter. No
pagesize Number of results per page to return. Typically provided along with the page parameter. No
orderBy Determines which category property to use for sorting, and also determines the direction in which to sort the data. No
filter Filter by ParentId using a simple operator and value. ParentId is the only allowed field. If you don't provide a filter parameter, the query returns all the Categories in your MID. No

Sample configuration

<salesforceMarketingCloud.getCategories configKey="SFMC_CON">
    <page>{${payload.page}}</page>
    <pagesize>{${payload.pagesize}}</pagesize>
    <orderBy>{${payload.orderBy}}</orderBy>
    <filter>{${payload.filter}}</filter>
</salesforceMarketingCloud.getCategories>

Sample request

{
    "filter": "ParentId eq 1234",
    "page": 1,
    "pagesize": 50,
    "orderBy": "categoryId asc"
}
updateAsset

The updateAsset operation updates a full asset.

Parameter Name Description Required
assetId The ID of the asset to update. Yes
payload The properties required to update the asset. Required if inputStructure is INLINE
customerKey Reference to customer's private ID/name for the asset. Required if inputStructure is FORM
contentType The type that the content attribute will be in. No
data Property bag containing the asset data. No
assetType The type of the asset saved as a name/ID pair. No
version The version of the asset. No
locked Specifies if the asset can be modified or not. No
fileProperties Stores the different properties that this asset refers to if it is a file type. No
name Name of the asset, set by the client. 200 character maximum. Required if inputStructure is FORM
description Description of the asset, set by the client. No
category ID of the category the asset belongs to. No
tags List of tags associated with the asset. No
content The actual content of the asset. No
design Fallback for display when neither content nor supercontent are provided. No
superContent Content that supersedes content in terms of display. No
customFields Custom fields within an asset. No
views Views within an asset. Required if inputStructure is FORM
blocks Blocks within the asset. No
minBlocks Minimum number of blocks within an asset. No
maxBlocks Maximum number of blocks within an asset. No
channels List of channels that are allowed to use this asset. No
allowedBlocks List of blocks that are allowed in the asset. No
slots Slots within the asset. No
businessUnitAvailability A dictionary of member IDs that have been granted access to the asset. No
template Template the asset follows. No
file Base64-encoded string of a file associated with an asset. No
generateFrom Tells the sending compiler what view to use for generating this view's content. No
sharingProperties Allows you to share content with one or more business units that have Content Builder Sharing enabled. No
sharingProperties.sharedWith List of MID IDs the asset is shared with. No
sharingProperties.sharingType Indicates the permission that you are granting to the list of MIDs in sharedWith. Possible values are view, edit, or local. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.updateAsset configKey="SFMC_CON">
    <assetId>{${payload.assetId}}</assetId>
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.updateAsset>

Sample request

{
    "assetId": 3456,
    "body": {
        "CustomerKey": "example-key-123",
        "ContentType": "text/html",
        "Data": {
            "htmlContent": "<html><body><h1>Sample Content</h1></body></html>"
        },
        "AssetType": {
            "Name": "html",
            "ID": 1
        },
        "Version": 1,
        "Locked": false,
        "Name": "Sample Asset",
        "Description": "This is a sample asset update",
        "Category": {
            "ID": 10
        },
        "Tags": [
            "sample",
            "asset"
        ],
        "Content": "<html><body><h1>Updated Content</h1></body></html>"
    }
}
updateContact

The updateContact operation updates a contact record.

Parameter Name Description Required
payload The properties required to update the contact. Required if inputStructure is INLINE
contactKey Primary address for the contact. You must provide either a value for contactKey or contactID. Required if inputStructure is FORM
contactID Unique ID for the contact. You must provide either a value for contactKey or contactID. No
attributeSets Array of information used to create a new contact. Required if inputStructure is FORM
attributeSets.name Required. Name of attribute group to which to add the contact information. Required if inputStructure is FORM
attributeSets.values Name and value pairs indicating the attribute and applicable value. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.updateContact configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.updateContact>

Sample request

{
    "body": {
        "contactKey": "[email protected]",
        "contactId": 123456,
        "attributeSets": [
            {
                "name": "Email Addresses",
                "items": [
                    {
                        "values": [
                            {
                                "name": "Email Address",
                                "value": "[email protected]"
                            },
                            {
                                "name": "HTML Enabled",
                                "value": true
                            }
                        ]
                    }
                ]
            }
        ]
    }
}
updateCampaign

The updateCampaign operation updates a campaign.

Parameter Name Description Required
campaignId ID of the campaign to be updated. Yes
payload The properties required to update the campaign. Required if inputStructure is INLINE
name The name of the campaign. Required if inputStructure is FORM
description A description of the campaign. No
campaignCode A campaign code to associate with the campaign. No
color The color used to identify the campaign in the Marketing Cloud Engagement web interface, expressed as an HTML color code. No
favorite Indicates whether to identify the campaign as a favorite. No

Sample configuration for "INLINE"

<SalesforceMarketingCloud.updateCampaign configKey="OSCON">
    <inputStructure>INLINE</inputStructure>
    <campaignId>{${payload.id}}</campaignId>
    <payload>{${payload.body}}</payload>
</SalesforceMarketingCloud.updateCampaign>

Sample request

{
    "id": 237
    "body": {
        "name": "Final Hours for Summer Sale",
        "description": "Invite our most engaged customers to shop our Summer Sale before it ends.",
        "campaignCode": "summer2023",
        "color": "800080",
        "favorite": false
    }
}
deleteAsset

The deleteAsset operation deletes an asset.

Parameter Name Description Required
assetId The ID of the asset to delete. Yes

Sample configuration

<salesforceMarketingCloud.deleteAsset configKey="SFMC_CON">
    <assetId>{${payload.assetId}}</assetId>
</salesforceMarketingCloud.deleteAsset>

Sample request

```json { "assetId": 3456 }

deleteCampaign

The deleteCampaign operation deletes a campaign.

Parameter Name Description Required
campaignId The ID of the campaign to delete. Yes

Sample configuration

<salesforceMarketingCloud.deleteCampaign configKey="SFMC_CON">
    <campaignId>{${payload.campaignId}}</campaignId>
</salesforceMarketingCloud.deleteCampaign>

Sample request

```json { "campaignId": 3456 }

deleteContact

The deleteContact operation deletes a given list of contacts.

Parameter Name Description Required
values Array of contact ID values to delete. Yes
deleteOperationType Type of delete operation to perform. Yes

Sample configuration

<SalesforceMarketingCloud.deleteContact configKey="OSCON">
    <values>{${payload.values}}</values>
    <deleteOperationType>ContactAndAttributes</deleteOperationType>
</SalesforceMarketingCloud.deleteContact>

Sample request

{
    "values": [
        207807736
    ]
}
insertDataExtensionRowSet

The insertDataExtensionRowSet operation upsert one or more rows in a data extension synchronously by specifying the external key of the target data extension.

Parameter Name Description Required
externalKey The external ID, also known as the customer key, for the data extension. No
payload The properties required to insert data extension row set. Yes

Sample configuration

<salesforceMarketingCloud.insertDataExtensionRowSet configKey="SFMC_CON">
    <externalKey>{${payload.externalKey}}</externalKey>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.insertDataExtensionRowSet>

Sample request

{
    "externalKey": "AB8F0F80-065C-4B1C-85FC-545DB1D55767",
    "body": [
        {
            "values": {
                "SubscriberKey": "email address",
                "EmailAddress": "email address"
            }
        },
        {
            "values": {
                "SubscriberKey": "email address",
                "EmailAddress": "email address"
            }
        }
    ]
}
sendEmailMessage

The sendEmailMessage operation sends a message to multiple recipients using a send definition.

Parameter Name Description Required
payload The properties required to send an e-mail message. Required if inputStructure is INLINE
definitionKey The ID of the send definition. Required if inputStructure is FORM
recipients Recipient parameters and metadata. Cannot be used with single recipient array. Required if inputStructure is FORM
attributes Personalization attributes for the message as key-value pairs. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.sendEmailMessage configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.sendEmailMessage>

Sample request

{
    "body": {
        "definitionKey": "MySendDefinitionKey",
        "recipients": [
            {
                "contactKey": "[email protected]",
                "to": "[email protected]",
                "attributes": {
                    "FirstName": "Jane",
                    "LastName": "Doe"
                }
            },
            {
                "contactKey": "[email protected]",
                "to": "[email protected]",
                "attributes": {
                    "FirstName": "John",
                    "LastName": "Smith"
                }
            }
        ]
    }
}
sendSmsMessage

The sendSmsMessage operation sends an SMS message to multiple recipients using a send definition.

Parameter Name Description Required
payload The properties required to send SMS message. Required if inputStructure is INLINE
definitionKey The ID of the send definition. Required if inputStructure is FORM
recipients An array of recipient objects that contain tracking and personalization metadata. Required if inputStructure is FORM
subscriptions Resubscribe the recipient even if previously opted out. No
content Overrides content in send definition. Supports substitution strings. No
attributes Key-value pairs used to personalize the message globally. No

Sample configuration for "INLINE"

<salesforceMarketingCloud.sendSmsMessage configKey="SFMC_CON">
    <inputStructure>INLINE</inputStructure>
    <payload>{${payload.body}}</payload>
</salesforceMarketingCloud.sendSmsMessage>

Sample request

{
    "body": {
        "definitionKey": "MySendDefinitionKey",
        "recipients": [
            {
                "contactKey": "Astro25",
                "to": "15555551234",
                "messageKey": "nFL4ULgheUeaGbPIMzJJSw"
            },
            {
                "contactKey": "Codey36",
                "to": "15555554321",
                "messageKey": "GV1LhQ6NFkqFUAE1IsoQ9Q"
            }
        ],
        "attributes": {
            "RequestTrackingAttribute": "2"
        }
    }
}

The connector may encounter errors during operation execution. When an error occurs, the ERROR_MESSAGE property will contain detailed information about the error. You can handle these errors using a Fault Sequence in your integration. For more information, see Using Fault Sequences.

Error code Description
701101 General error.
701102 Invalid configuration error.