Adding a Connection to Salesforce Marketing Cloud

To add a connection to Salesforce Marketing Cloud:

1. In the application console, navigate to the Connections page.
2. At the Add Connections panel, select the icon for the connection you want to add.
3. If the Salesforce Marketing Cloud icon is not available, click the Add More icon to download and install the Salesforce Marketing Cloud connector from the CData site.

For required properties, see the Settings tab.

For connection properties that are not typically required, see the Advanced tab.

Connecting to Salesforce Marketing Cloud

For both REST and SOAP APIs, you have the option to refine data access using the following properties:

• Instance: The instance of the Salesforce Marketing Cloud API used. The default Instance is s7 of the Web Services API; however, you can use this property to specify a different instance.
• Subdomain: If the instance is greater than s10, you must also specify the subdomain.

REST API

To connect, set Schema to REST.

The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom OAuth application to obtain values for the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth App for more information.

SOAP API

To connect, set Schema to SOAP.

The Salesforce Marketing Cloud SOAP API can connect using OAuth, but also supports a legacy use of login credentials.

Note: Data extension objects in Salesforce Marketing Cloud are only accessible through the SOAP API.

Authenticating to Salesforce Marketing Cloud

User Accounts (OAuth)

Set the AuthScheme to OAUTH. Also, in all OAuth flows, set AccountId to the specific MID of the target business unit. NOTE: This is not available for legacy packages. The following OAuth sections assume that you have set both these connection properties.

Desktop Apps

Follow the steps below to authenticate with the credentials for a custom OAuth application. See Creating a Custom OAuth App for information about custom OAuth applications. Get an OAuth Access Token

After setting the following, you are ready to connect:

• OAuthClientId: The Client Id in your application settings.
• OAuthClientSecret: The Client Secret in your application settings.
• CallbackURL: The Redirect URL in your application settings.

When you connect the Sync App opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. To connect to data, set the OAuthAccessToken connection property to the access token returned by the stored procedure. When the access token expires after ExpiresIn seconds, call GetOAuthAccessToken again to obtain a new access token.

Headless Machines

To configure the driver to use OAuth with a user account on a headless machine, you need to authenticate on another device that has an internet browser.

1. Choose one of two options:
   • Option 1: Obtain the OAuthVerifier value as described in "Obtain and Exchange a Verifier Code" below.
   • Option 2: Install the Sync App on a machine with an Internet browser and transfer the OAuth authentication values after you authenticate through the usual browser-based flow, as described in "Transfer OAuth Settings" below.
2. Then configure the Sync App to automatically refresh the access token on the headless machine.

Option 1: Obtain and Exchange a Verifier Code

To obtain a verifier code, you must authenticate at the OAuth authorization URL.

Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.

1. Choose one of these options:
   • If you are using the Embedded OAuth Application click Salesforce Marketing Cloud OAuth endpoint to open the endpoint in your browser.
   • If you are using a custom OAuth application, create the Authorization URL by setting the following properties:
     • InitiateOAuth: Set to OFF.
     • OAuthClientId: Set to the client Id assigned when you registered your application.
     • OAuthClientSecret: Set to the client secret assigned when you registered your application.
     Then call the rpgrestsp-getoauthauthorizationurl stored procedure with the appropriate CallbackURL. Open the URL returned by the stored procedure in a browser.
2. Log in and grant permissions to the Sync App. You are then redirected to the callback URL, which contains the verifier code.
3. Save the value of the verifier code. Later you will set this in the OAuthVerifier connection property.

Next, you need to exchange the OAuth verifier code for OAuth refresh and access tokens. Set the following properties:

On the headless machine, set the following connection properties to obtain the OAuth authentication values:

• InitiateOAuth: REFRESH.
• OAuthVerifier: The verifier code.
• OAuthClientId: (custom applications only) The Client Id in your custom OAuth application settings.
• OAuthClientSecret: (custom applications only) The Client Secret in the custom OAuth application settings.
• OAuthSettingsLocation: The location of the settings file where OAuth values are saved when you set InitiateOAuth to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'. When this connection property is set, the data persists across connections.

After the OAuth settings file is generated, you need to re-set the following properties to connect:

• InitiateOAuth: REFRESH.
• OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
• OAuthSettingsLocation: The location containing the encrypted OAuth authentication values. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Option 2: Transfer OAuth Settings

Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.

After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.

Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.

On the headless machine, set the following connection properties:

• OAuthClientId: (custom applications only) The client Id assigned when you registered your application.
• OAuthClientSecret: (custom applications only) The client secret assigned when you registered your application.
• OAuthSettingsLocation: The location of your OAuth settings file. Make sure this location gives read and write permissions to the Sync App to enable the automatic refreshing of the access token.

Server-to-Server (OAuthClient)

When creating an application in Salesforce Marketing Cloud, you can select server-to-server authentication. In this case, the application's permissions are configured directly in the Salesforce Marketing Cloud UI. As such, there is no user context and hence no browser-based login or permission grants. For this scheme, you must create your own credentials.

Specify the following properties to enable server-to-server OAuth authentication for your application:

• AuthScheme: OAuthClient.
• InitiateOAuth: GETANDREFRESH.
• OAuthClientId: The client Id.
• OAuthClientSecret: The client secret.
• Subdomain: Specify the Salesforce Marketing Cloud API subdomain.

User/Password Accounts (Basic)

The Salesforce Marketing Cloud SOAP API can connect using either your login credentials or OAuth authentication. Note that this authentication scheme is not available for REST API-based applications.

To connect to data using login credentials authentication, set the following:

• AuthScheme: Basic.
• User: The Salesforce Marketing Cloud user account.
• Password: The password used to authenticate the user.
• UseLegacyAuthentication: True.

The Sync App offers the possibility to select, insert, update, and delete data from data extensions as relational tables. To query a data extension, simple enter its name in the format DataExtensionObject_Name where Name is the name of your data extension.

Note: To connect to data extension objects in Salesforce Marketing Cloud, you must use the SOAP API. Set Schema to SOAP.

Selecting data from data extensions

SELECT * FROM DataExtensionObject_fsefes3

SELECT * FROM DataExtensionObject_fsefes3 WHERE FieldName1 = 'One'

Note 1: All filters which work with normal tables/views also work with data extensions.

Note 2: By default the Salesforce Marketing Cloud retrieves data for the LoggedIn ClientId. To retrieve results for more than one ClientID, use semi-colons (;) as a separator. The ClientID can be accounts and sub-accounts, including Enterprise 2.0, On-Your-Behalf, and Lock & Publish accounts.

SELECT * FROM DataExtensionObject_fsefes3 WHERE ClientID = '1234567'

Inserting data into data extensions

INSERT INTO DataExtensionObject_fsefes3 (FieldName1, FieldName2, FieldName3) VALUES ('One', 'Two', 'Three')

Updating data from data extensions

UPDATE DataExtensionObject_secondtest15 SET [Name] = 'ChangedFromTheApi' WHERE [Email Address] = '[email protected]'

Note: A primary key has to exist for this data extension for the update to work.

Deleting data from data extensions

DELETE FROM DataExtensionObject_secondtest15 WHERE [Email Address] = '[email protected]'

Note: A primary key has to exist for this data extension for the deletion to work.

This section details a selection of advanced features of the Salesforce Marketing Cloud Sync App.

User Defined Views

The Sync App allows you to define virtual tables, called user defined views, whose contents are decided by a pre-configured query. These views are useful when you cannot directly control queries being issued to the drivers. See User Defined Views for an overview of creating and configuring custom views.

SSL Configuration

Use SSL Configuration to adjust how Sync App handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert property under "Connection String Options" for more information.

Firewall and Proxy

Configure the Sync App for compliance with Firewall and Proxy, including Windows proxies and HTTP proxies. You can also set up tunnel connections.

Query Processing

The Sync App offloads as much of the SELECT statement processing as possible to Salesforce Marketing Cloud and then processes the rest of the query in memory (client-side).

See Query Processing for more information.

Logging

See Logging for an overview of configuration settings that can be used to refine CData logging. For basic logging, you only need to set two connection properties, but there are numerous features that support more refined logging, where you can select subsets of information to be logged using the LogModules connection property.

Customizing the SSL Configuration

By default, the Sync App attempts to negotiate SSL/TLS by checking the server's certificate against the system's trusted certificate store.

To specify another certificate, see the SSLServerCert property for the available formats to do so.

Connecting Through a Firewall or Proxy

HTTP Proxies

To connect through the Windows system proxy, you do not need to set any additional connection properties. To connect to other proxies, set ProxyAutoDetect to false.

In addition, to authenticate to an HTTP proxy, set ProxyAuthScheme, ProxyUser, and ProxyPassword, in addition to ProxyServer and ProxyPort.

Other Proxies

Set the following properties:

• To use a proxy-based firewall, set FirewallType, FirewallServer, and FirewallPort.
• To tunnel the connection, set FirewallType to TUNNEL.
• To authenticate, specify FirewallUser and FirewallPassword.
• To authenticate to a SOCKS proxy, additionally set FirewallType to SOCKS5.

The CData Sync App models two Salesforce Marketing Cloud APIs as relational databases, the REST API and the SOAP API. Set the Schema property and use the information in each section to select the proper API based on your project needs.

Using the REST API

The REST API exposes broader access to Salesforce Marketing Cloud capabilities. All new Salesforce Marketing Cloud technologies implement REST API. See REST Data Model for the available entities in the REST API.

Using the SOAP API

The SOAP API provides comprehensive access to most email functionality. The SOAP API uses SOAP envelopes to pass information between you and Salesforce Marketing Cloud. See SOAP Data Model for the available entities in the SOAP API.

The Sync App models the Salesforce Marketing Cloud REST APIs as database Tables and Stored Procedures. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.

Stored Procedures

Stored Procedures are function-like interfaces to Salesforce Marketing Cloud. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.

The Sync App models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.

Salesforce Marketing Cloud Connector for CData Sync Tables

Name	Description
Assets	Create, update, delete and query assets from your SalesForce Marketing Cloud account.
Callbacks	Create, update, delete and query event notification callbacks
Campaigns	Create, update, delete and query Campaigns.
Categories	Create, update, delete and query categories(folders) in Content Builder.
EventDefinitions	Create, delete and query event definitions.
FacebookMessengerProperties	Query and create Facebook messenger properties.
JourneyActivities	Create, update and query journey activities.
Journeys	Create, update, delete and query journeys.
LineMessengerProperties	Query and create Line messenger properties.
SendDefinitions	Create, update, delete and query send definitions.
Subscriptions	Create, update, delete and query event notification subscriptions.

Create, update, delete and query assets from your SalesForce Marketing Cloud account.

Table Specific Information

Select

Select all assets:

SELECT * FROM ASSETS

Retrieve a specific asset:

SELECT * FROM ASSETS WHERE ID = 20088

Advanced server side filtering using 'AND' and 'OR' logical operators are supported for this table. You can check in the table info if the column has supported filters. All the columns which have supported filters, also can be sorted server side.

SELECT * FROM ASSETS WHERE (Id = 5895 OR Id = 19442) AND EnterpriseId = 7307527 ORDER BY Name ASC, Id DESC

Insert

To create an Asset, you will need to specify at least the Name and TypeId column.

INSERT INTO ASSETS (TypeID, TypeName, Name) VALUES (207, 'templatebasedemail', 'First_Based_Template_Email_CData')

Update

Assets may be modified by providing the Id of the Asset and issuing an UPDATE statement.

UPDATE ASSETS SET Description = 'This is an updated asset.', Data = '
  "campaigns": {
    "campaigns": [
      {
        "campaignId": 12345,
        "campaignAssociationId": 2387
      }
    ]
  },
  "email": { } ... }'  WHERE ID = 19442

Delete

Assets may be deleted by providing the Id of the Asset and issuing a DELETE statement.

DELETE FROM ASSETS WHERE ID = 20027

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	Integer	True		=,!=,<,<=,>,>=	The Id of the Asset.
CustomerKey	String	False		=,!=	Reference to customer's private ID/name for the asset.
ObjectId	String	True			System-controlled, read-only text string identifier for object.
Name	String	False		=,!=	Name of the asset, set by the client.
Description	String	False		=,!=	Description of the asset, set by the client.
OwnerId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset owner.
OwnerName	String	True		=,!=	The name of the asset owner.
OwnerEmail	String	True		=,!=	The email of the asset owner.
OwnerUserId	Integer	True			The user Id of the asset owner.
CreatedDate	Datetime	True		=,!=,<,<=,>,>=	The datetime when the asset was created.
CreatorId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset creator.
CreatorName	String	True			The name of the asset creator.
CreatorEmail	String	True			The email of the asset creator.
CreatorUserId	Integer	True			The user Id of the asset creator.
ModifiedDate	Datetime	True		=,!=,<,<=,>,>=	The last datetime when the asset was modified.
ModifierId	Integer	True		=,!=,<,<=,>,>=	The Id of the asset modifier.
ModifierName	String	True			The name of the asset modifier.
ModifierEmail	String	True			The email of the asset modifier.
ModifierUserId	Integer	True			The user Id of the asset modifier.
EnterpriseId	Integer	True		=,!=,<,<=,>,>=	A short description of the ...
MemberId	Integer	True		=,!=,<,<=,>,>=	Marketing Cloud MID (member ID) for your account.
ActiveDate	Datetime	False		=,!=,<,<=,>,>=	A short description of the ...
ExpirationDate	Datetime	False		=,!=,<,<=,>,>=	A short description of the ...
ContentType	String	False		=,!=	The type that the content attribute will be in.
TypeId	Integer	False		=,!=,<,<=,>,>=	The Id of the asset type.
TypeName	String	False			The name of the asset type.
TypeDisplayName	String	False			The display name of the asset type.
CategoryId	Integer	False		=,!=,<,<=,>,>=	The Id of the category where the asset is located.
CategoryName	String	False			The name of the category where the asset is located.
CategoryParentId	Integer	False			The Parent Id of the category where the asset is located.
Content	String	False		=,!=	The actual content of the asset.
Design	String	False		=,!=	Fallback for display when neither content nor supercontent are provided.
SuperContent	String	False		=,!=	Content that supersedes content in terms of display.
File	String	False			Base64-encoded string of a file associated with an asset.
FileProperties	String	False			Stores the different properties that this asset refers to if it is a file type.
ForwardHtml	String	False			Field inside the views object.
ForwardText	String	False			Field inside the views object.
HtmlContent	String	False			Field inside the views object.
HtmlSlots	String	False			Field inside the views object.
HtmlTemplate	String	False			Field inside the views object.
Preheader	String	False			Field inside the views object.
SubjectLine	String	False			Field inside the views object.
SubscriptionCenter	String	False			Field inside the views object.
Text	String	False			Field inside the views object.
ViewAsAWebPage	String	False			Field inside the views object.
GenerateFrom	String	False			Tells the sending compiler what view to use for generating this view's content.
Slots	String	False			Slots within the asset.
Blocks	String	False			Blocks within the asset.
MinBlocks	Integer	False			Minimum number of blocks within an asset.
MaxBlocks	Integer	False			Maximum number of blocks within an asset.
AllowedBlocks	String	False			List of blocks that are allowed in the asset.
Template	String	False			Template the asset follows.
CustomFields	String	False			Custom fields within an asset.
Data	String	False			Property bag containing the asset data.
Channels	String	False			List of channels that are allowed to use this asset.
Version	Integer	True			The version of the asset.
Locked	Boolean	False			Specifies if the asset can be modified or not.
Status	String	False			The asset's status.
Tags	String	False			List of tags associated with the asset.
BusinessUnitAvailability	String	False			A dictionary of member IDs that have been granted access to the asset.
SharingProperties	String	False			Allows you to share content with one or more business units that have Content Builder Sharing enabled.

Create, update, delete and query event notification callbacks

Table Specific Information

Select

Select all callbacks:

SELECT * FROM Callbacks

Retrieve a specific callback:

SELECT * FROM Callbacks WHERE CallbackId = 94766

Insert

To create a Callback, you will need to specify at least the CallbackName and Url column.

INSERT INTO [Callbacks] (CallbackName, Url) VALUES ('cb1', 'https://example.com')

Update

Callbacks may be modified by providing the CallbackId of the callback and issuing an UPDATE statement.

UPDATE [Callbacks] SET CallbackName = 'cb update' WHERE CallbackId = '34cd6cfe-5a21-4f3e-94c5-b6313a6954a4'

Delete

Callbacks may be deleted by providing the CallbackId of the callback and issuing a DELETE statement.

DELETE FROM [Callbacks] WHERE CallbackId = '43841979-7154-4fc4-9789-909dbba3a54f'

Columns

Name	Type	ReadOnly	References	Filters	Description
CallbackId [KEY]	String	False		=	The Id of the event notification callback.
CallbackName	String	False			The name of the event notification callback.
Url	String	False			The url of the event notification callback.
MaxBatchSize	Integer	False			Maximum batch size of the event notification callback.
Status	String	False			The status of the event notification callback.
StatusReason	String	False			The status reason of the event notification callback.

Create, update, delete and query Campaigns.

Table Specific Information

Select

Select all campaigns:

SELECT * FROM Campaigns

Retrieve a specific Campaign:

SELECT * FROM Campaigns WHERE Id = '3130'

Insert

To create a campaign, you will need to specify at least the Name column.

INSERT INTO [Campaigns] (Name, Description, CampaignCode, Color, Favorite) VALUES ('Test Camp', 'Test Description', 'tst 001', '0000ff', true)

Update

UPDATE operations are not supported for this table.

Delete

Campaigns may be deleted by providing the CampaignId of the campaign and issuing a DELETE statement.

DELETE FROM [Campaigns] WHERE Id = '5161'

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	Integer	True		=	The Id of the Campaign.
Name	String	False			Name of the Campaign.
CampaignCode	String	False			The Campaign code.
Color	String	False			The Campaign color.
Favorite	Boolean	False			True if marked as favorite Campaign.
CreatedDate	Datetime	False			The exact time when the Campaign was created.
ModifiedDate	Datetime	False			Last time the Campaign was updated.
Description	String	False			Description of the Campaign.

Create, update, delete and query categories(folders) in Content Builder.

Table Specific Information

Select

Select all categories:

SELECT * FROM Categories

Retrieve all categories which have a specific ParentId:

SELECT * FROM Categories WHERE ParentId = 71839

Retrieve a specific category:

SELECT * FROM Categories WHERE Id = 94766

All the columns except SharedWith and SharingType can be sorted server side:

SELECT * FROM Categories ORDER BY Name ASC

Insert

To create a Category, you will need to specify at least the Name and ParentId column.

INSERT INTO Categories (Name, ParentId, categoryType) VALUES ('New New New Folder', 71839, 'asset')

Update

Categories may be modified by providing the Id of the category and issuing an UPDATE statement.

UPDATE Categories SET SharedWith = '333,555,888', SharingType = 'edit', EnterpriseId = 12345 WHERE Id = 71839

Delete

Categories may be deleted by providing the Id of the category and issuing a DELETE statement.

DELETE FROM Categories WHERE Id = 94843

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	Integer	True		=	The Id of the category(folder) in Content Builder.
Name	String	False			Name of the category.
ParentId	Integer	False		=	ID of the parent category.
CategoryType	String	False			The type of category, either asset or asset-shared, which is automatically set to the CategoryType of the parent category. If set to asset-shared, include the SharingProperties in the call.
EnterpriseId	Integer	False			ID of the enterprise this business unit belongs to.
MemberId	Integer	False			ID of the member who creates the category.
SharedWith	String	False			List of up to 100 MID IDs the category is shared with. To share the category with all business units in the enterprise, and if your account has access to Content Builder Across Enterprise Sharing, set this to 0. SharedWith cannot contain 0 and other MIDs simultaneously. Since shared categories live in and are owned by the enterprise business unit, don't include the enterprise business unit in the SharedWith property.
SharingType	String	False			Indicates the permission that you are granting to the list of MIDs in sharedWith. The only possible value for categories is edit. The allowed values are edit.
Description	String	False			Description of the category.

Create, delete and query event definitions.

Table Specific Information

Select

Retrieve all event definitions:

SELECT * FROM EventDefinitions

Retrieve a specific event definition:

SELECT * FROM EventDefinitions WHERE Id = '9955614b-02e7-4147-91a2-3f5f5fe9d679'

Retrieve all event definitions which are running in a specific mode:

SELECT * FROM EventDefinitions WHERE Mode = 'Test'

Retrieve all event definitions which contain the specified quoted phrase in their names:

SELECT * FROM EventDefinitions WHERE CONTAINS (Name, 'Welcome Journey')

Insert

To create an event definition, you will need to specify at least the Name and Type column. DataExtensionId is also required. If you do not specify it, you must specify the Schema column.

INSERT INTO EventDefinitions (Type, Name, DataExtensionId, IsVisibleInPicker) VALUES ('Event', 'FirstEventDefinition', '74bc3342-eaca-e711-b98f-38eaa71427a1', true)

Delete

Event definitions may be deleted by providing the Id of the event definition and issuing a DELETE statement.

DELETE FROM EventDefinitions WHERE Id = 'f10efb9e-cb91-4fc9-be50-c20f00f7f255'

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True		=	The Id of the event definition.
Type	String	False			The type of the event definition. The allowed values are Event, ContactEvent, DateEvent, RestEvent.
Name	String	False		Contains	A name for your Event Definition that identifies the event in Marketing Cloud.
CreatedDate	Datetime	True			The datetime when the event definition was created.
CreatedBy	Integer	True			The Id of the event definition creator.
ModifiedDate	Datetime	True			The datetime when the event definition was updated.
ModifiedBy	Integer	True			The Id of the event definition modifier.
Mode	String	False		=	The mode in which the event definitions can run. The allowed values are Production, Test. The default value is Production.
EventDefinitionKey	String	False			Unique Id for an Event Definition in Marketing Cloud. Don't include special characters.
DataExtensionId	String	False			The ID for the data extension associated with the event. Events fired from the API write to this data extension. Required only when not providing a schema.
DataExtensionName	String	False			The read-only name of the data extension associated with the event.
Description	String	False			The description of Event Definition.
Schema	String	False			Schema information for an event. The call uses this information to create a data extension associated with the Event Definition. Only required when not providing a dataExtensionId value.
SendableCustomObjectField	String	False			Defines the subscriber key or email address within a data extension. Required when defining a schema.
SendableSubscriberField	String	False			Indicates type of sendable subscriber field. The default value is SubscriberKey. Required when defining a schema.
Schedule	String	False			Creates an automation run daily according to the defined schedule. The call automatically adds a Fire Event activity to the automation. This automation fires events from the data extension defined as part of the Event Definition.
FilterDefinitionId	String	False			The Id of the filter definition.
FilterDefinitionTemplate	String	False			The template of the filter definition.
IconUrl	String	False			URL to an icon displayed in Event Administration and the Journey Builder Canvas that identifies an Event Definition.
Arguments	String	False			Contains filter criteria for the Event Definition. Only required for types other than event.
Configuration	String	False			Optional configuration data for the event. Only required for types other than event.
ConfigurationArguments	String	False			The configuration arguments of Event Definition.
Metadata	String	False			Optional data describing the event and its configuration. Only required for types other than event.
InteractionCount	Integer	False			The interaction counter.
IsVisibleInPicker	Boolean	False			Indicates whether the Event Picker shows the Event Definition to users when configuring a journey. The default value is true.
Category	String	False			Broad category of the event type. The default value is event.
PublishedInteractionCount	Integer	False			The published interaction counter.
AutomationId	String	False			The Id of the Automation.

Query and create Facebook messenger properties.

Table Specific Information

Select

Retrieve all registred facebook messenger properties:

SELECT * FROM FacebookMessengerProperties

Retrieve a specific registred facebook messenger property:

SELECT * FROM FacebookMessengerProperties WHERE PageId = '1732555047025799'

Insert

To register a new facebook messenger property you must specify PageId, ApplicationId, ApplicationSecret, PageName, PageAccessToken, CallbackVerifyToken, EndpointUrl and ApiVersion:

INSERT INTO FacebookMessengerProperties (PageId, ApplicationId, ApplicationSecret, PageName, PageAccessToken, EndpointUrl, CallbackVerifyToken, ApiVersion) VALUES ('1732555047025799', '1093076390764037', '03d537gg656gvkbe9b430f002e9c4517', 'SFMC Engineers', 'someaccesstoken4fasdcruib213123knubkdnfisdubnu12312ub3pijnb', 'https://graph.facebook.com/v2.6/me/messages', 'this_is_the_verify_token', 'v2.0')

Columns

Name	Type	ReadOnly	References	Filters	Description
PageId [KEY]	String	False		=	The PageId of the Facebook Messenger property.
ApplicationId	String	False			Facebook Application Id.
ApplicationSecret	String	False			Facebook Application Secret.
PageName	String	False			Facebook Page Name.
PageAccessToken	String	False			Access Token required to authenticate send messages requests to Facebook networks.
CallbackVerifyToken	String	False			Facebook Verify Token need to verify callback events.
EndpointUrl	String	False			Send API url of the Facebook network.
IsActive	Boolean	False			Indicate if the Facebook Messenger resource is active.
ApiVersion	String	False			The API version of the OTT property.

Create, update and query journey activities.

Table Specific Information

Select

Retrieve journey activities for the latest version of the specified journey:

SELECT * FROM JourneyActivities WHERE JourneyId = '1cb643b5-3144-4d17-80fa-a1f0035e78e2'

Retrieve journey activities for a specific journey version:

SELECT * FROM JourneyActivities WHERE JourneyId = '1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND JourneyVersion = 1

Retrieve journey activities from all journeys with a specific version:

SELECT * FROM JourneyActivities WHERE JourneyVersion = 1

Insert

To create a new journey activity, you will need to specify at least the JourneyId, JourneyVersion, Type, Key, Arguments, ConfigurationArguments column.

INSERT INTO JourneyActivities (JourneyId, JourneyVersion, Type, Key, Arguments, ConfigurationArguments) VALUES ('4753026f-20b2-481b-89c5-fcd76ffa41f7', 1, 'WAIT', 'WAITBYDURATION-1', '{
  "waitEndDateAttributeDataBound": "",
  "waitDefinitionId": "f3de0c9a-5ff8-4f7b-84bd-9309ca337227",
  "waitForEventId": "",
  "executionMode": "{{Context.ExecutionMode}}",
  "startActivityKey": "{{Context.StartActivityKey}}",
  "waitQueueId": "{{Context.WaitQueueId}}"
}', '{
  "waitDuration": 1,
  "waitUnit": "DAYS",
  "specifiedTime": "",
  "timeZone": "",
  "description": "",
  "waitEndDateAttributeExpression": "",
  "specificDate": "",
  "waitForEventKey": ""
}')

Update

Journey activities may be modified by providing the Id, JourneyId, JourneyVersion and issuing an UPDATE statement.

UPDATE JourneyActivities SET Description = 'First_Journey_Activity_Description', Outcomes = '[
  {
    "key": "11bb2807-3f3d-4305-af51-547df032dbaf",
    "next": "WAITBYDURATION-1",
    "arguments": null,
    "metaData": null
  }
]' WHERE Id = 'fa4c3d81-8043-40e2-9741-22708d3a2e25' AND  JourneyId = '4753026f-20b2-481b-89c5-fcd76ffa41f7' AND JourneyVersion = 1

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True			This is the Marketing Cloud-provided unique ID for this particular activity.
JourneyId [KEY]	String	True	Journeys.Id	=	A unique identifier for this journey that is generated and assigned by the journey API during creation.
JourneyVersion [KEY]	Integer	True	Journeys.Version	=	This number denotes the iteration of this particular journey.
Key	String	False			This is the customer key (journey-unique) for this particular activity.
Name	String	False			This is the display name for this activity, it will be shown in the Journey Builder UI.
Description	String	False			This is the description for this activity.
Type	String	False			This property defines what type of activity this is. The expected input for each activity must be passed as an argument to operate correctly.
Outcomes	String	False			This is a json array of 'outcome' objects.
Arguments	String	False			This is an object which represents the arguments this particular activity expects to be passed for use at runtime. Each activity type has its own unique argument parameters which are expected.
ConfigurationArguments	String	False			This is an object which represents the arguments this particular activity expects to be passed for use both at publish and runtime. Each activity type has its own unique argument parameters which are expected.

Create, update, delete and query journeys.

Table Specific Information

Select

Retrieve journeys with the most recent version:

SELECT * FROM Journeys

Retrieve a journey version:

SELECT * FROM Journeys WHERE ID = '1cb643b5-3144-4d17-80fa-a1f0035e78e2' AND Version = 1

Retrieve all journey versions:

SELECT * FROM Journeys WHERE MostRecentVersionOnly = false

Retrieve journeys with a specific tag:

SELECT * FROM Journeys WHERE Tag = 'First_Tag'

Retrieve journeys which have the specified search string inside the name or description:

SELECT * FROM Journeys WHERE NameOrDescription = 'Journey'

Retrieve journeys with specific work flow API version:

SELECT * FROM Journeys WHERE workFlowApiVersion = 1

Retrieve journeys with specific version:

SELECT * FROM Journeys WHERE Version = 1

Retrieve journeys with specific status:

SELECT * FROM Journeys WHERE Status = 'Draft'

Sort Journeys according to modifiedDate or name column:

SELECT * FROM Journeys ORDER BY ModifiedDate DESC
SELECT * FROM Journeys ORDER BY Name DESC

Insert

To create a new journey, you will need to specify at least the Name column.

INSERT INTO Journeys (Name) VALUES ('API-Created journey')

To create a new journey version, you will need to specify an existing journey key.

INSERT INTO Journeys (Name, Key) VALUES ('API-Created journey Version 3', '53bf5ea2-ff59-4c00-a23a-b1e9e333b80c')

Update

Journeys may be modified by providing the Id, Version of the journey and issuing an UPDATE statement.

UPDATE Journeys SET Name = 'API-Updated journey' WHERE Id = '257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version = 5

Delete

Journeys may be deleted by providing the Id of the journey and issuing a DELETE statement.

DELETE FROM Journeys WHERE Id = '53bf5ea2-ff59-4c00-a23a-b1e9e333b80c'

Journey versions may be deleted by providing the Id, Version of the journey and issuing a DELETE statement.

DELETE FROM Journeys WHERE Id = '257c51df-d6ed-4fb6-8fbc-70e63ed52b12' AND Version = 5

Columns

Name	Type	ReadOnly	References	Filters	Description
Id [KEY]	String	True		=	A unique identifier for this journey that is generated and assigned by the journey API during creation.
Version	Integer	True		=	This number denotes the iteration of this particular journey.
Key	String	False			The customer key (also a unique identifier within the MID) for this journey.
Name	String	False			The display name used in the Journey Builder UI for this journey, this will be visible to everyone who logs into your Marketing Cloud account.
Status	String	False		=	A status description upon which to filter journeys. The allowed values are Draft, Published, ScheduledToPublish, Stopped, Unpublished, Deleted.
CreatedDate	Datetime	True			The datetime when the journey was created.
ModifiedDate	Datetime	True			The datetime when the journey was updated.
LastPublishedDate	Datetime	True			The datetime when the journey was last published.
Description	String	False			The human readable description of this journey that informs others of purpose.
WorkFlowApiVersion	Integer	False		=	The version of work flow API. The default value is 1.
Tags	String	False			Assigned tags to the journey.
Goals	String	False			This is an array of goals containing a single object.
Triggers	String	False			This is an array of triggers containing a single object.
Defaults	String	False			This object contains an ordered list of email expressions used to determine which email address to use as the default, starting with the first expression.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
MostRecentVersionOnly	Boolean	A flag to indicate whether to fetch only the most recent version of matching journeys. The default value is true.
Tag	String	Specify a single tag to filter results to only include journeys associated with that tag.
NameOrDescription	String	A search string inside the journey's name or description properties upon which to match for filtering.

Query and create Line messenger properties.

Table Specific Information

Select

Retrieve all registred line messenger properties:

SELECT * FROM LineMessengerProperties

Retrieve a specific registred line messenger property:

SELECT * FROM LineMessengerProperties WHERE ID = '23493453984234345'

Insert

To register a new line messenger property you must specify ChannelId, ChannelName, ChannelSecret, IsTransactional, IsTestChannel, EndpointUrl and ApiVersion:

INSERT INTO LineMessengerProperties (ChannelId, ChannelName, ChannelSecret, EndpointUrl, IsTransactional, IsTestChannel, IsActive, ApiVersion) VALUES ('23493453984234345', 'SFMC Engineers', '03d537gg656gvkbe9b430f002e9c4517', 'https://example.com/1732555047025799', true, false, true, 'v2.0')");

Columns

Name	Type	ReadOnly	References	Filters	Description
ChannelId [KEY]	String	False		=	The Id of the LINE Messenger property.
ChannelName	String	False			LINE channel name.
ChannelSecret	String	False			LINE channel secret.
CustomerConnectSecret	String	False			LINE Customer Connect Secret needed for validating LINE inbound events when using Switcher API.
IsTransactional	Boolean	False			Indicate if LINE channel is Transactional or Reseller.
IsTestChannel	Boolean	False			Indicate if LINE channel is a Test channel.
EndpointUrl	String	False			Send API url of the LINE network.
IsActive	Boolean	False			Indicate if the LINE Messenger resource is active.
ApiVersion	String	False			The API version of the OTT property.

Create, update, delete and query send definitions.

Table Specific Information

Select

Retrieve all send definitions:

SELECT * FROM SendDefinitions

Retrieve a specific send definition:

SELECT * FROM SendDefinitions WHERE DefinitionKey = '9955614b-02e7-4147-91a2-3f5f5fe9d679'

Retrieve all send definitions with Status as 'Active':

SELECT * FROM SendDefinitions WHERE Status = 'Active'

Insert

To create a send definition, you will need to specify at least the DefinitionKey, Name, SubscriptionsList and ContentCustomerKey column.

INSERT INTO SendDefinitions (DefinitionKey, Name, ContentCustomerKey, SubscriptionsList, OptionsCc, OptionsCreateJourney) VALUES ('TEST_Definition_Key', 'Test Definition Key', '76ad3572-abbc-4baa-b3fe-04c4364bf34a', 'All Subscribers', '[email protected]', true)

Update

To update a send definition, you will need to specify the DefinitionKey of the SendDefinition.

UPDATE SendDefinitions SET OptionsCc = '[email protected],[email protected]', OptionsBcc = '[email protected],[email protected]' WHERE DefinitionKey = 'TEST_Definition_Key'

Delete

Send definitions may be deleted by providing the Definition Key of the send definition and issuing a DELETE statement.

DELETE FROM SendDefinitions WHERE DefinitionKey = 'TEST_Definition_Key'

Columns

Name	Type	ReadOnly	References	Filters	Description
DefinitionKey [KEY]	String	False		=	Unique, user-generated key to access the definition object.
DefinitionId	String	True			Unique Marketing Cloud object identifier.
Classification	String	False			Marketing Cloud external key of a sending classification defined in Email Studio Administration. Only transactional classifications are permitted. Default is default transactional.
ContentCustomerKey	String	False			Unique identifier of the content asset.
CreatedDate	Datetime	True			Date the definition was created.
Description	String	False			User-provided description of the send definition.
Journey	Boolean	True			Indicates whether the send definition is available in Journey Builder as a Transactional Send Journey.
JourneyInteractionKey	String	True			Unique ID of the Transactional Send Journey.
ModifiedDate	Datetime	True			Date and time the definition was most recently changed.
Name	String	False			Name of the definition.
OptionsBcc	String	False			Include BCC email addresses with every send. To dynamically BCC at send time, create a profile attribute and use the %%attribute%% syntax.
OptionsCc	String	False			Include CC email addresses with every send. To CC dynamically at send time, create a profile attribute and use the %%attribute%% syntax.
OptionsTrackLinks	Boolean	False			Wraps links for tracking and reporting. Default is true.
OptionsCreateJourney	Boolean	False			Defines the subscriber key or email address within a data extension. Required when defining a schema.
RequestId	String	True			The unique identifier of this request.
Status	String	False		=,!=	Operational state of the definition: active, inactive, or deleted. A message sent to an active definition is processed and delivered. A message sent to an inactive definition isn't processed or delivered. Instead, the message is queued for later processing for up to three days.
SubscriptionsAutoAddSubscriber	Boolean	False			Adds the recipient's email address and contact key as a subscriber key to subscriptions.list. Default is true.
SubscriptionsDataExtension	String	False			Marketing Cloud external key of the triggered send data extension. Each request inserts as a new row in the data extension.
SubscriptionsList	String	False			Marketing Cloud external key of the list or all subscribers. Contains the subscriber keys and profile attributes.
SubscriptionsUpdateSubscriber	Boolean	False			For email only: Updates the recipient's contact key as a subscriber key with the provided email address and profile attributes to subscriptions.list. Default is true.

Create, update, delete and query event notification subscriptions.

Table Specific Information

Select

Select all subscriptions:

SELECT * FROM Subscriptions

Retrieve a specific subscription:

SELECT * FROM Subscriptions WHERE SubscriptionId = 94766

Insert

To create a subscription, you will need to specify at least the SubscriptionName, CallbackId and EventCategoryTypes column.

INSERT INTO [Subscriptions] (SubscriptionName, CallbackId, EventCategoryTypes) VALUES ('sajli subscription', '6fb0758b-155d-4968-869d-7a4f5a3ad2fe', '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]')

Update

Subscriptions may be modified by providing the SubscriptionId and the EventCategoryTypes column of the subscription and issuing an UPDATE statement.

UPDATE [Subscriptions] SET Status = 'paused', EventCategoryTypes = '[\"TransactionalSendEvents.EmailNotSent\", \"TransactionalSendEvents.EmailSent\"]' WHERE SubscriptionId = 'db1e2af0-807d-463b-96e8-fe3aaa019fdb'

Delete

Subscriptions may be deleted by providing the SubscriptionId of the subscription and issuing a DELETE statement.

DELETE FROM [Subscriptions] WHERE SubscriptionId = '43841979-7154-4fc4-9789-909dbba3a54f'

Columns

Name	Type	ReadOnly	References	Filters	Description
SubscriptionId [KEY]	String	False		=	The Id of the event notification subscription.
SubscriptionName	String	False			The name of the event notification subscription.
CallbackId	String	False	Callbacks.CallbackId	=	The Id of the event notification callback.
CallbackName	String	False			The name of the event notification callback.
EventCategoryTypes	String	False			Event category types.
Filters	String	False			Filters.
Url	String	False			The url of the event notification callback.
MaxBatchSize	Integer	False			Maximum batch size of the event notification callback.
Status	String	False			The status of the event notification callback.
StatusReason	String	False			The status reason of the event notification callback.

Views are similar to tables in the way that data is represented; however, views are read-only.

Queries can be executed against a view as if it were a normal table.

Salesforce Marketing Cloud Connector for CData Sync Views

Name	Description
AssetTypes	Get all available asset types in Salesforce Marketing Cloud.
CampaignAssets	Retrieve all campaign assets in Salesforce Marketing Cloud.
Contact	Retrieve contacts in Salesforce Marketing Cloud.
Contacts	Retrieve all contacts in Salesforce Marketing Cloud.
JourneyAuditLogs	Retrieves an audit log of a journey and its versions.
JourneyHistory	Gives the history of a journey. Record access cannot exceed 10,000th item
SmsStatusCodes	Query sms status codes.
TransactionalMessages	Gets a paginated list of messages that were not sent, ordered from oldest to newest.

Get all available asset types in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all asset types:

SELECT * FROM AssetTypes

Columns

Name	Type	References	Description
Id [KEY]	Integer	Assets.TypeId	The Id of the asset type.
Name	String		The name of the asset type.
IsBaseAssetType	Boolean		Whether the asset type is a base asset type or not.
ParentId	Integer		The Id of the parent asset type.

Retrieve all campaign assets in Salesforce Marketing Cloud.

View Specific Information

Select

Select all campaign assets for a specific campaign:

SELECT * FROM CampaignAssets WHERE CampaignId = '3130'

Retrieve a specific Campaign:

SELECT * FROM CampaignAssets WHERE CampaignId = '3130' AND Id = '3325'

Columns

Name	Type	References	Description
Id [KEY]	Integer		The Id of the campaign asset.
CampaignId	Integer	Campaigns.Id	CampaignId assosiated with the asset.
Type	String		Type of the campaign asset.
ItemId	String		Internal object id.
CreatedDate	Datetime		The exact time when the asset was created.

Retrieve contacts in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all contacts:

SELECT * FROM Contact

Note: Most columns for this table are dynamic so they may not be the same as the columns specified below because you can have a different Contact schema in your Salesforce marketing cloud account.
Contacts that are in a deleted, deleting, or restricted state are not retrieved.

Columns

Name	Type	References	Description
ContactID [KEY]	Int		The system defined identifier of the contact.
ContactKey	String		The user defined identifier of the contact.

Retrieve all contacts in Salesforce Marketing Cloud.

Table Specific Information

Select

Retrieve all contacts:

SELECT * FROM Contacts

Note: Most columns for this table are dynamic so they may not be the same as the columns specified below because you can have a different Contact schema in your Salesforce marketing cloud account.
Contacts that are in a deleted, deleting, or restricted state are not retrieved.

Columns

Name	Type	References	Description
GroupConnect LINE Demographics.Address ID	String		This is an autogenerated description
GroupConnect LINE Demographics.Contact ID	Long		This is an autogenerated description
GroupConnect LINE Demographics.Contact Key	String		This is an autogenerated description
Contact.Contact ID [KEY]	Int		The system defined identifier of the contact.
Contact.Contact Key	String		The user defined identifier of the contact.
Email Demographics.Contacts ID	Long		This is an autogenerated description
Email Demographics.NewAttrTest	String		Test new attr
Email Demographics.NewAttrTest1	String		New Attr test
Email Demographics.NewAttrTest 2	String		NewAttrTest 2
Email Demographics.tet	String		test
Email Addresses.Email Address	String		This is an autogenerated description
Email Addresses.HTML Enabled	Bool		This is an autogenerated description
MobileConnect Demographics.Contact ID	Long		This is an autogenerated description
MobileConnect Demographics.Locale	String		This is an autogenerated description
MobileConnect Demographics.Mobile Number	String		This is an autogenerated description
MobilePush Demographics.Application	String		This is an autogenerated description
MobilePush Demographics.Contact ID	Long		This is an autogenerated description
MobilePush Demographics.Device ID	String		This is an autogenerated description
Contact.Business Unit ID	Int		This is an autogenerated description
Email Addresses.Member ID	Int		This is an autogenerated description
Email Addresses.List ID	Int		This is an autogenerated description

Retrieves an audit log of a journey and its versions.

Columns

Name	Type	References	Description
JourneyId	String	Journeys.Id	A unique identifier for this journey that is generated and assigned by the journey API during creation.
JourneyVersion	Integer	Journeys.Version	This number denotes the iteration of this particular journey.
Key	String		The customer key (also a unique identifier within the MID) for this journey.
Action	String		The actions used to build your audit log. The allowed values are all, create, modify, publish, unpublish, delete. The default value is all.
Name	String		This is the display name for this activity, it will be shown in the Journey Builder UI.
Description	String		This is the description for the journey.
ActionDate	Datetime		The datetime of the action.
UserId	Integer		Id of user who performed the action.
UserName	String		Name of user who performed the action.
ExecutionMode	String		The execution mode in which the journey is running.
OriginalDefinitionId	String		The original definition Id of the journey.
PublishRequestId	String		The Id of the publish request.
PublishStatus	String		The status of the journey publication.
Errors	String		Errors occurred during the action.
ContactsEjected	String		Ejected Contacts when journey is stopped.

Gives the history of a journey. Record access cannot exceed 10,000th item

Table Specific Information

Select

Retrieves information about a specific contact, journey, or journey version.:

SELECT * FROM JourneyHistory

Retrieves information about a specific contact, journey, or journey version within the specified date range.:

SELECT * FROM JourneyHistory where TransactionTime >= '2022-09-01T10:29:22.438Z' and TransactionTime <= '2022-09-30T11:29:22.438Z'

SELECT * FROM JourneyHistory where TransactionTime > '2022-09-01T10:29:22.438Z' and TransactionTime < '2022-09-30T11:29:22.438Z'

SELECT * FROM JourneyHistory where TransactionTime = '2022-09-01T10:29:22.438Z'

NOTE: Max 10k records can be retrieved using JourneyHistory. If only greater_equals or greater TransactionTime is mentioned it will retrieve maximum 10k records starting from that TransactionTime. If both greater_equals or greater and smaller_equals or smaller is mentioned, it will fetch the first 10k records.

Columns

Name	Type	References	Description
Id	String		A unique identifier for this journeyhistory that is generated and assigned by the journey API when the journey is in running state.
ActivityBatchInstanceId	String		ActivityBatchInstanceId
ActivityId	String		A unique identifier for this activity that is generated and assigned by the journey API when the activity is created.
ActivityType	String		Type of Activity
ClientStatus	String		Client Status
ContactKey	String		The customer key (also a unique identifier within the MID) for this journey.
CreatedDate	Datetime		The datetime when the journey was created.
DefinitionId	String		Definition Id
DefinitionInstanceId	String		Definition Instance Id
DefinitionName	String		Definition Name
EpochTimeInMilliseconds	Long		Epoch Time In Milli Seconds
EventId	String		Event Id
EventName	String		Event Name
LongId	Integer		Id
Message	String		Message
Mid	Integer		MID
ResultMessages	String		Messages
ResultStatus	String		Status
ResultTags	String		Tags
Status	String		Status of Journey History
TransactionTime	Datetime		Transaction Time

Query sms status codes.

Table Specific Information

Select

Retrieve all status codes for the following countries: U.S., Canada, Brazil, and India. Use these codes to evaluate and troubleshoot your SMS sends.

SELECT * FROM SmsStatusCodes

Columns

Name	Type	References	Description
Code [KEY]	Integer		The SMS code.
Status	String		The SMS status for the respective Code.
Definition	String		The definition for the SMS status Code.

Gets a paginated list of messages that were not sent, ordered from oldest to newest.

Table Specific Information

Select

Select all TransactionalMessages:

SELECT * FROM TransactionalMessages

Columns

Name	Type	References	Description
LastEventId	Integer		The ID of the Event from which you want the response to start.
StatusCode	Integer		Integer value of the reason the send did not complete. Review Email Send Error Codes for more information.
StatusMessage	String		The reason the send did not complete. Review Email Send Error Codes for more information.
EventCategoryType	String		TransactionalSendEvent event type. EmailSent indicates that the email was sent to the email provider. EmailNotSent indicates that the email was not sent and includes the reason. EmailQueued indicates that the email has not yet been processed for sending.
Timestamp	String		Time the event occured in Central Standard Time (no daylight savings)
DefinitionKey	String		Unique identifier of the definition.
EventId	Integer		Numeric identifier of the event.
MessageKey	String		Unique identifier to track message send status.
ContactKey	String		Unique identifier for a subscriber in Marketing Cloud.
To	String		Channel address of the recipient. For email, it’s the recipient's email address. For SMS, it’s the recipient's mobile number.

The Sync App models the Salesforce Marketing Cloud SOAP APIs as database Tables and Views. These are defined in schema files, which are simple, text-based configuration files that make schemas easy to customize.

API limitations and requirements are documented in this section; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.

Views

Views are tables that cannot be modified. Typically, read-only data are shown as views. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.

The Sync App models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.

Salesforce Marketing Cloud Connector for CData Sync Tables

Name	Description
Account	A Marketing Cloud account.
AccountUser	An individual user within an account. This table does not support deletes.
BusinessUnit	A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.
ContentArea	A ContentArea represents a defined section of reusable content.
DataExtension	Represents a data extension within an account.
Email	Represents an email in a Marketing Cloud account.
EmailSendDefinition	Record that contains the message information, sender profile, delivery profile, and audience information.
FileTrigger	Reserved for future use. This table does not suport deletes.
FilterDefinition	Defines an audience based on specified rules in a filter. This table does not support inserts.
ImportDefinition	Defines a reusable pattern of import options. This table does not support inserts.
List	A marketing list of subscribers.
Portfolio	Indicates a file within the Portfolio of a Marketing Cloud account.
ProgramManifestTemplate	Reserved for future use. This table does not support deletes or inserts.
QueryDefinition	Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.
ReplyMailManagementConfiguration	Details configuration settings for the reply mail management in an account. This table does not support deletes.
Send	Used to send email and retrieve aggregate data. This table does not support deletes or updates.
SendClassification	Represents a send classification in a Marketing Cloud account.
SenderProfile	The send profile used in conjunction with an email send definition.
SMSTriggeredSend	Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.
Subscriber	A person subscribed to receive email or SMS communication.
SuppressionListDefinition	A suppression list that can be associated with different contexts.
TriggeredSendDefinition	To create or update a TriggeredSendDefinition where the list ID is the All Subs List ID, you need the Email | Subscribers | All Subscribers | View and SendEmailToList permissions.

A Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Account WHERE Id = 123

SELECT * FROM Account WHERE Id IN (123, 456)

SELECT * FROM Account WHERE CreatedDate > '2017/01/25'

Insert

You must specify the Name column when executing an insert against this table.

INSERT INTO Account (Name) VALUES ('Test')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Account SET Fax = '1123123' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Account WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier of the account.
AccountType	String	False	Type of Marketing Cloud account. The allowed values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.
ParentID	Int	False	Specifies the ID number of the parent account for Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 account children and business units.
BrandID	Int	False	Specifies brand tags to use on an account.
PrivateLabelID	Int	False	Specifies the private label for an account.
ReportingParentID	Int	False	Reserved for future use.
Name	String	False	Name of the account.
Email	String	False	Default email address the account. Indicates if subscriber information can be used for email sends.
FromName	String	False	Specifies the default email message From Name. Deprecated for email send definitions and triggered send definitions.
BusinessName	String	False	Business name of an account's owner.
Phone	String	False	Specifies a phone number.
Address	String	False	The address used to communicate with a Person.
Fax	String	False	Fax number of the account's owner.
City	String	False	City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.
State	String	False	Specifies the geographical state of the account's owner.
Zip	String	False	Specifies the zip code of the account's owner.
Country	String	False	Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.
IsActive	Boolean	False	Specifies whether or not the account is active.
IsTestAccount	Bool	False	Specifies whether or not an account is a 'Test' account.
Client_ClientID1	Int	True	The Client Id of the client.
DBID	Int	False	Reserved for future use.
CustomerID	Long	False	Reserved for future use.
DeletedDate	Datetime	True	Date and time of an account's deletion.
EditionID	Int	False	Specifies the product edition of the account.
ModifiedDate	Datetime	False	Indicates the last time account information was modified.
CreatedDate	Datetime	False	Date and time of the account's creation.
ParentName	String	False	Specifies the name of the Parent account.
Subscription_SubscriptionID	String	True	Reserved for future use.
Subscription_HasPurchasedEmails	Bool	True	Reserved for future use.
Subscription_EmailsPurchased	Int	True	Specifies the number of emails purchased in a subscription.
Subscription_Period	String	True	Reserved for future use.
Subscription_AccountsPurchased	Int	True	Marketing Cloud Accounts purchased.
Subscription_LPAccountsPurchased	Int	True	Specifies the number of Lock and Publish account purchased.
Subscription_DOTOAccountsPurchased	Int	True	Specifies number of Marketing Cloud agency reseller accounts purchased.
Subscription_BUAccountsPurchased	Int	True	Defines the number of business units purchased for a subscription.
Subscription_AdvAccountsPurchased	Int	True	This property represents the number of advertising accounts purchased for the account.
Subscription_BeginDate	Datetime	True	Specifies the date a subscription begins.
Subscription_EndDate	Datetime	True	Specifies the end data of an activity.
Subscription_Notes	String	True	Deprecated.
PartnerKey	String	False	Unique identifier provided by partner for an account, accessible only via API.
Client_PartnerClientKey	String	True	The partner client key of the client.
InheritAddress	Bool	False	Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.
UnsubscribeBehavior	Int	True	The behavior of the subscription when unsubscripbed.
Subscription_ContractNumber	String	True	Reserved for future use.
Subscription_ContractModifier	String	True	Reserved for future use.
IsTrialAccount	Bool	False	Reserved for future use.
Client_EnterpriseID	Long	True	Read-only identifier the enterprise of the client.
ParentAccount_ID	Int	False	Read-only identifier for the parent of the account.
ParentAccount_Name	String	True	Name of the parent of the account.
ParentAccount_ParentID	Int	True	Read-only identifier for the parent of the parent of this account.
ParentAccount_CustomerKey	String	True	The customer key of the parent account.
ParentAccount_AccountType	String	True	The account type of the parent account.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Locale_LocaleCode	String	True	The locale code of the locale.
TimeZone_ID	Int	True	Read-only identifier of the timezone.
TimeZone_Name	String	True	Name of the timezone.
Roles	String	False	Collection of roles defined for an account.
ContextualRoles	Int	True	The contextual roles of the account.
ObjectState	String	False	Reserved for future use.
LanguageLocale_LocaleCode	String	True	The locale code of the language layout.
IndustryCode	String	False	The code of the industry.
AccountState	Int	False	The state of the account.
SubscriptionRestrictionFlags	Long	False	Restriction flags of the subscription.

An individual user within an account. This table does not support deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM AccountUser WHERE Id = 123

SELECT * FROM AccountUser WHERE Id IN (123, 456)

SELECT * FROM AccountUser WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Client_Id, Name, Email, UserID, and Password.

INSERT INTO AccountUser (Client_Id, UserId, Name, Email, Password) VALUES (123, 'bcabsbasbcasb', 'Test', '[email protected]', 'testpas@2sowrd')

Update

You must specify the Id and the Client_Id in the WHERE clause when executing an update against this table.

UPDATE AccountUser SET Name = 'changed' WHERE Id = 123 AND Client_Id = 456

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
CreatedDate	Datetime	False	Date and time of the object's creation..
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID [KEY]	Int	False	The Id of the client.
AccountUserID	Int	False	Specifies the Marketing Cloud identifier of an account user.
UserID	String	False	The Id of the user.
Name	String	False	Name of the object or property.
Email	String	False	Default email address for object. Indicates if subscriber information can be used for email sends.
MustChangePassword	Bool	False	Indicates whether user must change password on next login.
ActiveFlag	Bool	False	Specifies the status of an account user.
ChallengePhrase	String	False	Specifies the challenge answer for login assistance.
ChallengeAnswer	String	False	Specifies the challenge answer for login assistance.
IsAPIUser	Bool	False	Indicates if a user can use the API. A value of true indicates the user's password remains the same until actively changed.
NotificationEmailAddress	String	False	Indicates email address to which to send notifications.
Client_PartnerClientKey	String	False	The partner client key of the partner.
Password	String	False	Specified the password of an account user.
Locale_LocaleCode	String	True	The locale code of the locale.
TimeZone_ID	Int	True	The id of the timezone.
TimeZone_Name	String	True	The name of the timezone.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
DefaultBusinessUnit	Int	False	Indicates business unit account user initially accesses.
LanguageLocale_LocaleCode	String	True	The locale code of the language locale.
Client_ModifiedBy	Int	False	Returns user ID for user who modified the object.

A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM BusinessUnit WHERE Id = 123

SELECT * FROM BusinessUnit WHERE Id IN (123, 456)

SELECT * FROM BusinessUnit WHERE CreatedDate > '2017/01/25'

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE BusinessUnit SET Name = 'Changed' WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
AccountType	String	False	Type of Marketing Cloud account. Valid values are BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, PRO_CONNECT_CLIENT.
ParentID	Int	False	Specifies the ID number of the parent account.
BrandID	Int	False	Specifies brand tags to use on an account.
PrivateLabelID	Int	False	Specifies the private label for an account.
ReportingParentID	Int	False	Reserved for future use..
Name	String	False	Name of the object or property.
Email	String	False	Default email address for object.
FromName	String	False	Specifies the default email message From Name.
BusinessName	String	False	Business name of an account's owner.
Phone	String	False	Specifies a phone number.
Address	String	False	The address used to communicate with a Person.
Fax	String	False	Fax number of the account's owner.
City	String	False	City of an account's owner to be displayed in the physical mailing address required at the bottom of all email messages.
State	String	False	Specifies the geographical state of the account's owner.
Zip	String	False	Specifies the zip code of the account's owner.
Country	String	False	Country of an account's owner, as displayed in the physical mailing address required at the bottom of all email messages.
IsActive	Bool	False	Specifies whether or not the object is active.
IsTestAccount	Bool	False	Specifies whether or not an account is a 'Test' account.
Client_ID	Int	False	The Id of the client.
DBID	Int	False	Reserved for future use.
CustomerID	Long	False	The Id of the customer.
DeletedDate	Datetime	False	Date and time of an account's deletion (the value of this property must be set before the account can be deleted).
EditionID	Int	False	Specifies the product edition of the account.
IsTrialAccount	Bool	False	Reserved for future use.
Locale_LocaleCode	String	True	The locale code of the locale.
Client_EnterpriseID	Long	True	The enterprise Id of the client.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CreatedDate	Datetime	False	Date and time of the object's creation.
Subscription_SubscriptionID	String	True	The subscription id of the subscription.
Subscription_HasPurchasedEmails	Bool	True	Reserved for future use..
Subscription_EmailsPurchased	Int	True	Specifies the number of emails purchased in a subscription..
Subscription_Period	String	True	Reserved for future use..
Subscription_AccountsPurchased	Int	True	Marketing Cloud Accounts purchased.
Subscription_LPAccountsPurchased	Int	True	Specifies the number of Lock and Publish account purchased.
Subscription_DOTOAccountsPurchased	Int	True	Specifies number of Marketing Cloud agency reseller accounts purchased.
Subscription_BUAccountsPurchased	Int	True	Defines the number of business units purchased for a subscription.
Subscription_AdvAccountsPurchased	Int	True	This property represents the number of advertising accounts purchased for the account.
Subscription_BeginDate	Datetime	True	Specifies the date a subscription begins..
Subscription_EndDate	Datetime	True	Specifies the end data of an activity..
Subscription_Notes	String	True	Deprecated..
Subscription_ContractNumber	String	True	Reserved for future use..
Subscription_ContractModifier	String	True	Reserved for future use..
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
Client_PartnerClientKey	String	True	Unique identifier provided by partner for an object, accessible only via API.
ParentName	String	False	Specifies the name of the Parent account.
ParentAccount_ID	Int	True	The Id of the parent account.
ParentAccount_Name	String	True	The name of the parent account.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
DefaultSendClassification_ObjectID	String	True	System-controlled, read-only text string identifier for object.
DefaultHomePage_ID	String	True	The Id of the default home page..
InheritAddress	Bool	False	Specifies that an Enterprise 2.0 business unit will inherit the address from the parent business unit.
ContextualRoles	Int	True	The contextual roles of the business unit.
LanguageLocale_LocaleCode	String	True	The locale code of the language locale.

A ContentArea represents a defined section of reusable content.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ContentArea WHERE Id = 123

SELECT * FROM ContentArea WHERE Id IN (123, 456)

SELECT * FROM ContentArea WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name and Content.

INSERT INTO ContentArea (Name, Content) VALUES ('Testing', 'Hello world')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE ContentArea SET Name = 'Changed' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM ContentArea WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
RowObjectID	String	False	Identifier for the row of an object.
ObjectID	String	False	System-controlled, text string identifier for object.
ID [KEY]	Int	False	Identifier for an object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Int	False	The Id of the client.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CreatedDate	Datetime	False	Date and time of the object's creation.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
Name	String	False	Name of the object or property.
Layout	String	False	Indicates layout type of content area.
IsDynamicContent	Bool	False	Indicates if specific content area contains dynamic content.
Content	String	False	Identifies content contained in a content area.
IsSurvey	Bool	False	Indicates whether a specific content area contains survey questions.
IsBlank	Bool	False	Indicates if specified content area contains no content.
Key	String	False	Specifies key associated with content area in HTML body.

Represents a data extension within an account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, CustomerKey, and Fields.

Note: The Salesforce Marketing Cloud APIs have problems with DataExtensions with names longer than 40 characters. Try to limit the name to something relatively short.

INSERT INTO DataExtension (Name, CustomerKey, Fields) VALUES ('TestName', 'TestCustomerKey', 'fieldname1;fieldname2;fieldname3')

Update

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing an update against this table.

UPDATE DataExtension SET ResetRetentionPeriodOnImport = true WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId or CustomerKey or Name in the WHERE clause when executing a delete against this table.

DELETE FROM DataExtension WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Name	String	False	Name of the object or property.
CreatedDate	Datetime	False	Date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Description	String	False	Describes and provides information regarding the object.
IsSendable	Bool	False	Indicates whether you can use a data extension as part of an audience for a message send.
IsTestable	Bool	False	Indicates whether a sendable data extension can be used within tests sends for a message.
SendableDataExtensionField_Name	String	False	The name of the sendable data extension field.
SendableSubscriberField_Name	String	False	The name of the sendablesubscriber field.
Template_CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
CategoryID	Long	False	Specifies the identifier of the folder.
Status	String	False	Defines status of the object.
IsPlatformObject	Bool	False	Indicated whether the object is a platform object.
DataRetentionPeriodLength	Int	False	Specifies the number of time units for which data will be retained.
DataRetentionPeriodUnitOfMeasure	Int	False	Specifies the units of time for which data will be retained.
RowBasedRetention	Bool	False	Indicates whether the data retention policy removes data by row or by entire data extension.
ResetRetentionPeriodOnImport	Bool	False	Indicates whether a data retention period should be reset after a successful import of new data.
DeleteAtEndOfRetentionPeriod	Bool	False	Indicates whether data should be deleted at the end of the retention period.
RetainUntil	String	False	Indicates the date that ends the retention period for a data extension.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Fields	String	A semi-colon separated list of names for the fields to add to this data entension.

Represents an email in a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Email WHERE Id = 123

SELECT * FROM Email WHERE Id IN (123, 456)

SELECT * FROM Email WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name and Subject.

INSERT INTO Email (Name, Subject) VALUES ('Testing', 'Greetings')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE Email SET Name = 'Changed' WHERE Id = 31558

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM Email WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Name	String	False	Name of the object or property.
PreHeader	String	False	Contains text used in preheader of email message on mobile devices.
Folder	String	False	Specifies folder information (Retrieve only) - Deprecated.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
HTMLBody	String	False	Contains HTML body of an email message.
TextBody	String	False	Contains raw text body of a message.
Subject	String	False	Defines the subject of an object.
IsActive	Bool	False	Specifies whether or not the object is active.
IsHTMLPaste	Bool	False	Indicates whether email message was created via pasted HTML.
ClonedFromID	Int	False	ID of email message from which the specified email message was created.
Status	String	False	Defines the status of an object.
EmailType	String	False	Defines the preferred email type.
CharacterSet	String	False	Indicates encoding used in an email message.
HasDynamicSubjectLine	Bool	False	Indicates whether email message contains a dynamic subject line.
ContentCheckStatus	String	False	Indicates whether content validation has completed for this email message.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
ContentAreas	String	False	Contains information on content areas included in an email message.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.

Record that contains the message information, sender profile, delivery profile, and audience information.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM EmailSendDefinition WHERE ObjectID = 123

SELECT * FROM EmailSendDefinition WHERE ObjectID IN (123, 456)

SELECT * FROM EmailSendDefinition WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name, SendClassification_CustomerKey, and Email_Id.

INSERT INTO EmailSendDefinition (Name, SendClassification_CustomerKey, Email_Id) VALUES ('Testing', 13507, 31677)

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE EmailSendDefinition SET Description = 'Changed' WHERE ObjectId = 'acasascas'

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM EmailSendDefinition WHERE ObjectId = 'sdfsdf123'

Columns

Name	Type	ReadOnly	Description
Client_ID	Int	True	The Id of the client.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
ObjectID	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Name	String	False	Name of the object or property.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
Description	String	False	Describes and provides information regarding the object.
SendClassification_CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
SenderProfile_CustomerKey	String	True	User-supplied unique identifier for an object within an object type
SenderProfile_FromName	String	True	Specifies the default email message From Name.
SenderProfile_FromAddress	String	True	Indicates From address associated with a object.
DeliveryProfile_SourceAddressType	String	True	Indicates the source IP address type used with the delivery profile.
DeliveryProfile_PrivateIP	String	True	Contains information on the private IP address associated with a delivery profile.
DeliveryProfile_DomainType	String	True	Defines the type of domain.
DeliveryProfile_PrivateDomain	String	True	Defines private domain to use as part of a delivery profile or send definition.
DeliveryProfile_HeaderSalutationSource	String	True	Defines source of header salutation for a delivery profile or send definition.
DeliveryProfile_FooterSalutationSource	String	True	Defines source of a footer salutation to use as part of a delivery profile or send definition (Default, ContentLibrary, or None).
SuppressTracking	Bool	False	Indicates whether the send definition suppresses tracking results for associated sends.
IsSendLogging	Bool	False	Indicates whether send logging is enabled for the specified send definition
Email_ID	Int	True	The Id of the email.
CCEmail	String	False	Carbon copy email address.
BccEmail	String	False	Indicates email addresses to receive blind carbon copy of a message.
AutoBccEmail	String	False	Defines blind carbon copy email address to which to send a message as part of an email send definition.
TestEmailAddr	String	False	Defines an email address to which to send a test message as part of an email send definition.
EmailSubject	String	False	Subject of the email.
DynamicEmailSubject	String	False	Contains content to be used in a dynamic subject line.
IsMultipart	Bool	False	Indicates whether the email is sent with Multipart/MIME enabled.
IsWrapped	Bool	False	Indicates whether an email send contains the links necessary to process tracking information for clicks.
SendLimit	Int	False	Indicates limit of messages to send as part of a send definition within a predefined send window.
DeduplicateByEmail	Bool	False	Indicates whether a send definition should de-duplicate multiple emails sent to the same email address.
ExclusionFilter	String	False	Contains a string of AMPscript that can evaluate to true or false, used to exclude email addresses from a send definition.
Additional	String	False	The ID for a send that customers use as a campaign ID.
IsPlatformObject	Bool	False	Indicated whether the object is a platform object.

Reserved for future use. This table does not suport deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) query is processed server side:

SELECT * FROM FileTrigger WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: Name.

INSERT INTO FileTrigger (Name) VALUES ('Testing')

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE FileTrigger SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Long	False	The Id of the client.
ExternalReference	String	False	Reserved for future use.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
Status	String	False	Defines status of the object.
StatusMessage	String	False	Describes the status of an API call.
RequestParameterDetail	String	False	Reserved for future use.
ResponseControlManifest	String	False	Reserved for future use.
FileName	String	False	Indicates name of file associated with the object.
LastPullDate	Datetime	False	Reserved for future use.
ScheduledDate	Datetime	False	Reserved for future use.
IsActive	Bool	False	Specifies whether or not the object is active.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_CreatedBy	Int	False	Returns user ID for user who created object
Client_ModifiedBy	Int	False	Returns user ID for user who modified object.

Defines an audience based on specified rules in a filter. This table does not support inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) query is processed server side:

SELECT * FROM FilterDefinition WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE FilterDefinition SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId in the WHERE clause when executing a delete against this table.

DELETE FROM FilterDefinition WHERE Object = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
Client_ID	Int	True	The Id of the client.
Client_ClientPartnerKey	Int	True	User-defined partner key for an account.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Description	String	False	Describes and provides information regarding the object.
DataSource_ID	Int	True	Read-only identifier for an object.
DataSource_ObjectID	String	True	System-controlled, read-only text string identifier for object.
DataSource_Name	Int	True	Name of the object or property.
DataSource_ListName	Int	True	The list name of the data source.
DataSource_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
DataSource_CreatedDate	Datetime	True	Read-only date and time of the object's creation.
DataSource_ModifiedDate	Datetime	True	Indicates the last time object information was modified.
DataFilter	String	False	Filter parts for a filter definition.

Defines a reusable pattern of import options. This table does not support inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ImportDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM ImportDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM ImportDefinition WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectId in the WHERE clause when executing an update against this table.

UPDATE ImportDefinition SET Name = 'Changed' WHERE ObjectId = 'nzxcaslkjd-123'

Delete

You must specify the ObjectId in the WHERE clause when executing a delete against this table.

DELETE FROM ImportDefinition WHERE ObjectId = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
Client_ClientID1	Int	False	The client Id of the client.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
FileSpec	String	False	Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).
AllowErrors	Bool	False	Specifies whether an import should continue after an error occurs.
FieldMappingType	String	False	Defines how fields are mapped within an import definition.
FileType	String	False	Specifies column delimiter of a file (CSV, TAB, or Other).
UpdateType	String	False	Indicates update type associated with an import definition.
MaxFileAge	Int	False	Specifies the age of the oldest file to be included in an import definition.
MaxFileAgeScheduleOffset	Int	False	Specifies an offset in hours to associate with a file age for accomodating timezone differences.
MaxImportFrequency	Int	False	Specifies the number of hours to wait before allowing a file to be imported again.
DestinationObject_ID	Int	False	Identifier for an object.
DestinationObject_ObjectID	String	False	System-controlled, text string identifier for object.
Notification_ResponseType	String	True	The response type of the notification.
Notification_ResponseAddress	String	False	The response address of the notification.
RetrieveFileTransferLocation_ObjectID	String	False	System-controlled, text string identifier for object.
Delimiter	String	False	Specifies the delimiter used as part of an import definition.
HeaderLines	Int	False	Specifies the number of lines in the file that are header lines that should not be processed.
EndOfLineRepresentation	String	False	Specifies the line-ending character(s) used in delimited files to be imported.
NullRepresentation	String	False	Defines character used to represent a null value during an import.
StandardQuotedStrings	Bool	False	Specifies whether standard quoted strings are used as part of an import definition.
DateFormattingLocale_LocaleCode	String	False	The locale code of the date formatting locale.

A marketing list of subscribers.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM List WHERE Id = 123

SELECT * FROM List WHERE Id IN (123, 456)

SELECT * FROM List WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following field when inserting to this table: ListName.

INSERT INTO List (ListName) VALUES ('Test')

Update

You must specify the Id in the WHERE clause when executing an update against this table.

UPDATE List SET ListName = 'Changed' WHERE Id = 123

Delete

You must specify the Id in the WHERE clause when executing a delete against this table.

DELETE FROM List WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
ObjectID	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
ListName	String	False	Name of a specific list.
Description	String	False	Describes and provides information regarding the object.
Category	Int	False	ID of the folder that an item is located in.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
ListClassification	String	True	Specifies the classification for a list.
AutomatedEmail_ID	Int	False	Identifier for an object.

Indicates a file within the Portfolio of a Marketing Cloud account.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM Portfolio WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')

SELECT * FROM Portfolio WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: DisplayName, FileName, CustomerKey, and Source_URN.

INSERT INTO Portfolio (DisplayName, FileName, CustomerKey,  Source_URN) VALUES ('portdisplayname', 'portfilename.jpg', 'portcuskey', 'https://example.com/image.jpg')

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE Portfolio SET DisplayName = 'ChangedDisplayName' WHERE ObjectID = 'nzxcaslkjd-123'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
RowObjectID	String	False	Identifier for the row of an object.
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Int	False	The Id of the client.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.
FileName	String	False	Indicates name of file associated with the object.
DisplayName	String	False	Name to be displayed for an item within a Portfolio.
Description	String	False	Describes and provides information regarding the object.
TypeDescription	String	False	Describes type for a Portfolio object.
IsUploaded	Bool	False	Indicates whether the Portfolio object in question was uploaded.
IsActive	Bool	False	Specifies whether or not the object is active.
FileSizeKB	Int	False	Specifies file size of a Portfolio item.
ThumbSizeKB	Int	False	Indicates size of a thumbnail image associated with a Portfolio object.
FileWidthPX	Int	False	Specifies the width of a Portfolio image in pixels.
FileHeightPX	Int	False	Specifies height of image contained in Portfolio (value)
FileURL	String	False	Specifies the URL at which a Portfolio file is stored.
ThumbURL	String	False	Indicates URL of a thumbnail image associated with a Portfolio object.
CacheClearTime	Datetime	False	Reserved for future use.
CategoryType	String	False	Defines whether a folder within a Portfolio is shared to other account users or not. Valid values are shared_portfolio, media.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
CreatedBy	Int	False	The Id of the user who created the Portfolio.
ModifiedBy	Int	False	The id of the user who modified the Portfolio.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
ModifiedByName	String	True	The name of the user who modified the Portfolio.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
Source_URN	String	A URN (uniform resource name) of the location of the source.

Reserved for future use. This table does not support deletes or inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ProgramManifestTemplate WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM ProgramManifestTemplate WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-123')

SELECT * FROM ProgramManifestTemplate WHERE CreatedDate > '2017/01/25'

Update

You must specify the ObjectID in the WHERE clause when executing an update against this table.

UPDATE ProgramManifestTemplate SET Content = 'ChangedContent' WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, read-only text string identifier for object.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Client_ID	Long	False	The Id of the client.
Name	String	False	Name of the object or property.
Description	String	False	Describes and provides information regarding the object.
Type	String	False	Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. Indicates the type of email to send to the address. Valid values include Text and HTML.
OperationType	String	False	Specifies metadata about the type of operation to perform.
Content	String	False	Identifies content contained in a content area.
IsActive	Bool	False	Specifies whether or not the object is active.
CreatedDate	Datetime	False	Read-only date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.

Represents a SQL query activity accessed and performed by the SOAP API. This table does not support updates or inserts.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'

SELECT * FROM QueryDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 456)

SELECT * FROM QueryDefinition WHERE CreatedDate > '2017/01/25'

Delete

You must specify the ObjectID in the WHERE clause when executing a delete against this table.

DELETE FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'

Columns

Name	Type	ReadOnly	Description
ObjectID [KEY]	String	False	System-controlled, text string identifier for object.
Client_ID	Int	False	The Id of the client.
Name	String	False	Name of the object or property.
CustomerKey	String	False	User-supplied unique identifier for an object within an object type.
Description	String	False	Describes and provides information regarding the object.
QueryText	String	False	Specifies text associated with a query definition.
TargetType	String	False	Indicates target type for a query definition.
DataExtensionTarget_Name	String	False	Name of the object or property.
DataExtensionTarget_CustomerKey	String	False	User-supplied unique identifier for an object within an object type
DataExtensionTarget_Description	String	False	Describes and provides information regarding the object.
TargetUpdateType	String	False	Indicates the target update type for a query definition.
FileType	String	False	Specifies column delimiter of a file (CSV, TAB, or Other).
FileSpec	String	False	Defines the file-naming pattern associated with an activity (valid substitutions include%%YEAR%%, %%MONTH%%, and %%DAY%%).
Status	String	False	Defines status of object.
CreatedDate	Datetime	False	Indicated the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
CategoryID	Int	False	Specifies the identifier of the folder containing the email.

Details configuration settings for the reply mail management in an account. This table does not support deletes.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM ReplyMailManagementConfiguration WHERE Id = 123

SELECT * FROM ReplyMailManagementConfiguration WHERE Id IN (123, 456)

SELECT * FROM ReplyMailManagementConfiguration WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: EmailDisplayName and EmailReplyAddress.

INSERT INTO ReplyMailManagementConfiguration (EmailDisplayName, EmailReplyAddress) VALUES ('Test', '[email protected]')

Update

You must set a new value for EmailReplyAddress when executing an update against this table, and also supply its Id.

UPDATE ReplyMailManagementConfiguration SET EmailReplyAddress = '[email protected]' WHERE Id = 123

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
Client_ID	Int	True	The Id of the client.
EmailDisplayName	String	False	Specifies the From name associated with the From email address as part of reply mail management configuration.
ReplySubdomain	String	False	Specifies subdomain associated with a reply mail management subdomain.
EmailReplyAddress	String	False	Specifies forwarding address for inbound emails resulting from a send.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
DNSRedirectComplete	Bool	False	Specifies whether a reply domain's DNS has been redirected to the Marketing Cloud IP addresses.
DeleteAutoReplies	Bool	False	Specifies whether auto-replies to a send should be deleted instead of forwarded to the RMM-configured email address.
SupportUnsubscribes	Bool	False	Indicates whether a reply mail management configuration allows subscribers to unsubscribe.
SupportUnsubKeyword	Bool	False	Indicates whether a reply mail management configuration supports a unsubscribe keyword.
SupportUnsubscribeKeyword	Bool	False	Indicates whether a reply mail management configuration supports a unsubscribe keyword.
SupportRemoveKeyword	Bool	False	Indicates whether a reply mail management configuration supports a remove keyword.
SupportOptOutKeyword	Bool	False	Indicates whether a reply mail management configuration supports an opt-out keyword.
SupportLeaveKeyword	Bool	False	Indicates whether a reply mail management configuration supports a leave keyword.
SupportMisspelledKeywords	Bool	False	Indicates whether a reply mail management configuration supports misspelled keywords.
SendAutoReplies	Bool	False	Indicates whether automatic replies should be sent as part of a reply mail management configuration.
AutoReplySubject	String	False	Contains the subject of the email message sent as an automatic reply.
AutoReplyBody	String	False	Contains the content of the message sent as an automatic reply.
ForwardingAddress	String	False	Specifies forwarding address for inbound emails resulting from a send.
ConversationLifetimeDays	Int	False	The number of lifetime days for a conversation.
ConversationLifetimeCycles	Int	False	The number of lifetime cycles for a conversation.
AnonymousRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousRuleSet_Name	Int	True	Name of the object or property.
AnonymousRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousAckTriggeredSend_Name	String	True	Name of the object or property.
AnonymousAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
AnonymousForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
AnonymousForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
AnonymousForwardTriggeredSend_Name	String	True	Name of the object or property.
AnonymousForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ResponderConversationRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationRuleSet_Name	Int	True	Name of the object or property.
ResponderConversationRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationAckTriggeredSend_Name	String	True	Name of the object or property.
ResponderConversationAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ResponderConversationForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ResponderConversationForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ResponderConversationForwardTriggeredSend_Name	String	True	Name of the object or property.
ResponderConversationForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InitiatorConversationRuleSet_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationRuleSet_Name	Int	True	Name of the object or property.
InitiatorConversationRuleSet_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationAckTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationAckTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationAckTriggeredSend_Name	String	True	Name of the object or property.
InitiatorConversationAckTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InitiatorConversationForwardTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
InitiatorConversationForwardTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
InitiatorConversationForwardTriggeredSend_Name	String	True	Name of the object or property.
InitiatorConversationForwardTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
ConversationExpirationTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
ConversationExpirationTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
ConversationExpirationTriggeredSend_Name	String	True	Name of the object or property.
ConversationExpirationTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
MultiUseViolationTriggeredSend_ObjectID	String	True	System-controlled, read-only text string identifier for object.
MultiUseViolationTriggeredSend_CustomerKey	String	True	User-supplied unique identifier for an object within an object type.
MultiUseViolationTriggeredSend_Name	String	True	Name of the object or property.
MultiUseViolationTriggeredSend_TriggeredSendStatus	String	True	Represents status of triggered send.
InboundAddressIsOneUse	Bool	False	Specified whether the inbound address is one use.

Used to send email and retrieve aggregate data. This table does not support deletes or updates.

Table-Specific Information

Select

The Sync App uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but date-time values: =, !=, <>, >, >=, <, <=, IN. For date-time values, only > and < are supported. The Sync App processes other filters client-side within the Sync App.

For example, the following (but not only) queries are processed server side:

SELECT * FROM Send WHERE Id = 123

SELECT * FROM Send WHERE Id IN (123, 456)

SELECT * FROM Send WHERE CreatedDate > '2017/01/25'

Insert

You must specify the following fields when inserting to this table: FromName, Email_Id, and List_Id.

INSERT INTO Send (FromName, Email_Id, List_Id) VALUES ('NASA', 31677, 52362)

Columns

Name	Type	ReadOnly	Description
ID [KEY]	Int	False	Identifier for an object.
PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
CreatedDate	Datetime	False	Indicates the date and time of the object's creation.
ModifiedDate	Datetime	False	Indicates the last time object information was modified.
Client_ID	Int	False	The Id of the client.
Client_PartnerClientKey	String	False	User-defined partner key for an account.
Email_ID	Int	False	Identifier for an object.
Email_PartnerKey	String	False	Unique identifier provided by partner for an object, accessible only via API.
SendDate	Datetime	False	Indicates the date on which a send occurred.
FromAddress	String	False	Indicates From address associated with a object.
FromName	String	False	Specifies the default email message From Name.
Duplicates	Int	False	Represent the number of duplicate email addresses associated with a send.
InvalidAddresses	Int	False	Specifies the number of invalid addresses associated with a send.
ExistingUndeliverables	Int	False	Indicates whether bounces occurred on previous send.
ExistingUnsubscribes	Int	False	Indicates whether unsubscriptions occurred on previous send.
HardBounces	Int	False	Indicates number of hard bounces associated with a send.
SoftBounces	Int	False	Indicates number of soft bounces associated with a specific send.
OtherBounces	Int	False	Specifies number of Other-type bounces in a send.
ForwardedEmails	Int	False	Number of emails forwarded for a send.
UniqueClicks	Int	False	Indicates number of unique clicks on message.
UniqueOpens	Int	False	Indicates number of unique opens resulting from a triggered send.
NumberSent	Int	False	Number of emails actually sent as part of an email send.
NumberDelivered	Int	False	Number of sent emails that did not bounce.
NumberTargeted	Int	False	Indicates the number of possible recipients for an email send.
NumberErrored	Int	False	Number of emails not sent as part of a send because an error occurred while trying to build the email.
NumberExcluded	Int	False	Indicates the number recipients excluded froman email send because of a held, unsubscribed, master unsubscribed, or global unsubscribed status.
Unsubscribes	Int	False	Indicates the number of unsubscribe events associated with a send.
MissingAddresses	Int	False	Specifies number of missing addresses encountered within a send.
Subject	String	False	Defines the status of an object.
PreviewURL	String	False	Indicates URL used to preview the message associated with a send.
SentDate	Datetime	False	Indicates date on which a send took place.
EmailName	String	False	Specifies the name of an email message associated with a send.
Status	String	False	The status of the object.
IsMultipart	Bool	False	Indicates whether the email is sent with Multipart/MIME enabled.
SendLimit	Int	False	Indicates limit of messages to send as part of a send definition within a predefined send window.
SendWindowOpen	Datetime	False	Defines the beginning of a send window for a send definition.
SendWindowClose	Datetime	False	Defines the end of a send window for a send definition.
IsAlwaysOn	Bool	False	Indicates whether the request can be performed while the system is is maintenance mode.
Additional	String	False	The ID for a send that customers use as a campaign ID.
BCCEmail	String	False	Indicates email addresses to receive blind carbon copy of a message.
EmailSendDefinition_ObjectID	String	False	System-controlled, text string identifier for object.
EmailSendDefinition_CustomerKey	String	False	The customer key of the email send definition.

Pseudo-Columns

Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.

Name	Type	Description
List_Id	Int	The Id of the list to be sent.