Salesforce Marketing Cloud Connection Details¶
Introduction¶
Connector Version
This documentation is based on version 21.0.8662 of the connector.
Important
We recommend using the Salesforce Marketing Cloud v2 connector to connect to Salesforce Marketing Cloud as it allows for additional configuration properties.
Get Started¶
Salesforce Marketing Cloud Version Support
Establish a Connection¶
Authenticate to the Salesforce Marketing Cloud REST API¶
To connect, set Schema
to "REST". The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you will need to create an app to obtain the OAuthClientId
and OAuthClientSecret
connection properties. See Using OAuth Authentication for an authentication guide.
Authenticate to the Salesforce Marketing Cloud SOAP API¶
The Salesforce Marketing Cloud SOAP API can connect using either your login credentials, or Using OAuth Authentication.
To connect to data using basic (login credentials) authentication, set the following:
User
: The Salesforce Marketing Cloud user account used to authenticate.Password
: The password used to authenticate the user.AuthScheme
: Set this to Basic.UseLegacyAuthentication
: Set this to True.
to your login credentials.
Connect to the Salesforce Marketing Cloud APIs¶
Once you have authenticated to either the SOAP or REST API, you are ready to connect to data.
You may optionally 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.
Use OAuth Authentication¶
OAuth requires the authenticating user to interact with Salesforce Marketing Cloud using the browser. The connector facilitates this in various ways, as described below.
Custom Credentials¶
You will need to register an app to obtain the OAuthClientId
and OAuthClientSecret
.
Create a Custom OAuth App¶
See Creating a Custom OAuth App for the procedure.
Custom Credentials¶
Desktop Authentication with your OAuth App¶
Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.
Get an OAuth Access Token¶
After setting the following, you are ready to connect:
OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.APIIntegrationType
: Set this to either Web-App or Server-to-Server depending on which you selected when creating your app.OAuthGrantType
: Alternatively, instead of settingAPIIntegrationType
, theOAuthGrantType
may be set directly to either Code (Web-App) or Client (Server-to-Server). It may be desirable to useOAuthGrantType
in cases where muliple produts are being used to keep things consistent.CallbackURL
: Set this to the Redirect URL in your app settings.InitiateOAuth
: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting theOAuthAccessToken
. .AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
When you connect the connector opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The connector then completes the OAuth process:
- Extracts the access token from the callback URL and authenticates requests.
- Obtains a new access token when the old one expires.
- Saves OAuth values in
OAuthSettingsLocation
to be persisted across connections.
Headless Machines¶
Use OAuth on a Headless Machine¶
To create Salesforce Marketing Cloud data sources on headless servers or other machines on which the connector cannot open a browser, you need to authenticate from another machine. Authentication is a two-step process.
- Instead of installing the connector on another machine, you can follow the steps below to obtain the
OAuthVerifier
value. Or, you can install the connector on another machine and transfer the OAuth authentication values, after you authenticate through the usual browser-based flow. - You can then configure the connector to automatically refresh the access token from the headless machine.
Use the Credentials for a Custom OAuth App¶
Create a Custom OAuth App
See Creating a Custom OAuth App for a procedure. You can then follow the procedures below to authenticate and connect to data.
Obtain a Verifier Code
Set the following properties on the headless machine:
InitiateOAuth
: Set this to OFF.OAuthClientId
: Set this to the App ID in your app settings.OAuthClientSecret
: Set this to the App Secret in your app settings.AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
You can then follow the steps below to authenticate from another machine and obtain the OAuthVerifier
connection property.
- Call the GetOAuthAuthorizationURL stored procedure with the CallbackURL input parameter set to the exact Redirect URI you specified in your app settings.
- Open the returned URL in a browser. Log in and grant permissions to the connector. You are then redirected to the callback URL, which contains the verifier code.
- Save the value of the verifier code. You will set this in the
OAuthVerifier
connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
OAuthClientId
: Set this to the consumer key in your app settings.OAuthClientSecret
: Set this to the consumer secret in your app settings.OAuthVerifier
: Set this to the verifier code.OAuthSettingsLocation
: Set this to persist the encrypted OAuth authentication values to the specified file.InitiateOAuth
: Set this to REFRESH.AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
Connect to Data
After the OAuth settings file is generated, set the following properties to connect to data:
OAuthSettingsLocation
: Set this to the file containing the encrypted OAuth authentication values. Make sure this file gives read and write permissions to the provider to enable the automatic refreshing of the access token.InitiateOAuth
: Set this to REFRESH.AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
Transfer OAuth Settings
Follow the steps below to install the connector on another machine, authenticate, and then transfer the resulting OAuth values.
On a second machine, install the connector and connect with the following properties set:
OAuthSettingsLocation
: Set this to a writable text file.InitiateOAuth
: Set this to GETANDREFRESH.OAuthClientId
: Set this to the Client ID in your app settings.OAuthClientSecret
: Set this to the Client Secret in your app settings.CallbackURL
: Set this to the Callback URL in your app settings.AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
Test the connection to authenticate. The resulting authentication values are written, encrypted, to the path specified by OAuthSettingsLocation
. 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 to connect to data:
InitiateOAuth
: Set this to REFRESH.OAuthSettingsLocation
: Set this to the path to your OAuth settings file. Make sure this file gives read and write permissions to the connector to enable the automatic refreshing of the access token.AccountId
: Set this to the specific MID of the target business unit. This is not available for legacy packages.
Create a Custom OAuth App¶
Create an App¶
You can follow the procedure below to register an app and obtain the OAuth client credentials, the Client ID and Client Secret:
- Log in to your Salesforce Marketing Cloud Go to Marketing Cloud | Administration | Installed Packages.
- Click
New
. - Give the package a name and description.
- Save the package. Once the package is saved, you see important details about the package. See Installed Packages Definitions for more information about each field. You see the Package ID, JWT Signing Secret, and Source Account only for packages created in your account.
- Under Components, click Add Component.
- Select API Integration.
- You must select
Server-to-Server
orWeb App
as integration type if the package supports enhanced functionality. - Assign the appropriate scope for your integration.
- Perform server-to-server requests... is automatically selected for all API Integrations.
- Select Perform requests on behalf of the user... if this package contains a Marketing Cloud app.
- Select the Marketing Cloud scope for your API calls. Assign only the scope your package needs.
- Save the component.
- Under the component details, you can find the
Client ID
and Client Secret.
Select From Data Extensions in Salesforce Marketing Cloud¶
The connector offers the possibility to select, insert, update, and delete data from data extensions as relational tables. To query a data extension, it must be selected in step 1 of a Salesforce Marketing Cloud activity. Data extension names cannot be entered manually.
Select 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: If your Salesforce Marketing Cloud account contains more than one Business Unit, then the ClientID input has to be specified. You may use semi-colons (;) to specify more than one ClientID.
SELECT * FROM DataExtensionObject_fsefes3 WHERE ClientID = '1234567'
Insert data into data extensions¶
INSERT INTO DataExtensionObject_fsefes3(FieldName1, FieldName2, FieldName3) VALUES ('One', 'Two', 'Three')
Update data from data extensions¶
UPDATE DataExtensionObject_secondtest15 SET [Name] = 'ChangedFromTheApi' WHERE [Email Address] = 'update_me@gmail.com'
Note: A primary key has to exist for this data extension for the update to work.
Delete data from data extensions¶
DELETE FROM DataExtensionObject_secondtest15 WHERE [Email Address] = 'delete_me@gmail.com'
Note: A primary key has to exist for this data extension for the deletion to work.
Important Notes¶
Configuration Files and Their Paths¶
- All references to adding configuration files and their paths refer to files and locations on the Jitterbit agent where the connector is installed. These paths are to be adjusted as appropriate depending on the agent and the operating system. If multiple agents are used in an agent group, identical files will be required on each agent.
Advanced Features¶
This section details a selection of advanced features of the Salesforce Marketing Cloud connector.
User Defined Views
The connector 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 connector handles TLS/SSL certificate negotiations. You can choose from various certificate formats; see the SSLServerCert
property under "Connection String Options" for more information.
Proxy
To configure the connector using private agent proxy settings, select the Use Proxy Settings
checkbox on the connection configuration screen.
User Defined Views¶
The Salesforce Marketing Cloud connector allows you to define a virtual table whose contents are decided by a pre-configured query. These are called User Defined Views, which are useful in situations where you cannot directly control the query being issued to the driver, e.g. when using the driver from Jitterbit. The User Defined Views can be used to define predicates that are always applied. If you specify additional predicates in the query to the view, they are combined with the query already defined as part of the view.
There are two ways to create user defined views:
- Create a JSON-formatted configuration file defining the views you want.
- DDL statements.
Define Views Using a Configuration File¶
User Defined Views are defined in a JSON-formatted configuration file called UserDefinedViews.json
. The connector automatically detects the views specified in this file.
You can also have multiple view definitions and control them using the UserDefinedViews
connection property. When you use this property, only the specified views are seen by the connector.
This User Defined View configuration file is formatted as follows:
- Each root element defines the name of a view.
- Each root element contains a child element, called
query
, which contains the custom SQL query for the view.
For example:
{
"MyView": {
"query": "SELECT * FROM Subscriber WHERE MyColumn = 'value'"
},
"MyView2": {
"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
}
}
Use the UserDefinedViews
connection property to specify the location of your JSON configuration file. For example:
"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"
Schema for User Defined Views¶
User Defined Views are exposed in the UserViews
schema by default. This is done to avoid the view's name clashing with an actual entity in the data model. You can change the name of the schema used for UserViews by setting the UserViewsSchemaName
property.
Work with User Defined Views¶
For example, a SQL statement with a User Defined View called UserViews.RCustomers
only lists customers in Raleigh:
SELECT * FROM Customers WHERE City = 'Raleigh';
An example of a query to the driver:
SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';
Resulting in the effective query to the source:
SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';
That is a very simple example of a query to a User Defined View that is effectively a combination of the view query and the view definition. It is possible to compose these queries in much more complex patterns. All SQL operations are allowed in both queries and are combined when appropriate.
SSL Configuration¶
Customize the SSL Configuration¶
By default, the connector 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.
Data Model¶
The Salesforce Marketing Cloud connector 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.
Collaborative Query Processing
The connector offloads as much of the SELECT statement processing as possible to the Salesforce Marketing Cloud APIs and then processes the rest of the query within the connector.
See SupportEnhancedSQL
for more information on how the connector circumvents API limitations with in-memory client-side processing.
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.
REST Data Model¶
The connector 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.
Tables¶
The connector models the data in Salesforce Marketing Cloud into a list of tables that can be queried using standard SQL statements.
Generally, querying Salesforce Marketing Cloud tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
Salesforce Marketing Cloud Connector 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. |
Subscriptions | Create, update, delete and query event notification subscriptions. |
Assets¶
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_')
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. |
Callbacks¶
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. |
Campaigns¶
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. |
Categories¶
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. |
EventDefinitions¶
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. |
FacebookMessengerProperties¶
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. |
JourneyActivities¶
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. |
Journeys¶
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. |
LineMessengerProperties¶
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. |
Subscriptions¶
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¶
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Salesforce Marketing Cloud Connector 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. |
SmsStatusCodes | Query sms status codes. |
AssetTypes¶
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. |
CampaignAssets¶
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. |
Contact¶
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. |
Contacts¶
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 |
JourneyAuditLogs¶
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. |
SmsStatusCodes¶
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. |
Stored Procedures¶
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Salesforce Marketing Cloud Connector Stored Procedures¶
Name | Description |
---|---|
CreateImportSendDeliveryReport | Generates a .csv fiie containing information regarding SMS message delivery for a specific MessageList and places the report in the Enhanced FTP location for the Marketing Cloud account. |
CreateKeyword | Creates a keyword on an account. |
CreateMessageListDeliveryReport | Triggers a delivery report for messageList API. |
CreateOptInMessage | Creates an SMS opt-in message permitting contacts to subscribe to further SMS messages. |
DeleteKeyword | Deletes a keyword on an account. |
FireEntryEvent | Fire the entry event that initiates the journey. |
GetChannelViewHtml | Returns the requested channel view's compiled HTML for the asset. |
GetDeliveryStatusOfQueuedMO | Retrieves the delivery status of a queued MO. |
GetFileForAnAsset | Gets the binary file for an asset. |
GetHeaderFooterAccount | Gets the default header and footer for an account. |
GetHeaderFooterEmail | Gets the header and footer for an email. |
GetImportSendStatus | Retrieves the status of a ImportSend automation. |
GetImportStatus | Retrieves the status of an import job. |
GetJourneyPublicationStatus | Retrieves the status of a journey publication. |
GetMessageContactHistory | Retrieves the last message sent to a mobile number. |
GetMessageContactStatus | Retrieves the overall delivery status of a message to a contact. |
GetMessageListStatus | Returns status for a message sent to a group of mobile numbers. |
GetOAuthAccessToken | Gets an authentication token from Salesforce Marketing Cloud. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. |
GetRefreshListStatus | Retrieves the refresh list status. |
GetSubscriptionStatus | Returns subscription status for mobile numbers or subscriber keys. |
GetTrackingHistoryOfQueuedMO | Retrieves the tracking history of a queued MO. |
ImportAndSendMessage | Imports and sends. |
PostMessageToList | Initiates a message to one or more contact lists. |
PostMessageToNumber | Initiates a message to one or more mobile numbers. |
PublishJourney | Publishes a journey version asynchronously. |
QueueContactImport | Queues a contact import. |
QueueMoMessage | Queues an MO message for send. |
RefreshList | Refreshes a list. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Salesforce Marketing Cloud. |
SendMessageToRecipient | Send an OTT message to the recipient. Supported OTT networks are Facebook Messenger and LINE. |
StopJourney | Stop a running journey. |
CreateImportSendDeliveryReport¶
Generates a .csv fiie containing information regarding SMS message delivery for a specific MessageList and places the report in the Enhanced FTP location for the Marketing Cloud account.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TokenId | String | True | The ID provided in the MessageList REST response. |
FileName | String | True | The name of the report file in your FTP/reports folder. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the csv file was successfully generated or not. |
CreateKeyword¶
Creates a keyword on an account.
Input¶
Name | Type | Required | Description |
---|---|---|---|
LongCode | String | False | The long code that the keyword will be created on. |
ShortCode | String | False | The short code that the keyword will be created on. |
Keyword | String | False | The keyword that will be created. |
CountryCode | String | False | The two letter country code specifying the country that short code belongs to. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
KeywordId | String | The ID of the created keyword. |
CreateMessageListDeliveryReport¶
Triggers a delivery report for messageList API.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TokenId | String | True | The ID provided in the MessageList REST response. |
MessageId | String | True | The API key of the message definition (configured in the MobileConnect user interface). |
FileName | String | True | The name of the report file in your FTP/reports folder. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the delivery report was successfully triggered or not. |
CreateOptInMessage¶
Creates an SMS opt-in message permitting contacts to subscribe to further SMS messages.
Input¶
Name | Type | Required | Description |
---|---|---|---|
LongCode | String | False | Long code that the message will be created on. Either long code or short code is required. |
ShortCode | String | False | Short code that the message will be created on. Either long code or short code is required. |
MessageName | String | True | Name of the message. |
MessageText | String | False | Text of the message. |
CountryCode | String | False | Two-letter country code specifying the country that the short code belongs to. Required for short code. |
Keyword | String | True | Keyword to which users are subscribed |
MessageOptInType | String | True | Opt-in template: Single, Double, or Age. Single opt-in requires users to text one keyword (e.g., JOIN) to opt in. Double opt-in requires users to text in a second keyword (e.g., Y or YES) to confirm opt in. Age means double opt-in with age confirmation. It requires users to text in their age after texting JOIN. If age is above the minimum, the user is opted in. |
ResponseMessage | String | False | Response sent to users after they text in the keyword for Single. Required for Single. Not used for Double or Age. |
DoubleOptInInitialMessage | String | False | Response sent to users that asks for confirmation of opt-in (for Double) or for their age (for Age). Required for Double and Age. Not used for Single. |
DoubleOptInConfirmationMessage | String | False | Response sent to users after they text Y or YES for Double. Required for Double or Age. Not used for Single. |
DoubleOptInValidResponses | String | False | Valid responses that users can text in for Double, such as Y or YES. Required for Double. Not used for Single or Age. |
OptInInvalidAgeMessage | String | False | Response sent to users whose age is below the minimum. Required for Age. Not used for Single or Double. |
MinimumAge | Integer | False | Minimum age that users can text in and be opted in. Required for Age. Not used for Single or Double. |
AllowSingleOptIn | Boolean | False | Determines whether users receive a different response if they are already opted in: True or False. |
DuplicateOptInMessage | String | False | Response sent to users who are already opted in. |
OptinErrorMessage | String | True | Response sent to users if an error occurred while opting them in. |
StartDate | Date | True | Date the message becomes active. |
EndDate | Date | True | Date the message becomes inactive. If users try to opt in to an inactive message, they receive the default keyword response for the code or the new message that the keyword has been set up for. |
NextKeyword | String | False | Keyword to append to the next message received from users. For example, the NextKeyword is ZIP. After a user texts in JOIN, the response is 'Welcome. Please send your zip code.' Users can text in their zip code without using the keyword ZIP. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
MessageID | String | The ID of the created opt-in message. |
DeleteKeyword¶
Deletes a keyword on an account.
Delete Keyword By Id¶
Deletes a keyword on an account given a keyword Id.
EXECUTE DeleteKeyword KeywordId='alm5LXNSSktGMGluRznRb1Rb1R5MDZFQTo4Njow'
Delete Keyword By Longcode¶
Deletes a keyword on an account given a keyword and long code.
EXECUTE DeleteKeyword LongCode='5550003232', Keyword='TEST'
Delete Keyword By Shortcode¶
Deletes a keyword on an account given a keyword, short code, and country code.
EXECUTE DeleteKeyword ShortCode='89239', Keyword='TEST', CountryCode='US'
Input¶
Name | Type | Required | Description |
---|---|---|---|
KeywordId | String | False | Encoded ID of keyword that will be deleted |
Keyword | String | False | The keyword that will be deleted. |
LongCode | String | False | The long code of the keyword that will be deleted |
ShortCode | String | False | The short code of the keyword that will be deleted. |
CountryCode | String | False | The two letter country code specifying the country that short code belongs to. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The current status after the delete operation. |
FireEntryEvent¶
Fire the entry event that initiates the journey.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ContactKey | String | True | The ID that uniquely identifies a subscriber/contact. |
EventDefinitionKey | String | True | Find the EventDefinitionKey in Event Administration after the event is created and saved. This is true for both standard and custom events. Do not include a period in the event definition key. |
Data | String | False | Properties of the event. Only required if defined in a custom event or by the event. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
EventInstanceId | String | The instance ID of the entry event. |
GetChannelViewHtml¶
Returns the requested channel view's compiled HTML for the asset.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AssetId | Integer | True | The ID of the asset. |
ViewName | String | True | The name of the asset view to retrieve. |
Thumbnail | Boolean | False | Set to true to return a base64-encoded thumbnail image. |
IncludeHeaderFooter | Boolean | False | If asset has HTML or text views, set to true to include the message header and footer. |
IncludeDesignContent | Boolean | False | Set to true to include design content in the thumbnail image. |
DownloadPath | String | False | The Location of the file in which to save the compiled HTML. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Returns True if the download succeeded. |
Compiled | String | A representation of the view. |
GetDeliveryStatusOfQueuedMO¶
Retrieves the delivery status of a queued MO.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TokenId | String | True | Token ID returned for the queued MO. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Tracking | String | The tracking history of the queued MO. |
GetFileForAnAsset¶
Gets the binary file for an asset.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AssetId | Integer | True | The ID of the asset. |
DownloadPath | String | False | The Location where the file will be stored. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Returns True if the download succeeded. |
Content | String | A Base64-encoded string of the file. |
GetHeaderFooterAccount¶
Gets the default header and footer for an account.
Result Set Columns¶
Name | Type | Description |
---|---|---|
HTMLHeader | String | The HTML header of the salutation. |
HTMLFooter | String | The HTML footer of the salutation. |
TextHeader | String | The text header of the salutation. |
TextFooter | String | The text footer of the salutation. |
GetHeaderFooterEmail¶
Gets the header and footer for an email.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AssetId | Integer | True | The ID of the asset. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
HTMLHeader | String | The HTML header of the email. |
HTMLFooter | String | The HTML footer of the email. |
TextHeader | String | The text header of the email. |
TextFooter | String | The text footer of the email. |
GetImportSendStatus¶
Retrieves the status of a ImportSend automation.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TokenID | String | True | The ID provided in the ImportAndSend SP. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The status of the ImportSend automation. |
LastUpdate | Datetime | The last date when the ImportSend automation was updated. |
CreatedTime | Datetime | The date when the ImportSend automation was created. |
StartTime | Datetime | The date when the ImportSend automation started. |
CompletedTime | Datetime | The date when the ImportSend automation finished. |
LastRunTime | Datetime | The last date when the ImportSend automation was running. |
Source | String | The source of the ImportSend automation. |
Inserted | Integer | Number of new records in _MobileSubscription. |
Updated | Integer | Number of updated records. |
Invalid | Integer | Number of invalid rows in the import file. |
GetImportStatus¶
Retrieves the status of an import job.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ListID | String | True | The ID of the List found in the MobileConnect interface. |
TokenID | String | True | The unique ID returned when using the ImportQueue operation. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The message text sent in the SMS message. |
GetJourneyPublicationStatus¶
Retrieves the status of a journey publication.
Input¶
Name | Type | Required | Description |
---|---|---|---|
StatusId | String | True | The status ID of a journey publication. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The publishing status for the specified statusId. |
GetMessageContactHistory¶
Retrieves the last message sent to a mobile number.
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | Message ID provided for the messageContact. |
TokenId | String | True | Token ID returned for the messageContact. |
MobileNumber | String | True | Mobile number for the messageContact. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Count | Integer | The total of mobile numbers included in the send request subtracting the number of unsubscribed recipients. |
CreateDate | Datetime | Date when the MessageContact send was submitted. |
Status | String | Delivery status of a message to a contact. |
History | String | History information related to the last message sent to a mobile number. |
GetMessageContactStatus¶
Retrieves the overall delivery status of a message to a contact.
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | Message ID provided for the messageContact. |
TokenId | String | True | Token ID returned for the messageContact. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Message | String | The message text sent in the SMS message. |
Count | Integer | The total of mobile numbers included in the send request subtracting the number of unsubscribed recipients. |
CreateDate | Datetime | Date when the MessageContact send was submitted. |
CompleteDate | Datetime | Date when the send completed. |
Status | String | Delivery status of a message to a contact. |
Tracking | String | Tracking information related to the delivery status of a message to a contact. |
GetMessageListStatus¶
Returns status for a message sent to a group of mobile numbers.
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | Message ID provided for the messageList. |
TokenId | String | True | Token ID returned for the messageList. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Message | String | The message text sent in the SMS message. |
Count | Integer | The total of mobile numbers included in the send request subtracting the number of unsubscribed recipients. |
CreateDate | Datetime | Date when the MessageList send was submitted. |
CompleteDate | Datetime | Date when the send completed. |
Status | String | Delivery status of a message to a group of mobile numbers. |
Tracking | String | Tracking information related to the delivery status of a message to a group of mobile numbers. |
GetOAuthAccessToken¶
Gets an authentication token from Salesforce Marketing Cloud.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
Verifier | String | False | The verifier token returned by Salesforce Marketing Cloud after using the URL obtained with GetOAuthAuthorizationUrl. |
Scope | String | False | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
State | String | False | Used by your application to maintain state between the request and the redirect. The authorization server includes this value when redirecting the end-user's browser back to your application. This parameter is recommended because it helps to minimize the risk of cross-site forgery attack. |
CallbackUrl | String | False | The page to return the Salesforce Marketing Cloud app after authentication has been completed. |
GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. The allowed values are CODE, CLIENT. |
AccountId | String | False | Account identifier, or MID, of the target business unit. Use to switch between business units. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | True | Where the end user is directed after login. Must match a redirect URL specified on the API integration in Installed Packages. |
Scope | String | False | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
State | String | False | Used by your application to maintain state between the request and the redirect. The authorization server includes this value when redirecting the end-user's browser back to your application. This parameter is recommended because it helps to minimize the risk of cross-site forgery attack. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
GetRefreshListStatus¶
Retrieves the refresh list status.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ListId | String | True | The ID of the list found in the MobileConnect interface |
TokenId | String | True | The unique ID returned when using the RefreshList operation |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The status of the refresh list. |
GetSubscriptionStatus¶
Returns subscription status for mobile numbers or subscriber keys.
EXECUTE GetSubscriptionStatus MobileNumbers='["15555555555"]'
EXECUTE GetSubscriptionStatus SubscriberKeys='["ExampleSubKey1"]'
Input¶
Name | Type | Required | Description |
---|---|---|---|
MobileNumbers | String | False | An array of mobile numbers. |
SubscriberKeys | String | False | An array of subscriber keys. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Contacts | String | Information about the subscription status for mobile numbers or subscriber keys. |
GetTrackingHistoryOfQueuedMO¶
Retrieves the tracking history of a queued MO.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TokenId | String | True | Token ID returned for the queued MO. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Status | String | The status of the refresh list. |
History | String | History information related to the queued MO. |
ImportAndSendMessage¶
Imports and sends.
EXECUTE ImportAndSendMessage MessageId='MessageId'," +
"Keyword='Test_Keyword'," +
"NotificationEmail='myEmail@example.com'," +
"IsDuplicationAllowed=true," +
"IsDuplicationAllowed=true," +
"ImportDefinition='[{" +
" \"FileName\": \"MyTestList.csv\"," +
" \"ImportType\": \"FILE\"," +
" \"ImportMappingType\": \"ManualMap\"," +
" \"FieldMaps\": [{" +
" \"Destination\": \"_FirstName\"," +
" \"Source\": \"First Name\"" +
" }, {" +
" \"Destination\": \"_Subscriberkey\"," +
" \"Source\": \"Subscriber Key\"" +
" }, {" +
" \"Destination\": \"_LastName\"," +
" \"Source\": \"Last Name\"" +
" }, {" +
" \"Destination\": \"_MobileNumber\"," +
" \"Source\": \"Mobile\"" +
" }, {" +
" \"Destination\": \"_CountryCode\"," +
" \"Source\": \"Country\"" +
" }]" +
" }]'
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | Encoded message Id. |
Keyword | String | True | A valid keyword on the shortcode for the message to opt the numbers on to. |
NotificationEmail | String | False | If specified, email notifications will be sent on import and program completion. |
Override | Boolean | False | Flag to indicate whether the override text should be used. |
OverrideText | String | False | Text to override the existing message. |
IsDuplicationAllowed | Boolean | False | If true, duplicate messages may be sent. |
IsVisible | Boolean | False | If specified true, the import definition and list created will be visible. |
ImportDefinition | String | True | List of Import Definitions to be created (currently limited to 1). |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TokenId | String | The token Id. |
LastPublishDate | String | The last published date. |
PostMessageToList¶
Initiates a message to one or more contact lists.
EXECUTE PostMessageToList MessageId='NCNSDNsd222as85dj92j2sM', TargetListIds=' [" +
" \"bzZ0cENGam1FZUtNX0poTDRYZzhlQTo2Mzow\"" +
" ]', OverrideTemplateTargetLists=true, OverrideTemplateExclusionLists=false, IgnoreExclusionLists=true, OverrideMessageText=false, " +
"ContentURL='http://image.exct.net/lib/fe6d15707662057c7411/m/1/dj_CC_AUS.jpg'," +
"UtcOffset='-0500', WindowStart='1500', WindowEnd='2200', AllowDuplication=false
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | The encodedID can be found when creating a 'API Entry Event' type Outbound message in the UI. If you have already passed that point you can find the ID by looking at the API resource behind the scenes when you open that message in the UI. |
TargetListIds | String | False | A list of one or more List ID strings. The contacts in these Lists will be included in the send and will overwrite the Message's default inclusion lists. |
OverrideTemplateTargetLists | Boolean | False | A flag indicating TargetListIds will be provided for overriding the message default Target List Ids. |
ExclusionListIds | String | False | A list of one or more List ID strings. The contacts in these Lists will be excluded in the send and will overwrite the Message's default exclusion lists. |
OverrideTemplateExclusionLists | Boolean | False | A flag indicating ExclusionListIds will be provided for overriding the message default Exclusion List Ids. |
IgnoreExclusionLists | Boolean | False | A flag indicating that exclusion lists (even the default message exclusion lists) will not be used in the send. |
OverrideMessageText | Boolean | False | A flag indicating that the text provided should override the text stored with the Message. |
MessageText | String | False | Required when OverrideMessageText is true. |
UtcOffset | String | False | The UTC offset of the blackout window start and end times. UtcOffset is required in every REST call in order for the blackout window to be honored. |
WindowStart | String | False | The start time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
WindowEnd | String | False | The end time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
SendTime | Datetime | False | Date and Time in UTC that the message will go out. Example format: 2012-10-17 17:01. The BlackoutWindow will still be respected if used with this option. If the SendTime is set to a date and time in the past, the message will send immediately. |
AllowDuplication | Boolean | False | The same mobile number may receive multiple texts if this value is true. |
ContentURL | String | False | The URL of the media content sent via an MMS message. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TokenId | String | A token that can be used to make a follow-up call to check the status of the request. |
PostMessageToNumber¶
Initiates a message to one or more mobile numbers.
Subscribers¶
The columns available for the Subscribers temporary table are the following:
Column | Description |
---|---|
MobileNumber | Specifies the mobile number used as the unique identifier for that record. |
SubscriberKey | Specifies the SubscriberKey value used as the unique identifier for that record. |
Attributes | Set real-time attributes for individual personalization strings, per subscriber. The subscriber attribute must match the attribute string in the message. You can pass attributes that are not used as attributes in the message into the SMS send log. |
Execute¶
Use mobile numbers for referecing contact records:
EXECUTE PostMessageToNumber MessageId='NCNSDNsd222as85dj92j2sM', mobileNumbers='[" +
" \"13175551212\"" +
" ]', Subscribe=true, Resubscribe=true, keyword='JOINSMS', Override=true, messageText='Welcome to Code@', ContentURL='http://image.exct.net/lib/abcd/m/1/dj_CC_AUS.jpg', SendTime='2012-10-05 20:01'
Use Subscribers#Temp table as an alternate way for referecing contact records:
Insert INTO Subscribers#Temp(MobileNumber,SubscriberKey,Attributes) Values('15555554410','ExampleSubKey1','{" +
" \"FirstName\":\"Michael\"" +
" }')
Insert INTO Subscribers#Temp(MobileNumber,SubscriberKey,Attributes) Values('15555552254','ExampleSubKey2','{" +
" \"FirstName\":\"Kristen\"" +
" }')
EXECUTE PostMessageToNumber MessageId='NCNSDNsd222as85dj92j2sM', Subscribe=true, Resubscribe=true, Keyword='JOINSMS', Override=false, SendTime='2012-10-05 20:01'
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageId | String | True | The encoded message ID. |
MobileNumbers | String | False | An array of one or more mobile numbers. |
Subscribe | Boolean | False | Flag to indicate a subscription should be created if none exist. |
Resubscribe | Boolean | False | Flag to indicate a subscription should be reset if currently unsubscribed. |
Keyword | String | False | The keyword must align with code on message. Required when subscribe and/or resubscribe are true. |
Override | Boolean | False | Flag to indicate that the contact has received the messageText as provided instead of the message's original text. |
MessageText | String | False | Text value to be used in place of the message's original text. This value is required when override is true. |
UtcOffset | String | False | The UTC offset of the blackout window start and end times. UtcOffset is required in every REST call in order for the blackout window to be honored. |
WindowStart | String | False | The start time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
WindowEnd | String | False | The end time of the blackout window, in the UTC offset specified. To see if the SendTime is within the blackout window, convert the WindowStart and WindowEnd times to UTC and compare them to the SendTime. |
SendTime | Date | False | Date and Time in UTC that the message will go out. Example format: 2012-10-17 17:01. The BlackoutWindow will still be respected if used with this option. If the SendTime is set to a date and time in the past, the message will send immediately. |
ContentURL | String | False | The URL of the media content sent via an MMS message. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TokenId | String | A token that can be used to make a follow-up call to check the status of the request. |
PublishJourney¶
Publishes a journey version asynchronously.
Input¶
Name | Type | Required | Description |
---|---|---|---|
JourneyId | String | True | The ID of the journey to publish expressed in the form of a GUID (UUID). |
JourneyVersion | Integer | True | Version number of the journey to publish. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
StatusId | String | The status ID of a journey publication. |
QueueContactImport¶
Queues a contact import.
FieldMaps¶
The columns available for the FieldMaps temporary table are the following:
Column | Description |
---|---|
Destination | Destination field map. |
Ordinal | Ordinal field map. |
Source | Source field map. |
Execute¶
Insert INTO FieldMaps#Temp(destination,ordinal,source) Values('_MobileNumber',2,'mobile number')
Insert INTO FieldMaps#Temp(destination,ordinal,source) Values('_CountryCode',3,'locale')
Insert INTO FieldMaps#Temp(destination,ordinal,source) Values('_SubscriberKey',1,'subscriber key')
EXECUTE QueueContactImport ListId='UEhwdktFWXpFZUs3Z3hRUW45R2dBQTo2Mzow', ShortCode='90913', Keyword='WELCOME', SendEmailNotification=true, EmailAddress='example@example.com'," +
"ImportMappingType='MapByOrdinal', FileName='testdata.csv', FileType='csv', IsFirstRowHeader=true
Input¶
Name | Type | Required | Description |
---|---|---|---|
ListId | String | True | The list id. |
ShortCode | String | False | The short code. |
Keyword | String | False | The keyword. |
SendEmailNotification | Boolean | False | Send email notification. |
EmailAddress | String | False | Email address the notification goes to. |
ImportMappingType | String | False | Field mapping type. |
FileName | String | False | The name of the file, including extensions. |
FileType | String | False | The only type supported is csv. |
IsFirstRowHeader | Boolean | False | Flag indicating whether or not the first row is the header. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TokenId | String | The token ID of the queued contact import. |
QueueMoMessage¶
Queues an MO message for send.
EXECUTE QueueMoMessage MobileNumbers='[" +
" \"15555551212\"" +
" ]', ShortCode='86288', MessageText='CODETEST'
EXECUTE QueueMoMessage Subscribers='[ " +
" { " +
" \"mobilenumber\": \"15555551212\", " +
" \"subscriberkey\": \"0_MC1652\" " +
" }, " +
" { " +
" \"mobilenumber\": \"15555551213\", " +
" \"subscriberkey\": \"0_MC1652\" " +
" } " +
" ]', ShortCode='86288', MessageText='CODETEST'
Input¶
Name | Type | Required | Description |
---|---|---|---|
MobileNumbers | String | False | An array of mobile numbers used in the send. Either the mobileNumbers or subscribers property is required, but not both. |
Subscribers | String | False | An array of subscriber keys and mobile numbers used in the send. Either the mobileNumbers or subscribers property is required, but not both. |
ShortCode | String | True | The short code. |
MessageText | String | True | The text value. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Results | String | Results related to the queue process of an MO message for send. |
RefreshList¶
Refreshes a list.
Input¶
Name | Type | Required | Description |
---|---|---|---|
ListId | String | True | The ID of the list to refresh. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
TokenId | String | The token ID which can be used to check the status of the request. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Salesforce Marketing Cloud.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. The allowed values are CODE, CLIENT. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Salesforce Marketing Cloud. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
SendMessageToRecipient¶
Send an OTT message to the recipient. Supported OTT networks are Facebook Messenger and LINE.
MessageContents¶
You cannot send an OTT message to the recipient without specifying the content of the message. To create message contents, you must insert data in a temporary table called 'MessageContents#TEMP'. The columns available for this temporary table are the following:
Column | Description |
---|---|
Type | Indicates the message content type of the send request with values: text, image, audio, video, native. |
Text | Message text to be sent out to the recipient. Required for 'text' type message content. |
URL | URL of the multimedia attachment to be sent out to the recipient. Required for 'image, audio, video' type message content. |
AltUrl | Alternate URL of the multimedia attachment to be sent out to the recipient. Required for LINE for 'image, video' type message content. |
Duration | Length of the audio multimedia attachment to be sent out to the recipient. Required for LINE for 'audio' type message content. |
NativePayload | Ott-network-specific blob of JSON payload passed in message request. |
IsReusable | Indicates if a multimedia attachment can be reused for future messages. Only supported for Messenger. |
AttachmentId | Attachment ID of a reusable multimedia asset. Only supported for Messenger. |
MessageCustomKeys¶
You can also specify message custom keys to pass-through in the message payload by inserting data in a temporary table called 'MessageCustomKeys#TEMP'. The columns available for this temporary table are the following:
Column | Description |
---|---|
messagingType | Indicates the messaging_type of a messenger send request with values: RESPONSE, UPDATE, MESSAGE_TAG. Required for Messenger send requests. |
tag | Message Tag of a messenger send request. Required for Messenger send request if messagingType = Message_TAG. |
notificationType | Indicates the push notification type for message send request with values: REGULAR, SILENT_PUSH, NO_PUSH. Required for Messenger. Optional for Messenger send requests. |
Execute¶
Messenger message send:
Insert INTO MessageContents#Temp(type,text) Values('text','thanks for purchase')
Insert INTO MessageCustomKeys#Temp(messagingType) Values('RESPONSE')
EXECUTE SendMessageToRecipient MessageKey='e1c35141-6e5c-4bc2-813b-60f969e52b0d', MessageGroupKey='CanBeAGUIDorAny100UnicodeCharString', SenderType='messenger', SenderId='503868699681937', OttId='FBfacdb735074f7c492c0bf190fa99020', UserReference='1938cd4d34cc4db0b109756b8a9b14ff', Subject='Message Name', ValidityPeriod=30"
Different Messenger Content Types:
Insert INTO MessageContents#Temp(type,url,AltUrl,IsReusable,AttachmentId) Values('image','https://example.com/original.jpg','https://example.com/preview.jpg',true,12345)
Insert INTO MessageCustomKeys#Temp(messagingType) Values('RESPONSE')
EXECUTE SendMessageToRecipient MessageKey='e1c35141-6e5c-4bc2-813b-60f969e52b0d', MessageGroupKey='CanBeAGUIDorAny100UnicodeCharString', SenderType='messenger', SenderId='503868699681937', OttId='FBfacdb735074f7c492c0bf190fa99020', UserReference='1938cd4d34cc4db0b109756b8a9b14ff', Subject='Message Name', ValidityPeriod=30"
LINE message send:
Insert INTO MessageContents#Temp(type,text) Values('text','thanks for purchase')
Insert INTO MessageCustomKeys#Temp(messagingType) Values('RESPONSE')
EXECUTE SendMessageToRecipient MessageKey='CanBeAGUIDorAny100UnicodeCharString', MessageGroupKey='CanBeAGUIDorAny100UnicodeCharString', SenderType='line', SenderId='2145435435632435', OttId='U42348yafsd8y3248yfsq8cy9088934d', UserReference='1938cd4d34cc4db0b109756b8a9b14ff', Subject='Message Name', ValidityPeriod=30"
Input¶
Name | Type | Required | Description |
---|---|---|---|
MessageKey | String | True | User-defined message identifier. |
MessageGroupKey | String | False | User-defined message identifier to group a number of send requests. |
SenderType | String | True | Indicates the name of the OTT network the resource is being registered with values: line, messenger. |
SenderId | String | True | Indicates the identifier of the OTT resource sending the message: LINE Channel Id, Messenger Page Id. |
OttId | String | True | Recipient ID of the user. For LINE, if userReference is invalid, a retry is attempted with ottId as senderId. |
UserReference | String | True | Alternate Recipient ID of the user. For Messenger: user_ref can be passed as userReference. For LINE, reply_token can be passed as userReference. |
Subject | String | False | Message name. |
ValidityPeriod | Integer | True | Time period for which the request is valid. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OttRequestId | String | The request ID of the OTT. |
StopJourney¶
Stop a running journey.
Input¶
Name | Type | Required | Description |
---|---|---|---|
JourneyId | String | True | The ID of the journey to stop, expressed in the form of a GUID (UUID). |
JourneyVersion | Integer | True | The version number of the journey to stop. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the journey was stopped. |
SOAP Data Model¶
The connector 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.
Tables¶
The connector models the data in Salesforce Marketing Cloud into a list of tables that can be queried using standard SQL statements.
Generally, querying Salesforce Marketing Cloud tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns. These types of situations are clearly documented at the top of the table page linked below.
Salesforce Marketing Cloud Connector 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. |
Account¶
A Marketing Cloud account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Account
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. |
AccountUser¶
An individual user within an account. This table does not support deletes.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM AccountUser
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', 'test@gmail.com', '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. |
BusinessUnit¶
A unit within a larger Enterprise or Enterprise 2.0 account. This table supports queries and updates only.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BusinessUnit
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. |
ContentArea¶
A ContentArea represents a defined section of reusable content.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ContentArea
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. |
DataExtension¶
Represents a data extension within an account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtension
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. |
Email¶
Represents an email in a Marketing Cloud account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Email
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. |
EmailSendDefinition¶
Record that contains the message information, sender profile, delivery profile, and audience information.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM EmailSendDefinition
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. |
FileTrigger¶
Reserved for future use. This table does not suport deletes.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FileTrigger
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. |
FilterDefinition¶
Defines an audience based on specified rules in a filter. This table does not support inserts.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FilterDefinition
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. |
ImportDefinition¶
Defines a reusable pattern of import options. This table does not support inserts.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportDefinition
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. |
List¶
A marketing list of subscribers.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM List
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. |
Portfolio¶
Indicates a file within the Portfolio of a Marketing Cloud account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Portfolio
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. |
ProgramManifestTemplate¶
Reserved for future use. This table does not support deletes or inserts.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ProgramManifestTemplate
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. |
QueryDefinition¶
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 connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM QueryDefinition
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. |
ReplyMailManagementConfiguration¶
Details configuration settings for the reply mail management in an account. This table does not support deletes.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ReplyMailManagementConfiguration
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', 'buzzlightyear@mymail.com')
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='newemailreply@gmail.com' 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. |
Send¶
Used to send email and retrieve aggregate data. This table does not support deletes or updates.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Send
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. |
SendClassification¶
Represents a send classification in a Marketing Cloud account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendClassification
SELECT * FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SendClassification WHERE ObjectID IN ('nzxcaslkjd-123', 456)
SELECT * FROM SendClassification WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following fields when inserting to this table: Name, DeliveryProfile_ObjectID, and SenderProfile_ObjectID.
INSERT INTO SendClassification(Name, DeliveryProfile_ObjectID, SenderProfile_ObjectID) VALUES('TestName', 'aa1231231', 'vvb1231231')
Delete
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ObjectID [KEY] | String | False | System-controlled, text string identifier for object. |
SendClassificationType | String | False | Defines the type for the applicable send classification. Valid values include Operational and Marketing. |
Name | String | False | Name of the object or property. |
Description | String | False | Describes and provides information regarding the object. |
CustomerKey | String | False | User-supplied unique identifier for an object within an object type. |
SenderProfile_CustomerKey | String | False | The customer key of the sender profile. |
SenderProfile_ObjectID | String | False | System-controlled, text string identifier for object. |
DeliveryProfile_CustomerKey | String | False | The customer key of the delivery profile. |
DeliveryProfile_ObjectID | String | False | System-controlled, text string identifier for object. |
ArchiveEmail | Bool | False | Property definition. |
Client_ID | Long | False | The ID of the client. |
Client_PartnerClientKey | String | False | User-defined partner key for an account. |
PartnerKey | String | False | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | False | Indicats the date and time of the object's creation. |
ModifiedDate | Datetime | False | Indicates the last time object information was modified. |
SenderProfile¶
The send profile used in conjunction with an email send definition.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SenderProfile
SELECT * FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SenderProfile WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM SenderProfile WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following fields when inserting to this table: Name, FromName, and FromAddress.
INSERT INTO SenderProfile(Name, FromName, FromAddress) VALUES('Test', 'Friendly Neighborhood', 'DisneyLand@gmail.com')
Update
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE SenderProfile SET Name = 'changed_name', Description='changed_desc', FromName='changed_from_name', FromAddress='changed@gmail.com' WHERE ObjectID='nzxcaslkjd-123'
Delete
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
Name | String | False | Name of the object or property. |
Description | String | False | Describes and provides information regarding the object. |
FromName | String | False | Specifies the default email message From Name. |
FromAddress | String | False | Indicates From address associated with a object. |
UseDefaultRMMRules | Bool | False | Indicates whether a sender profile uses the default RMM rules for that account. |
AutoForwardToEmailAddress | String | True | Indicates the email address to use with automatically forwarded email messages. |
AutoForwardToName | String | True | Indicates the To name to use on automatically forwarded email messages. |
DirectForward | Bool | False | Indicates whether the direct forward feature has been enabled for a sender profile. |
AutoForwardTriggeredSend_ObjectID | String | False | System-controlled, text string identifier for object. |
AutoReply | Bool | False | Indicates the reply associated with an automatically forwarded email message. |
AutoReplyTriggeredSend_ObjectID | String | False | System-controlled, text string identifier for object. |
SenderHeaderEmailAddress | String | False | Specifies the email address to include in the sender header of a sender profile. |
SenderHeaderName | String | False | Specifies name to include in the sender header of a sender profile. |
DataRetentionPeriodLength | String | False | Specifies the number of time units for which data will be retained. |
ReplyManagementRuleSet_ObjectID | String | False | System-controlled, text string identifier for object. |
RMMRuleCollection_ObjectID | String | False | System-controlled, text string identifier for object. |
Client_ID | Long | False | The ID of the client. |
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. |
ObjectID | String | False | System-controlled, text string identifier for object. |
CustomerKey | String | False | User-supplied unique identifier for an object within an object type. |
Client_CreatedBy | Int | False | Returns user ID for user who created object |
Client_ModifiedBy | Int | False | Returns user ID for user who modified object. |
SMSTriggeredSend¶
Indicates a single instance of an SMS triggered send. This table does not support deletes or updates.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSTriggeredSend
SELECT * FROM SMSTriggeredSend WHERE ObjectID = 123
SELECT * FROM SMSTriggeredSend WHERE ObjectID IN (123, 456)
SELECT * FROM SMSTriggeredSend WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following field when inserting to this table: SMSTriggeredSendDefinition_ObjectID.
INSERT INTO SMSTriggeredSend(SMSTriggeredSendDefinition_ObjectID) VALUES(123)
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
ObjectID [KEY] | String | False | System-controlled, text string identifier for object. |
CreatedDate | Datetime | False | Indicates the date and time of the object's creation. |
Client_ID | Int | False | The ID of the client. |
SmsSendId | String | False | Indicates ID for a specific SMS send. |
SMSTriggeredSendDefinition_ObjectID | String | False | System-controlled, text string identifier for object. |
Subscriber¶
A person subscribed to receive email or SMS communication.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Subscriber
SELECT * FROM Subscriber WHERE Id = 123
SELECT * FROM Subscriber WHERE Id IN (123, 456)
SELECT * FROM Subscriber WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following fields when inserting to this table: SubscriberKey and EmailAddress.
INSERT INTO Subscriber(SubscriberKey, EmailAddress) VALUES(123, 'test@gmail.com')
Update
You must specify the ID in the WHERE clause when executing an update against this table.
UPDATE Subscriber SET EmailAddress='changed@gmail.com' WHERE Id=123
Delete
You must specify the ID in the WHERE clause when executing a delete against this table.
DELETE FROM Subscriber 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. |
Client_ID | Int | False | The ID of the client. |
Client_PartnerClientKey | String | False | User-defined partner key for an account. |
EmailAddress | String | False | Contains the email address for a subscriber. |
SubscriberKey | String | False | Identification of a specific subscriber. |
UnsubscribedDate | Datetime | False | Represents date subscriber unsubscribed from a list. |
Status | String | False | Defines status of object. |
EmailTypePreference | String | False | The format in which email should be sent. |
SuppressionListDefinition¶
A suppression list that can be associated with different contexts.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SuppressionListDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM SuppressionListDefinition WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following fields when inserting to this table: Name.
INSERT INTO SuppressionListDefinition(Name) VALUES('Test')
Update
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE SuppressionListDefinition 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 SuppressionListDefinition WHERE ObjectID='nzxcaslkjd-123'
Columns¶
Name | Type | ReadOnly | Description |
---|---|---|---|
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. |
Description | String | False | Describes and provides information regarding the object. |
Client_CreatedBy | Int | False | Returns user ID for user who created object |
CreatedDate | Datetime | False | Indicates the date and time of the object's creation. |
Client_ModifiedBy | Int | False | Returns user ID for user who modified object. |
ModifiedDate | Datetime | False | Indicates the last time object information was modified. |
Category | Long | False | ID of the folder that an item is located in. |
Client_ID | Int | False | The ID of the client. |
Client_EnterpriseID | Long | False | The EnterpriseID of the client. |
SubscriberCount | Long | False | Indicates the number of records on a suppression list. |
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.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TriggeredSendDefinition
SELECT * FROM TriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM TriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM TriggeredSendDefinition WHERE CreatedDate > '2017/01/25'
Insert
You must specify the following fields when inserting to this table: Name, SendClassification_ObjectID, and Email_Id.
INSERT INTO TriggeredSendDefinition(Name, SendClassification_ObjectID, Email_Id) VALUES('Test', 'nzxcaslkjd-789', 123)
Update
You must specify the ObjectID in the WHERE clause when executing an update against this table.
UPDATE TriggeredSendDefinition SET Description='Changed' WHERE ObjectID='nzxcaslkjd-123'
Delete
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
When deleting a row from this table, the row will not be deleted, but instead the value of TriggeredSendStatus will be set to false.
DELETE FROM TriggeredSendDefinition 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. |
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 | Long | False | The ID of the client. |
CustomerKey | String | False | User-supplied unique identifier for an object within an object type. |
Email_ID | Int | False | Identifier for an object. |
List_ID | Int | False | Identifier for an object. |
Name | String | False | Name of the object or property. |
Description | String | False | Describes and provides information regarding the object. |
TriggeredSendType | String | False | Deprecated. |
TriggeredSendStatus | String | False | Represents status of triggered send. |
HeaderContentArea_ID | Int | False | Identifier for an object. |
FooterContentArea_ID | Int | False | Identifier for an object. |
SendClassification_ObjectID | String | False | System-controlled, text string identifier for object. |
SendClassification_CustomerKey | String | False | The customer key of the send classification. |
SenderProfile_CustomerKey | String | False | The customer key of the sender profile. |
SenderProfile_ObjectID | String | False | System-controlled, text string identifier for object. |
DeliveryProfile_CustomerKey | String | False | The customer key of the delivery profile. |
DeliveryProfile_ObjectID | String | False | System-controlled, text string identifier for object. |
PrivateDomain_ObjectID | String | False | System-controlled, text string identifier for object. |
PrivateIP_ID | Int | True | Read-only identifier for an object. |
AutoAddSubscribers | Bool | False | Indicates whether a triggered send recipient should be added to a subscriber list. |
AutoUpdateSubscribers | Bool | False | Indicates if any subscriber information should be updated as part of a triggered send. |
BatchInterval | Int | False | Deprecated. |
FromName | String | False | Specifies the default email message From Name. |
FromAddress | String | False | Indicates From address associated with a object. |
BccEmail | String | False | Indicates email addresses to receive blind carbon copy of a message. |
EmailSubject | String | False | Subject for an email send. |
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. |
TestEmailAddr | String | False | Specified a test email address. |
AllowedSlots | String | False | Reserved for future use. |
NewSlotTrigger | Int | False | Deprecated. |
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. |
SuppressTracking | Bool | False | Indicates whether the send definition suppresses tracking results for associated sends. |
Keyword | String | False | Reserved for future use. |
List_PartnerKey | String | False | Unique identifier provided by partner for an object, accessible only via API. |
Email_PartnerKey | String | False | Unique identifier provided by partner for an object, accessible only via API. |
SendClassification_PartnerKey | String | False | Unique identifier provided by partner for an object, accessible only via API. |
PrivateDomain_PartnerKey | String | True | Unique identifier provided by partner for an object, accessible only via API. |
PrivateIP_PartnerKey | String | True | Unique identifier provided by partner for an object, accessible only via API. |
Client_PartnerClientKey | String | False | User-defined partner key for an account. |
IsPlatformObject | Bool | False | Indicated whether the object is a platform object. |
CategoryID | Int | False | Specifies the identifier of the folder containing the email. |
Views¶
Views are composed of columns and pseudo columns. Views are similar to tables in the way that data is represented; however, views do not support updates. Entities that are represented as views are typically read-only entities. Often, a stored procedure is available to update the data if such functionality is applicable to the data source.
Queries can be executed against a view as if it were a normal table, and the data that comes back is similar in that regard. To find out more about tables and stored procedures, please navigate to their corresponding entries in this help document.
Salesforce Marketing Cloud Connector Views¶
Name | Description |
---|---|
Automation | Defines an automation that exists within Automation Studio for an account. |
BounceEvent | Contains SMTP and other information pertaining to the specific event of an email message bounce. |
ClickEvent | Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message. |
DataExtensionField | Represents a field within a data extension. |
DataExtensionTemplate | Represents a data extension template within an account. |
DataFolder | Represents a folder in a Marketing Cloud account |
DoubleOptInMOKeyword | The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow. |
FileTriggerTypeLastPull | Reserved for future use. |
ForwardedEmailEvent | Indicates a subscriber used the Forward To A Friend feature to send an email to another person. |
ForwardedEmailOptInEvent | Specifies an opt-in event related to a Forward To A Friend event. |
HelpMOKeyword | Defines actions associated with the HELP SMS keyword for an account. |
ImportResultsSummary | A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition. |
LinkSend | Provides information about a link in a send. |
ListSend | Specifies retrieve-only properties associated with the list(s) for a completed send. |
ListSubscriber | Retrieves subscribers for a list or lists for a subscriber. |
MessagingVendorKind | Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated. |
NotSentEvent | Contains information on when email message failed to be sent. |
OpenEvent | Contains information about the opening of a message send by a subscriber. |
PrivateIP | The PrivateIP object contains information on private IP address to be used as part of messages sends. |
Publication | Reserved for future use. |
PublicationSubscriber | Describes subscriber on a publication list. |
PublicKeyManagement | Reserved for future use. |
ResultItem | Contains results of asynchronous API call. |
ResultMessage | Message containing results of async call. |
Role | Defines roles and permissions assigned to a user in an account. |
SendEmailMOKeyword | Defines the action that sends a triggered email message to the email addresses defined in an MO message. |
SendSMSMOKeyword | Defines actions to take when the specified MO keyword is received. |
SendSummary | A retrieve only object that contains summary information about a specific send event. |
SentEvent | Contains tracking data related to a send, including information on individual subscribers. |
SMSMTEvent | Contains information on a specific SMS message sent to a subscriber. |
SMSSharedKeyword | Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account. |
SMSTriggeredSendDefinition | Defines the send definition for an SMS message. |
SubscriberList | Use to retrieve lists for a specific subscriber. |
SubscriberSendResult | Reserved for future use. |
SuppressionListContext | Defines a context that a SuppressionListDefinition can be associated with. |
SurveyEvent | Contains information on when a survey response took place. |
Template | Represents an email template in a Marketing Cloud account. |
TimeZone | Represents a specific time zone in the application. |
TriggeredSendSummary | Summary of results for a specific triggered send. |
UnsubEvent | Contains information regarding a specific unsubscription action taken by a subscriber. |
UnsubscribeFromSMSPublicationMOKeyword | Defines keyword used by a subscriber to unsubscribe from an SMS publication list. |
Automation¶
Defines an automation that exists within Automation Studio for an account.
View-Specific Information¶
Select
The connector uses the Salesforce Marketing Cloud APIs to process the following WHERE clause operators for all but DateTime values: =, !=, <>, >, >=, <, <=, IN. For DateTime values, only > and < are supported. The connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Automation
SELECT * FROM Automation WHERE ObjectID = 123
SELECT * FROM Automation WHERE ObjectID IN (123, 456)
SELECT * FROM Automation WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
Schedule_ID | Int | Read-only identifier for the schedule. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_ID | Long | The ID of the client. |
IsActive | Bool | Specifies whether or not the object is active. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_CreatedBy | Int | Returns user ID for user who created object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ModifiedBy | Int | Returns user ID for user who modified object.. |
Status | Int | Indicates status of automation. |
Client_EnterpriseID | Long | Reserved for future use. |
BounceEvent¶
Contains SMTP and other information pertaining to the specific event of an email message bounce.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BounceEvent
SELECT * FROM BounceEvent WHERE Id = 123
SELECT * FROM BounceEvent WHERE Id IN (123, 456)
SELECT * FROM BounceEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API.. |
CreatedDate | Datetime | Read-only date and time of the object's creation.. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | Specifies ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
SMTPCode | String | Contains SMTP code related to a bounced email. |
BounceCategory | String | Defines category for bounce associated with a bounced email. |
SMTPReason | String | Contains SMTP reason associated with a bounced email. |
BounceType | String | Defines type of bounce associated with a bounced email. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
ClickEvent¶
Contains time and date information, as well as a URL ID and a URL, regarding a click on a link contained in a message.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ClickEvent
SELECT * FROM ClickEvent WHERE Id = 123
SELECT * FROM ClickEvent WHERE Id IN (123, 456)
SELECT * FROM ClickEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
URLID | Int | Indicates URL ID associated with a click tracking event. |
URL | String | Indicates URL included in an event or configuration. |
DataExtensionField¶
Represents a field within a data extension.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionField
SELECT * FROM DataExtensionField WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | User-supplied unique identifier for an object within an object type, which corresponds to the external key assigned to an object in the user interface. |
Name | String | Name of the object or property. |
DefaultValue | String | The default value for a data extension field if no value is supplied. |
MaxLength | Int | Maximum length of the data. |
IsRequired | Bool | Indicates whether the property must have a value specified. |
Ordinal | Int | Indicates position of object within an array |
IsPrimaryKey | Bool | Designates whether a data extension field is used as a primary key for that data extension. |
FieldType | String | Designates data type for a data extension field. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Scale | Int | Indicates numeric precision for decimal properties. |
Client_ID | Int | The ID of the client. |
DataExtension_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
StorageType | String | Indicates special storage properties for the field. Valid values are: Unspecified, Plain, Encrypted, or Obfuscated. |
DataExtensionTemplate¶
Represents a data extension template within an account.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionTemplate
SELECT * FROM DataExtensionTemplate WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Name | String | Name of the object or property. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
Description | String | Describes and provides information regarding the object. |
IsSendable | Bool | Specifies whether the template is sendable. |
IsTestable | Bool | Specifies whether the template is testable. |
SendableCustomObjectField | String | Specifies a sendable custom object field. |
SendableSubscriberField | String | Specifies a sendable subscriber field. |
DataRetentionPeriodLength | String | Specifies until when should the data be retained. |
DataRetentionPeriodUnitOfMeasure | Int | Specifies the unit of measure for the data rentention period. |
RowBasedRetention | Bool | Specifies whether row based retention is enabled. |
ResetRetentionPeriodOnImport | Bool | Specifies whether retention period should be reset on import. |
DeleteAtEndOfRetentionPeriod | Bool | Specifies whether the data should be deleted at the end of the retention period. |
RetainUntil | Datetime | Specified until when the data should be retained. |
DataFolder¶
Represents a folder in a Marketing Cloud account
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataFolder
SELECT * FROM DataFolder WHERE Id = 123
SELECT * FROM DataFolder WHERE Id IN (123, 456)
SELECT * FROM DataFolder WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Int | The ID of the client. |
ParentFolder_ID | Int | Specifies the parent folder If for a data folder. |
ParentFolder_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
ParentFolder_ObjectID | String | System-controlled, read-only text string identifier for object. |
ParentFolder_Name | String | Name of the object or property. |
ParentFolder_Description | String | Describes and provides information regarding the object. |
ParentFolder_ContentType | String | Defines the type of content contained within a folder. |
ParentFolder_IsActive | Bool | Specifies whether or not the object is active. |
ParentFolder_IsEditable | Bool | Indicates if the property can be edited by the end-user in the profile center. |
ParentFolder_AllowChildren | Bool | Specifies whether a data folder can have child data folders. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
ContentType | String | Defines the type of content contained within a folder. |
IsActive | Bool | Specifies whether or not the object is active. |
IsEditable | Bool | Indicates if the property can be edited by the end-user in the profile center. |
AllowChildren | Bool | Specifies whether a data folder can have child data folders. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_EnterpriseID | Long | Reserved for future use. |
Client_CreatedBy | Int | Returns user ID for user who created object |
DoubleOptInMOKeyword¶
The DoubleOptInMOKeyword object defines an MO keyword, allowing a mobile user to subscribe to SMS messages using a double opt-in workflow.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DoubleOptInMOKeyword
SELECT * FROM DoubleOptInMOKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
DefaultPublication_ID | Int | Read-only identifier for an object. |
InvalidPublicationMessage | String | Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list. |
InvalidResponseMessage | String | Specifies message to send in case a subscriber sends in an invalid response. |
MissingPublicationMessage | String | Reserved for future use. |
NeedPublicationMessage | String | Specifies message to send in case a subscriber sends in an response that does not specify a publication list. |
PromptMessage | String | Contains message sent to subscriber to prompt response as part of the double opt-in process. |
SuccessMessage | String | Defines SMS message to send if triggered email send succeeds. |
UnexpectedErrorMessage | String | Contains message to send to subscriber in case of unexpected error. |
ValidPublications | String | Defines valid publication lists for use with a double opt-in event. |
ValidResponses | String | Defines valid responses a subscriber can use as part of a double opt-in process. |
FileTriggerTypeLastPull¶
Reserved for future use.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FileTriggerTypeLastPull
SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Long | The ID of the client. |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
ExternalReference | String | Reserved for future use. |
Type | String | Indicates type of specific list. |
LastPullDate | Datetime | Reserved for future use. |
ForwardedEmailEvent¶
Indicates a subscriber used the Forward To A Friend feature to send an email to another person.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailEvent
SELECT * FROM ForwardedEmailEvent WHERE Id = 123
SELECT * FROM ForwardedEmailEvent WHERE Id IN (123, 456)
SELECT * FROM ForwardedEmailEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
ForwardedEmailOptInEvent¶
Specifies an opt-in event related to a Forward To A Friend event.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailOptInEvent
SELECT * FROM ForwardedEmailOptInEvent WHERE Id = 123
SELECT * FROM ForwardedEmailOptInEvent WHERE Id IN (123, 456)
SELECT * FROM ForwardedEmailOptInEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
OptInSubscriberKey | String | Specifies the subscriber key of a subscriber opted in via forwarded email. |
HelpMOKeyword¶
Defines actions associated with the HELP SMS keyword for an account.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM HelpMOKeyword
SELECT * FROM HelpMOKeyword WHERE Client_ID = 123
SELECT * FROM HelpMOKeyword WHERE Client_ID IN (123, 456)
SELECT * FROM HelpMOKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
MoreChoicesPrompt | String | Text used to inform MO message sender of more available choices as part of a HELP keyword action. |
DefaultHelpMessage | String | Contains default message to deliver for a HELP MO message. |
MenuText | String | Defines text to use for outlining multiple response options in the response to a HELP MO request. |
FriendlyName | String | Contains the friendly name for a HELP MO keyword. |
ImportResultsSummary¶
A retrieve-only object that contains status and aggregate information on an individual import started from an ImportDefinition.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportResultsSummary
SELECT * FROM ImportResultsSummary WHERE Id = 123
SELECT * FROM ImportResultsSummary WHERE Id IN (123, 456)
SELECT * FROM ImportResultsSummary WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
ID | Int | Read-only identifier for an object. |
Client_ID | Long | The ID of the client. |
ImportDefinitionCustomerKey | String | Specifies customer key associated with import definition used in an import. |
TaskResultID | Int | Indicates the task result ID associated with a summary of import results. |
ImportStatus | String | Specifies import status associated with an import. |
StartDate | String | Indicates the start date for the time period for which to retrieve import results. |
EndDate | String | Specifies the end data of an activity. |
DestinationID | String | Specifies the identifier of either the list or the data extension associated with a completed import. |
NumberSuccessful | Int | Specifies number of successful record imports resulting from an import action. |
NumberDuplicated | Int | Specifies number of duplicated records resulting from an import. |
NumberErrors | Int | Indicates number of errors resulting from an import. |
TotalRows | Int | Indicates the total number of rows included in the summary of an import. |
ImportType | String | Specfies type of import performed. |
LinkSend¶
Provides information about a link in a send.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM LinkSend
SELECT * FROM LinkSend WHERE Id = 123
SELECT * FROM LinkSend WHERE Id IN (123, 456)
SELECT * FROM LinkSend WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
SendID | Int | Contains identifier for a specific send. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The ID of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Link_ID | Int | The ID of the link. |
Link_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Link_TotalClicks | Int | Indicates total number of clicks on link in message. |
Link_UniqueClicks | Int | Indicates number of unique clicks on message. |
Link_URL | String | Indicates URL included in an event or configuration. |
Link_Alias | String | Name of link contained in message. |
ListSend¶
Specifies retrieve-only properties associated with the list(s) for a completed send.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSend
SELECT * FROM ListSend WHERE Id = 123
SELECT * FROM ListSend WHERE Id IN (123, 456)
SELECT * FROM ListSend WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
List_ID | Int | Read-only identifier for an object. |
List_ListName | String | The name of the list. |
Duplicates | Int | Represent the number of duplicate email addresses associated with a send (exists only when a send occurs to multiple lists). |
InvalidAddresses | Int | Specifies the number of invalid addresses associated with a send. |
ExistingUndeliverables | Int | Indicates whether bounces occurred on previous send. |
ExistingUnsubscribes | Int | Indicates whether unsubscriptions occurred on previous send. |
HardBounces | Int | Indicates number of hard bounces associated with a send. |
SoftBounces | Int | Indicates number of soft bounces associated with a specific send. |
OtherBounces | Int | Specifies number of Other-type bounces in a send. |
ForwardedEmails | Int | Number of emails forwarded for a send. |
UniqueClicks | Int | Indicates number of unique clicks on message. |
UniqueOpens | Int | Indicates number of unique opens resulting from a triggered send. |
NumberSent | Int | Number of emails actually sent as part of an email send. This number reflects all of the sent messages and may include bounced messages. |
NumberDelivered | Int | Number of sent emails that did not bounce. |
Unsubscribes | Int | Indicates the number of unsubscribe events associated with a send. |
MissingAddresses | Int | Specifies number of missing addresses encountered within a send. |
PreviewURL | String | Indicates URL used to preview the message associated with a send. |
ListSubscriber¶
Retrieves subscribers for a list or lists for a subscriber.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSubscriber
SELECT * FROM ListSubscriber WHERE Id = 123
SELECT * FROM ListSubscriber WHERE Id IN (123, 456)
SELECT * FROM ListSubscriber WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
SubscriberKey | String | Identification of a specific subscriber. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
ListID | Int | Defines identification for a list the subscriber resides on. |
Status | String | Defines status of an object. |
UnsubscribedDate | Datetime | The date the subscriber unsubscribed. |
MessagingVendorKind¶
Contains the vendor details for an SMS (short message service) or voice messaging vendor. Deprecated.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM MessagingVendorKind
SELECT * FROM MessagingVendorKind WHERE Id = 123
SELECT * FROM MessagingVendorKind WHERE Id IN (123, 456)
SELECT * FROM MessagingVendorKind WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Identifier for an object. |
Vendor | String | Deprecated. |
Kind | String | Deprecated. |
IsUsernameRequired | Bool | Deprecated. |
IsPasswordRequired | Bool | Deprecated. |
IsProfileRequired | Bool | Deprecated. |
CreatedDate | Datetime | Indicates the date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
NotSentEvent¶
Contains information on when email message failed to be sent.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM NotSentEvent
SELECT * FROM NotSentEvent WHERE SendID = 123
SELECT * FROM NotSentEvent WHERE SendID IN (123, 456)
SELECT * FROM NotSentEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Int | The ID of the client. |
EventType | String | The type of tracking event |
BatchID | Int | Ties triggered send sent events to other events. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
ListID | Int | Defines identification for a list the subscriber resides on. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
SubscriberID | Int | The ID of the subscriber. |
OpenEvent¶
Contains information about the opening of a message send by a subscriber.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM OpenEvent
SELECT * FROM OpenEvent WHERE Id = 123
SELECT * FROM OpenEvent WHERE Id IN (123, 456)
SELECT * FROM OpenEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
PrivateIP¶
The PrivateIP object contains information on private IP address to be used as part of messages sends.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PrivateIP
SELECT * FROM PrivateIP WHERE Id = 123
SELECT * FROM PrivateIP WHERE Id IN (123, 456)
SELECT * FROM PrivateIP WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ID | Int | The ID of the client. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
IsActive | Bool | Specifies whether or not the object is active. |
OrdinalID | String | Defines position of object within an array of information. |
IPAddress | String | Contains IP address to be used in for a private IP. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Publication¶
Reserved for future use.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Publication
SELECT * FROM Publication WHERE Id = 123
SELECT * FROM Publication WHERE Id IN (123, 456)
SELECT * FROM Publication WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Name | String | Name of the object or property. |
Category | Int | ID of the folder that an item is located in. |
PublicationSubscriber¶
Describes subscriber on a publication list.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PublicationSubscriber
SELECT * FROM PublicationSubscriber WHERE Publication_ID = 123
SELECT * FROM PublicationSubscriber WHERE Publication_ID IN (123, 456)
SELECT * FROM PublicationSubscriber WHERE Publication_CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Publication_ID | Int | Read-only identifier for an object. |
Publication_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Publication_CreatedDate | Datetime | Read-only date and time of the object's creation. |
Publication_ModifiedDate | Datetime | Indicates the last time object information was modified. |
Publication_Client_ID | Int | Read-only identifier for an object. |
Publication_Client_PartnerClientKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The ID of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Publication_Name | String | Name of the object or property. |
Publication_Category | Int | The category of the publication. |
Subscriber_ID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PrimarySMSAddress_AddressType | String | The address type of the subscriber. |
Subscriber_PrimarySMSAddress_Address | String | The address of the subscriber. |
Subscriber_PrimarySMSAddress_Carrier | String | The carrier of the subscriber. |
Subscriber_PrimarySMSPublicationStatus | String | The primary SMS publication status of the subscriber. |
PublicKeyManagement¶
Reserved for future use.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PublicKeyManagement
SELECT * FROM PublicKeyManagement WHERE Id = 123
SELECT * FROM PublicKeyManagement WHERE Id IN (123, 456)
SELECT * FROM PublicKeyManagement WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Long | The ID of the client. |
Name | String | Name of the object or property. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Key | String | Specifies key associated with content area in HTML body. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
ResultItem¶
Contains results of asynchronous API call.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultItem
SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID = 123
SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID IN (123, 456)
SELECT * FROM ResultItem WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
AsyncAPIRequestQueueID | Int | The ID of the async API request queue. |
RequestID | String | Unique ID of initial async API call. |
ConversationID | String | Unique ID of initial async API call. All requests that should be processed as a single unit will have the same ConversationID. |
CorrelationID | String | Identifies correlation of objects across several requests. |
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
StatusCode | String | Status of async API request. |
StatusMessage | String | Describes the status of an API call. |
OrdinalID | Int | System-controlled, read-only text string identifier for object. |
ErrorCode | Int | Identifies the error of an API request via a numeric code. |
RequestType | String | Defines request as synchronous or asynchronous API. |
RequestObjectType | String | Defines type of the Request object, such as email or triggered send. |
ResultType | Int | Defines result as coming from synchronous or asynchronous API. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
ResultMessage¶
Message containing results of async call.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultMessage
SELECT * FROM ResultMessage WHERE RequestID = 123
SELECT * FROM ResultMessage WHERE RequestID IN (123, 456)
SELECT * FROM ResultMessage WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
RequestID | String | Unique ID of initial async API call. |
ConversationID | String | Unique ID of initial async API call. |
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
OverallStatusCode | String | Represents overall status of conversation via async API. |
StatusCode | String | Status of async API request. |
StatusMessage | String | Describes the status of an API call. |
ErrorCode | Int | Identifies the error of an API request. |
RequestType | String | Defines request as synchronous or asynchronous API. |
ResultType | String | Defines result as coming from synchronous or asynchronous API. |
ResultDetailXML | String | Contains details of operation result in XML format. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
Role¶
Defines roles and permissions assigned to a user in an account.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Account
SELECT * FROM Account WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM Account WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM Account WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
IsPrivate | Bool | Indicates whether role is defined by Marketing Cloud or a client. |
IsSystemDefined | Bool | Indicates whether role is defined by the application. |
Client_EnterpriseID | Long | Reserved for future use. |
Client_ID | Int | The ID of the client. |
Client_CreatedBy | Int | Returns user ID for user who created object |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
PermissionSets | String | Indicates permission sets applied to a Role or PermissionSet object. |
Permissions | String | Specifies an array of permissions. |
SendEmailMOKeyword¶
Defines the action that sends a triggered email message to the email addresses defined in an MO message.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendEmailMOKeyword
SELECT * FROM SendEmailMOKeyword WHERE Client_ID = 123
SELECT * FROM SendEmailMOKeyword WHERE Client_ID IN (123, 456)
SELECT * FROM SendEmailMOKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
NextState_CustomerKey | String | The customer key of the next state. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
SuccessMessage | String | Defines SMS message to send if triggered email send succeeds. |
MissingEmailMessage | String | Defines message to send if MO message does not contain a valid email address. |
FailureMessage | String | Defines message to deliver in case the email send fails. |
TriggeredSend_CustomerKey | String | The customer key of the triggered send definition. |
SendSMSMOKeyword¶
Defines actions to take when the specified MO keyword is received.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSMSMOKeyword
SELECT * FROM SendSMSMOKeyword WHERE Client_ID = 123
SELECT * FROM SendSMSMOKeyword WHERE Client_ID IN (123, 456)
SELECT * FROM SendSMSMOKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
NextMOKeyword_CustomerKey | String | Defines the customer key of the next MO keyword to use in an SMS conversation. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
Message | String | Contains contents of results message. |
ScriptErrorMessage | String | Defines message to deliver to subscriber in case of an error in the SMS conversation. |
SendSummary¶
A retrieve only object that contains summary information about a specific send event.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSummary
SELECT * FROM SendSummary WHERE Client_ID = 123
SELECT * FROM SendSummary WHERE Client_ID IN (123, 456)
SELECT * FROM SendSummary WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
AccountID | Int | Identifier for account. |
SendID | Int | Contains identifier for a specific send. |
DeliveredTime | String | Indicates the time a message was delivered. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
AccountName | String | Name of account. |
AccountEmail | String | Specifies email address attached to account. |
IsTestAccount | Bool | Specifies whether or not an account is a 'Test' account. |
TotalSent | Int | Indicates total number of messages sent as part of a send. |
Transactional | Int | Indicates number of transactional messages included in a send. |
NonTransactional | Int | Specifies number of marketing (non-transactional) messages included as part of a send. |
SentEvent¶
Contains tracking data related to a send, including information on individual subscribers.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SentEvent
SELECT * FROM SentEvent WHERE Id = 123
SELECT * FROM SentEvent WHERE Id IN (123, 456)
SELECT * FROM SentEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Int | The ID of the client. |
EventType | String | The type of tracking event |
BatchID | Int | Ties triggered send sent events to other events. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
ListID | Int | Defines identification for a list the subscriber resides on. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
SubscriberID | Int | The ID of the subscriber. |
SMSMTEvent¶
Contains information on a specific SMS message sent to a subscriber.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSMTEvent
SELECT * FROM SMSMTEvent WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SMSMTEvent WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM SMSMTEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
EventDate | Datetime | Date when a tracking event occurred. |
Client_ID | Long | The ID of the client. |
MOCode | String | Specifies the MO code associated with a specific MO or MT tracking event. |
SMSTriggeredSend_SMSSendId | String | Indicates ID for a specific SMS send. |
SMSTriggeredSend_SMSTriggeredSendDefinition_ObjectID | String | System-controlled, read-only text string identifier for object. |
SMSTriggeredSend_SMSTriggeredSendDefinition_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Subscriber_ID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PrimarySMSAddress_Address | String | The primary SMS address of the subscribers. |
Carrier | String | Name of the SMS carrier associated with an SMS address. |
SMSSharedKeyword¶
Contains information used to request a keyword for use with SMS messages in a Marketing Cloud account.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSSharedKeyword
SELECT * FROM SMSSharedKeyword WHERE Client_ID = 123
SELECT * FROM SMSSharedKeyword WHERE Client_ID IN (123, 456)
SELECT * FROM SMSSharedKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Long | The ID of the client. |
SharedKeyword | String | Specifies keyword requested for use in an account. |
RequestDate | Datetime | Specifies the date when the request for an SMS shared keyword was made. |
EffectiveDate | Datetime | Specifies when an SMS shared keyword becomes active for use. |
ExpireDate | Datetime | Specifies when an SMS shared keyword stops being active for use. |
ReturnToPoolDate | Datetime | Specifies the date when an expired SMS keyword can be requested for different use in a short code. |
ShortCode | String | Specifies the short code for which an SMS keyword was requested. |
SMSTriggeredSendDefinition¶
Defines the send definition for an SMS message.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSTriggeredSendDefinition
SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SMSTriggeredSendDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM SMSTriggeredSendDefinition WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Client_ID | Long | The ID of the client. |
Name | String | Name of the object or property. |
Description | String | Describes and provides information regarding the object. |
Publication_ID | Int | Read-only identifier for an object. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Content_ID | Int | Read-only identifier for an object. |
SendToList | Bool | Indicates whether SMS triggered send goes to a list or a single subscriber. |
DataExtension_ObjectID | String | System-controlled, read-only text string identifier for object. |
IsPlatformObject | Bool | Indicated whether the object is a platform object. |
SubscriberList¶
Use to retrieve lists for a specific subscriber.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberList
SELECT * FROM SubscriberList WHERE Id = 123
SELECT * FROM SubscriberList WHERE Id IN (123, 456)
SELECT * FROM SubscriberList WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ListSubID | Long | Identifier for an object. |
ID [KEY] | Int | Identifier for an object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | date and time of the object's creation. |
Subscriber_UnsubscribedDate | Datetime | The unsubscribed date of the subscriber. |
Client_ID | Int | The ID of the client. |
Status | String | Defines status of object. |
List_ID | Int | Identifier for an object. |
List_ListName | String | The name of the list. |
Subscriber_Status | String | Defines status of object. |
Subscriber_CreatedDate | Datetime | Indicates the date and time of the object's creation. |
Subscriber_ID | Int | identifier for an object. |
Subscriber_EmailAddress | String | The email address of a subscriber. |
Subscriber_SubscriberKey | String | Identification of a specific subscriber. |
Subscriber_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
SubscriberSendResult¶
Reserved for future use.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberSendResult
SELECT * FROM SubscriberSendResult WHERE Id = 123
SELECT * FROM SubscriberSendResult WHERE Id IN (123, 456)
SELECT * FROM SubscriberSendResult WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Send_ID | Int | Read-only identifier for an object. |
ID [KEY] | Int | Read-only identifier for an object. |
Email_ID | Int | Read-only identifier for an object. |
Email_Name | String | Name of the object or property. |
Subject | String | Contains subject area information for a message. |
FromName | String | Specifies the default email message From Name. |
FromAddress | String | Indicates From address associated with a object. |
SentDate | Datetime | Indicates date on which a send took place. |
OpenDate | Datetime | Specifies data on which a subscriber opened a send. |
ClickDate | Datetime | Specifies the data subscriber clicked a link included in a send. |
Subscriber_Partnerkey | String | Unique identifier provided by partner for an object, accessible only via API. |
Subscriber_EmailAddress | String | The email address of the subscriber. |
Subscriber_PartnerType | String | The partner type of the subscriber. |
UnsubscribeDate | Datetime | Indicates the date on which an unsubscribe event took place due to a send. |
LastOpenDate | Int | Specifies the date subscribe was last opened. |
LastClickDate | Int | Specifies the date subscribe was last clicked. |
BounceDate | Datetime | Contains the date on which an individual send bounced for a subscriber. |
EventDate | Int | Indicated the date of the event. |
TotalClicks | Int | Indicates total number of clicks on link in message. |
UniqueClicks | Int | Indicates number of unique clicks on message. |
EmailAddress | Int | Indicates From address associated with a object. |
Subscriber_ID | Int | Read-only identifier for an object. |
SubscriberTypeID | Int | Read-only identifier for an object. |
Subscriber_SubscriberKey | String | The subscriber key of the subscriber. |
Send_PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Client_ID | Int | The ID of the client. |
OtherBounces | Int | Specifies number of Other-type bounces in a send. |
SoftBounces | Int | Indicates number of soft bounces associated with a specific send. |
HardBounces | Int | Indicates number of hard bounces associated with a send. |
SuppressionListContext¶
Defines a context that a SuppressionListDefinition can be associated with.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SuppressionListContext
SELECT * FROM SuppressionListContext WHERE Id = 123
SELECT * FROM SuppressionListContext WHERE Id IN (123, 456)
SELECT * FROM SuppressionListContext WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Definition_ObjectID | String | System-controlled, read-only text string identifier for object. |
Definition_Name | String | Name of the object or property. |
Definition_CustomerKey | String | User-supplied unique identifier for an object within an object type. |
Definition_Category | Long | The category of the defition. |
Definition_Description | String | Describes and provides information regarding the object. |
Context | String | The context with which a SuppressionListDefinition is associated. |
SendClassification_ObjectID | String | System-controlled, read-only text string identifier for object. |
Send_ID | Int | Read-only identifier for an object. |
SenderProfile_ObjectID | String | System-controlled, read-only text string identifier for object. |
SendClassificationType | String | Defines the type for the applicable send classification. Valid values include Operational and Marketing. |
Client_CreatedBy | Int | Returns user ID for user who created object |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
Client_ModifiedBy | Int | Returns user ID for user who modified object. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Long | The ID of the client. |
Client_EnterpriseID | Long | Reserved for future use. |
AppliesToAllSends | Bool | Indicates whether this context applies to all transactional and marketing sends. |
SurveyEvent¶
Contains information on when a survey response took place.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SurveyEvent
SELECT * FROM SurveyEvent WHERE Id = 123
SELECT * FROM SurveyEvent WHERE Id IN (123, 456)
SELECT * FROM SurveyEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event. |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
Question | String | Specifies question associated with a survey event. |
Answer | String | The answer provided by a subscriber to the survey question. |
Template¶
Represents an email template in a Marketing Cloud account.
Table-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Template
SELECT * FROM Template WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM Template WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM Template WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID | String | System-controlled, read-only text string identifier for object. |
ID [KEY] | Int | Read-only identifier for an object. |
Client_ID | Int | The ID of the client. |
TemplateName | String | Name used to identify template within Marketing Cloud application. |
LayoutHTML | String | Contains HTML used to define layout of fields and content within template. |
BackgroundColor | String | Specifies background color used for template. |
BorderColor | String | Specifies border color used in template. |
BorderWidth | Int | Specifies border pixel width used in template. |
Cellpadding | Int | Specifies pixel width of padding within cells used in template. |
Cellspacing | Int | Specifies pixel spacing between cells used in template. |
Width | Int | Specifies the pixel width of the entire template |
Align | String | Indicates the alignment of elements within the template. |
ActiveFlag | Int | Indicates whether the template is available for use within the account. |
CategoryID | Int | Indicates whether content validation has completed for this email message. |
CategoryType | String | Identifies correlation of objects across several requests. |
OwnerID | Int | Specifies MID of business unit that created the template within an Enterprise 2.0 account. |
HeaderContent_ID | Int | The ID of the header content. |
HeaderContent_ObjectID | String | System-controlled, read-only text string identifier for object. |
Layout_ID | Int | The ID of the layout. |
Layout_LayoutName | String | The name of the layout. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
TemplateSubject | String | Contains email subject line specified by the template. |
IsTemplateSubjectLocked | Bool | Indicates whether the subject defined in the header can be changed or not by email using template. |
TimeZone¶
Represents a specific time zone in the application.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TimeZone
Columns¶
Name | Type | Description |
---|---|---|
ID [KEY] | Int | Read-only identifier for an object. |
Name | String | Name of the object or property. |
TriggeredSendSummary¶
Summary of results for a specific triggered send.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TriggeredSendSummary
SELECT * FROM TriggeredSendSummary WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM TriggeredSendSummary WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM TriggeredSendSummary WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ObjectID [KEY] | String | System-controlled, read-only text string identifier for object. |
Client_ID | Long | The ID of the client. |
Client_PartnerClientKey | String | User-defined partner key for an account. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
Sent | Long | Indicates number of messages sent. |
NotSentDueToOptOut | Long | Indicates number of sends not completed due to a subscriber's decision to opt out of receiving messages. |
NotSentDueToUndeliverable | Long | Indicates number of sends not completed due to a subscriber's undeliverable status. |
Bounces | Long | Indicates number of bounces resulting from a triggered send. |
Opens | Long | Indicates number of opens from a triggered send. |
UniqueOpens | Long | Indicates number of opens from a triggered send. |
Clicks | Long | Indicates the number of clicks resulting from a triggered send. |
UniqueClicks | Long | Indicates number of unique clicks on message. |
OptOuts | Long | Indicates number of subscribers who opted out of receiving messages after receiving a triggered send. |
SurveyResponses | Long | Indicates number of responses to a survey question contained in a triggered send. |
FTAFRequests | Long | Indicates number of Forward To A Friend requests received as part of a triggered send. |
FTAFEmailsSent | Long | Indicates Forward To A Friend emails sent as a result of a triggered send. |
FTAFOptIns | Long | Indicates number of subscribers opting in to receiving messages as a result of a Forward To A Friend action from a triggered send. |
Conversions | Long | Indicates the number of conversions results from a triggered send. |
UniqueConversions | Long | Indicates number of unique conversions resulting from a triggered send. |
InProcess | Long | Indicates the number of triggered send messages in progress. Deprecated. |
NotSentDueToError | Long | Indicates number of triggered send messages not sent due to error. |
RowObjectID | String | The row ID of the object. |
TriggeredSendDefinition_ObjectID | String | The ID of the associated triggered send definition for triggered send. |
Queued | Long | Indicates number of messages queued for sending. |
UnsubEvent¶
Contains information regarding a specific unsubscription action taken by a subscriber.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubEvent
SELECT * FROM UnsubEvent WHERE Id = 123
SELECT * FROM UnsubEvent WHERE Id IN (123, 456)
SELECT * FROM UnsubEvent WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
ID | Int | Read-only identifier for an object. |
ObjectID | String | System-controlled, read-only text string identifier for object. |
PartnerKey | String | Unique identifier provided by partner for an object, accessible only via API. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
Client_ID | Int | The ID of the client. |
SendID | Int | Contains identifier for a specific send. |
SubscriberKey | String | Identification of a specific subscriber. |
EventDate | Datetime | Date when a tracking event occurred. |
EventType | String | The type of tracking event |
TriggeredSendDefinitionObjectID | String | Identifies the triggered send definition associated with an event. |
BatchID | Int | Ties triggered send sent events to other events. |
List_ID | Int | Indicates the ID of the list involved in the unsubscription. |
List_Type | String | Indicates type of specific list. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. |
List_ListClassification | String | Specifies the classification for a list. |
IsMasterUnsubscribed | Bool | Indicates whether the subscriber master unsubscribed. |
UnsubscribeFromSMSPublicationMOKeyword¶
Defines keyword used by a subscriber to unsubscribe from an SMS publication list.
View-Specific Information¶
Select
The connector 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 connector processes other filters client-side within the connector. You can turn off the client-side execution of the query by setting SupportEnhancedSQL
to false in which case any search criteria that refer to other columns will cause an error.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID = 123
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID IN (123, 456)
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE CreatedDate > '2017/01/25'
Columns¶
Name | Type | Description |
---|---|---|
Client_ID | Int | The ID of the client. |
CreatedDate | Datetime | Read-only date and time of the object's creation. |
ModifiedDate | Datetime | Indicates the last time object information was modified. |
CustomerKey | String | User-supplied unique identifier for an object within an object type. |
NextMOKeyword_CustomerKey | String | Defines next MO keyword to use in an SMS conversation. |
IsDefaultKeyword | Bool | Specifies if account defaults to this SMS keyword action if no other options are available. |
AllUnsubSuccessMessage | String | Contains message to send to subscriber when they have successfully unsubscribed from all SMS publication lists. |
InvalidPublicationMessage | String | Specifies message to send in case a subscriber requests subscription to or unsubscription from an invalid publication list. |
SingleUnsubSuccessMessage | String | Contains message to send to subscriber when they have successfully unsubscribed from a single publication list. |
Stored Procedures¶
Stored procedures are available to complement the data available from the Data Model. It may be necessary to update data available from a view using a stored procedure because the data does not provide for direct, table-like, two-way updates. In these situations, the retrieval of the data is done using the appropriate view or table, while the update is done by calling a stored procedure. Stored procedures take a list of parameters and return back a dataset that contains the collection of tuples that constitute the response.
Salesforce Marketing Cloud Connector Stored Procedures¶
Name | Description |
---|---|
CreateSchema | Creates a schema file for the specified table or view. |
CreateTriggeredSend | Create a triggered send object which represents a specific instance of a triggered email send. |
GetOAuthAccessToken | Gets an authentication token from Salesforce Marketing Cloud. |
GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. |
RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with Salesforce Marketing Cloud. |
CreateSchema¶
Creates a schema file for the specified table or view.
Input¶
Name | Type | Required | Description |
---|---|---|---|
TableName | String | True | The table or view name. This should match the API name for the object this view/table is related to. Ex: MobileConnectSendSMSActivity |
FileName | String | True | The full file path and name of the schema to generate. Begin by choosing a parent directory (this parent directory should be set in the Location property). Complete the filepath by adding a directory corresponding to the schema used (SOAP), followed by a .rsd file with a name corresponding to the desired table name. For example : 'C:\Users\User\Desktop\SalesforceMarketingCloud\SOAP\MobileConnectSendSMSActivity.rsd' |
Result Set Columns¶
Name | Type | Description |
---|---|---|
Result | String | Returns Success or Failure. |
CreateTriggeredSend¶
Create a triggered send object which represents a specific instance of a triggered email send.
Table Specific Information¶
Subscribers
You cannot create a trigger send without specifying the subscribers. To create subscribers, you must insert data in a temporary table called 'Subscribers#TEMP'.
Example: Create two subscribers
INSERT INTO Subscribers#Temp(SubscriberKey,EmailAddress) VALUES ('a4367b39-d7d6-4612-a020-0952aa9e83dd','test@gmail.com.com')
INSERT INTO Subscribers#Temp(SubscriberKey,EmailAddress) VALUES ('21621cc5-d12e-46d0-bf09-a429da29ef1a','testtest@gmail.com.com')
Attributes
To create attributes, you must insert data in a temporary table called 'Attributes#TEMP'.
Example: Create two attributes
INSERT INTO Attributes#Temp(Name,Value) VALUES ('orderstatus','received')
INSERT INTO Attributes#Temp(Name,Value) VALUES ('orderdate','2015-06-30 11:10:36.956')
Execute
After creating at least one subscriber item, you can execute the stored procedure.
EXECUTE CreateTriggeredSend Owner_ClientId='7307527', Owner_FromName='From_Name', Owner_FromAddress='test@gmail.com.com', TriggeredSendDefinitionCustomerKey='27775'
Input
Name | Type | Required | Description |
---|---|---|---|
TriggeredSendDefinitionCustomerKey | String | True | Defines associated triggered send definition for triggered send. This property corresponds to the external key assigned to an object in Marketing Cloud. |
Owner_ClientId | String | False | Specifies the account ownership and context of an object. |
Owner_FromAddress | String | False | Indicates From address associated with a object. |
Owner_FromName | String | False | Specifies the default email message From Name. |
Result Set Columns
Name | Type | Description |
---|---|---|
Success | Boolean | Whether the triggered send object was created successfully or not. |
GetOAuthAccessToken¶
Gets an authentication token from Salesforce Marketing Cloud.
Input¶
Name | Type | Required | Description |
---|---|---|---|
AuthMode | String | False | The type of authentication mode to use. Select App for getting authentication tokens via a desktop app. Select Web for getting authentication tokens via a Web app. The allowed values are APP, WEB. The default value is APP. |
Verifier | String | False | The verifier token returned by Salesforce Marketing Cloud after using the URL obtained with GetOAuthAuthorizationUrl. |
Scope | String | False | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
State | String | False | Used by your application to maintain state between the request and the redirect. The authorization server includes this value when redirecting the end-user's browser back to your application. This parameter is recommended because it helps to minimize the risk of cross-site forgery attack. |
CallbackUrl | String | False | The page to return the Salesforce Marketing Cloud app after authentication has been completed. |
GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. The allowed values are CODE, CLIENT. |
AccountId | String | False | Account identifier, or MID, of the target business unit. Use to switch between business units. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The OAuth token. |
OAuthRefreshToken | String | The OAuth refresh token. |
ExpiresIn | String | The remaining lifetime for the access token in seconds. |
GetOAuthAuthorizationURL¶
Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps.
Input¶
Name | Type | Required | Description |
---|---|---|---|
CallbackUrl | String | True | Where the end user is directed after login. Must match a redirect URL specified on the API integration in Installed Packages. |
Scope | String | False | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
State | String | False | Used by your application to maintain state between the request and the redirect. The authorization server includes this value when redirecting the end-user's browser back to your application. This parameter is recommended because it helps to minimize the risk of cross-site forgery attack. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
URL | String | The authorization URL, entered into a Web browser to obtain the verifier token and authorize your app. |
RefreshOAuthAccessToken¶
Refreshes the OAuth access token used for authentication with Salesforce Marketing Cloud.
Input¶
Name | Type | Required | Description |
---|---|---|---|
OAuthRefreshToken | String | True | Set this to the token value that expired. |
GrantType | String | False | Authorization grant type. Only available for OAuth 2.0. The allowed values are CODE, CLIENT. |
Result Set Columns¶
Name | Type | Description |
---|---|---|
OAuthAccessToken | String | The authentication token returned from Salesforce Marketing Cloud. This can be used in subsequent calls to other operations for this particular service. |
OAuthRefreshToken | String | This is the same as the access token. |
ExpiresIn | String | The remaining lifetime on the access token. |
System Tables¶
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
Schema Tables¶
The following tables return database metadata for Salesforce Marketing Cloud:
- sys_catalogs: Lists the available databases.
- sys_schemas: Lists the available schemas.
- sys_tables: Lists the available tables and views.
- sys_tablecolumns: Describes the columns of the available tables and views.
- sys_procedures: Describes the available stored procedures.
- sys_procedureparameters: Describes stored procedure parameters.
- sys_keycolumns: Describes the primary and foreign keys.
- sys_indexes: Describes the available indexes.
Data Source Tables¶
The following tables return information about how to connect to and query the data source:
- sys_connection_props: Returns information on the available connection properties.
- sys_sqlinfo: Describes the SELECT queries that the connector can offload to the data source.
Query Information Tables¶
The following table returns query statistics for data modification queries, including batch operations:
- sys_identity: Returns information about batch operations or single updates.
sys_catalogs¶
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
sys_schemas¶
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database name. |
SchemaName | String | The schema name. |
sys_tables¶
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view. |
TableType | String | The table type (table or view). |
Description | String | A description of the table or view. |
IsUpdateable | Boolean | Whether the table can be updated. |
sys_tablecolumns¶
Describes the columns of the available tables and views.
The following query returns the columns and data types for the Subscriber table:
SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Subscriber'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the table or view. |
SchemaName | String | The schema containing the table or view. |
TableName | String | The name of the table or view containing the column. |
ColumnName | String | The column name. |
DataTypeName | String | The data type name. |
DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
Length | Int32 | The storage size of the column. |
DisplaySize | Int32 | The designated column's normal maximum width in characters. |
NumericPrecision | Int32 | The maximum number of digits in numeric data. The column length in characters for character and date-time data. |
NumericScale | Int32 | The column scale or number of digits to the right of the decimal point. |
IsNullable | Boolean | Whether the column can contain null. |
Description | String | A brief description of the column. |
Ordinal | Int32 | The sequence number of the column. |
IsAutoIncrement | String | Whether the column value is assigned in fixed increments. |
IsGeneratedColumn | String | Whether the column is generated. |
IsHidden | Boolean | Whether the column is hidden. |
IsArray | Boolean | Whether the column is an array. |
sys_keycolumns¶
Describes the primary and foreign keys.
The following query retrieves the primary key for the Subscriber table:
SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Subscriber'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
IsKey | Boolean | Whether the column is a primary key in the table referenced in the TableName field. |
IsForeignKey | Boolean | Whether the column is a foreign key referenced in the TableName field. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
sys_foreignkeys¶
Describes the foreign keys.
The following query retrieves all foreign keys which refer to other tables:
SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the key. |
SchemaName | String | The name of the schema containing the key. |
TableName | String | The name of the table containing the key. |
ColumnName | String | The name of the key column. |
PrimaryKeyName | String | The name of the primary key. |
ForeignKeyName | String | The name of the foreign key. |
ReferencedCatalogName | String | The database containing the primary key. |
ReferencedSchemaName | String | The schema containing the primary key. |
ReferencedTableName | String | The table containing the primary key. |
ReferencedColumnName | String | The column name of the primary key. |
ForeignKeyType | String | Designates whether the foreign key is an import (points to other tables) or export (referenced from other tables) key. |
sys_indexes¶
Describes the available indexes. By filtering on indexes, you can write more selective queries with faster query response times.
The following query retrieves all indexes that are not primary keys:
SELECT * FROM sys_indexes WHERE IsPrimary='false'
Columns¶
Name | Type | Description |
---|---|---|
CatalogName | String | The name of the database containing the index. |
SchemaName | String | The name of the schema containing the index. |
TableName | String | The name of the table containing the index. |
IndexName | String | The index name. |
ColumnName | String | The name of the column associated with the index. |
IsUnique | Boolean | True if the index is unique. False otherwise. |
IsPrimary | Boolean | True if the index is a primary key. False otherwise. |
Type | Int16 | An integer value corresponding to the index type: statistic (0), clustered (1), hashed (2), or other (3). |
SortOrder | String | The sort order: A for ascending or D for descending. |
OrdinalPosition | Int16 | The sequence number of the column in the index. |
sys_connection_props¶
Returns information on the available connection properties and those set in the connection string.
When querying this table, the config connection string should be used:
jdbc:cdata:sfmarketingcloud:config:
This connection string enables you to query this table without a valid connection.
The following query retrieves all connection properties that have been set in the connection string or set through a default value:
SELECT * FROM sys_connection_props WHERE Value <> ''
Columns¶
Name | Type | Description |
---|---|---|
Name | String | The name of the connection property. |
ShortDescription | String | A brief description. |
Type | String | The data type of the connection property. |
Default | String | The default value if one is not explicitly set. |
Values | String | A comma-separated list of possible values. A validation error is thrown if another value is specified. |
Value | String | The value you set or a preconfigured default. |
Required | Boolean | Whether the property is required to connect. |
Category | String | The category of the connection property. |
IsSessionProperty | String | Whether the property is a session property, used to save information about the current connection. |
Sensitivity | String | The sensitivity level of the property. This informs whether the property is obfuscated in logging and authentication forms. |
PropertyName | String | A camel-cased truncated form of the connection property name. |
Ordinal | Int32 | The index of the parameter. |
CatOrdinal | Int32 | The index of the parameter category. |
Hierarchy | String | Shows dependent properties associated that need to be set alongside this one. |
Visible | Boolean | Informs whether the property is visible in the connection UI. |
ETC | String | Various miscellaneous information about the property. |
sys_sqlinfo¶
Describes the SELECT query processing that the connector can offload to the data source.
Collaborative Query Processing¶
When working with data sources that do not support SQL-92, you can query the sys_sqlinfo view to determine the query capabilities of the underlying APIs, expressed in SQL syntax. The connector offloads as much of the SELECT statement processing as possible to the server and then processes the rest of the query in memory.
Discovering the Data Source's SELECT Capabilities¶
Below is an example data set of SQL capabilities. The following result set indicates the SELECT functionality that the connector can offload to the data source or process client side. Your data source may support additional SQL syntax. Some aspects of SELECT functionality are returned in a comma-separated list if supported; otherwise, the column contains NO.
Name | Description | Possible Values |
---|---|---|
AGGREGATE_FUNCTIONS | Supported aggregation functions. | AVG , COUNT , MAX , MIN , SUM , DISTINCT |
COUNT | Whether COUNT function is supported. | YES , NO |
IDENTIFIER_QUOTE_OPEN_CHAR | The opening character used to escape an identifier. | [ |
IDENTIFIER_QUOTE_CLOSE_CHAR | The closing character used to escape an identifier. | ] |
SUPPORTED_OPERATORS | A list of supported SQL operators. | = , > , < , >= , <= , <> , != , LIKE , NOT LIKE , IN , NOT IN , IS NULL , IS NOT NULL , AND , OR |
GROUP_BY | Whether GROUP BY is supported, and, if so, the degree of support. | NO , NO_RELATION , EQUALS_SELECT , SQL_GB_COLLATE |
STRING_FUNCTIONS | Supported string functions. | LENGTH , CHAR , LOCATE , REPLACE , SUBSTRING , RTRIM , LTRIM , RIGHT , LEFT , UCASE , SPACE , SOUNDEX , LCASE , CONCAT , ASCII , REPEAT , OCTET , BIT , POSITION , INSERT , TRIM , UPPER , REGEXP , LOWER , DIFFERENCE , CHARACTER , SUBSTR , STR , REVERSE , PLAN , UUIDTOSTR , TRANSLATE , TRAILING , TO , STUFF , STRTOUUID , STRING , SPLIT , SORTKEY , SIMILAR , REPLICATE , PATINDEX , LPAD , LEN , LEADING , KEY , INSTR , INSERTSTR , HTML , GRAPHICAL , CONVERT , COLLATION , CHARINDEX , BYTE |
NUMERIC_FUNCTIONS | Supported numeric functions. | ABS , ACOS , ASIN , ATAN , ATAN2 , CEILING , COS , COT , EXP , FLOOR , LOG , MOD , SIGN , SIN , SQRT , TAN , PI , RAND , DEGREES , LOG10 , POWER , RADIANS , ROUND , TRUNCATE |
TIMEDATE_FUNCTIONS | Supported date/time functions. | NOW , CURDATE , DAYOFMONTH , DAYOFWEEK , DAYOFYEAR , MONTH , QUARTER , WEEK , YEAR , CURTIME , HOUR , MINUTE , SECOND , TIMESTAMPADD , TIMESTAMPDIFF , DAYNAME , MONTHNAME , CURRENT_DATE , CURRENT_TIME , CURRENT_TIMESTAMP , EXTRACT |
REPLICATION_SKIP_TABLES | Indicates tables skipped during replication. | |
REPLICATION_TIMECHECK_COLUMNS | A string array containing a list of columns which will be used to check for (in the given order) to use as a modified column during replication. | |
IDENTIFIER_PATTERN | String value indicating what string is valid for an identifier. | |
SUPPORT_TRANSACTION | Indicates if the provider supports transactions such as commit and rollback. | YES , NO |
DIALECT | Indicates the SQL dialect to use. | |
KEY_PROPERTIES | Indicates the properties which identify the uniform database. | |
SUPPORTS_MULTIPLE_SCHEMAS | Indicates if multiple schemas may exist for the provider. | YES , NO |
SUPPORTS_MULTIPLE_CATALOGS | Indicates if multiple catalogs may exist for the provider. | YES , NO |
DATASYNCVERSION | The Data Sync version needed to access this driver. | Standard , Starter , Professional , Enterprise |
DATASYNCCATEGORY | The Data Sync category of this driver. | Source , Destination , Cloud Destination |
SUPPORTSENHANCEDSQL | Whether enhanced SQL functionality beyond what is offered by the API is supported. | TRUE , FALSE |
SUPPORTS_BATCH_OPERATIONS | Whether batch operations are supported. | YES , NO |
SQL_CAP | All supported SQL capabilities for this driver. | SELECT , INSERT , DELETE , UPDATE , TRANSACTIONS , ORDERBY , OAUTH , ASSIGNEDID , LIMIT , LIKE , BULKINSERT , COUNT , BULKDELETE , BULKUPDATE , GROUPBY , HAVING , AGGS , OFFSET , REPLICATE , COUNTDISTINCT , JOINS , DROP , CREATE , DISTINCT , INNERJOINS , SUBQUERIES , ALTER , MULTIPLESCHEMAS , GROUPBYNORELATION , OUTERJOINS , UNIONALL , UNION , UPSERT , GETDELETED , CROSSJOINS , GROUPBYCOLLATE , MULTIPLECATS , FULLOUTERJOIN , MERGE , JSONEXTRACT , BULKUPSERT , SUM , SUBQUERIESFULL , MIN , MAX , JOINSFULL , XMLEXTRACT , AVG , MULTISTATEMENTS , FOREIGNKEYS , CASE , LEFTJOINS , COMMAJOINS , WITH , LITERALS , RENAME , NESTEDTABLES , EXECUTE , BATCH , BASIC , INDEX |
PREFERRED_CACHE_OPTIONS | A string value specifies the preferred cacheOptions. | |
ENABLE_EF_ADVANCED_QUERY | Indicates if the driver directly supports advanced queries coming from Entity Framework. If not, queries will be handled client side. | YES , NO |
PSEUDO_COLUMNS | A string array indicating the available pseudo columns. | |
MERGE_ALWAYS | If the value is true, The Merge Mode is forcibly executed in Data Sync. | TRUE , FALSE |
REPLICATION_MIN_DATE_QUERY | A select query to return the replicate start datetime. | |
REPLICATION_MIN_FUNCTION | Allows a provider to specify the formula name to use for executing a server side min. | |
REPLICATION_START_DATE | Allows a provider to specify a replicate startdate. | |
REPLICATION_MAX_DATE_QUERY | A select query to return the replicate end datetime. | |
REPLICATION_MAX_FUNCTION | Allows a provider to specify the formula name to use for executing a server side max. | |
IGNORE_INTERVALS_ON_INITIAL_REPLICATE | A list of tables which will skip dividing the replicate into chunks on the initial replicate. | |
CHECKCACHE_USE_PARENTID | Indicates whether the CheckCache statement should be done against the parent key column. | TRUE , FALSE |
CREATE_SCHEMA_PROCEDURES | Indicates stored procedures that can be used for generating schema files. |
The following query retrieves the operators that can be used in the WHERE clause:
SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'
Note that individual tables may have different limitations or requirements on the WHERE clause; refer to the Data Model section for more information.
Columns¶
Name | Type | Description |
---|---|---|
NAME | String | A component of SQL syntax, or a capability that can be processed on the server. |
VALUE | String | Detail on the supported SQL or SQL syntax. |
sys_identity¶
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
Columns¶
Name | Type | Description |
---|---|---|
Id | String | The database-generated ID returned from a data modification operation. |
Batch | String | An identifier for the batch. 1 for a single operation. |
Operation | String | The result of the operation in the batch: INSERTED, UPDATED, or DELETED. |
Message | String | SUCCESS or an error message if the update in the batch failed. |
Advanced Configurations Properties¶
The advanced configurations properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure. Click the links for further details.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud. |
APIIntegrationType | The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App. |
UseLegacyAuthentication | A boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication or not. |
User | The Salesforce Marketing Cloud user account used to authenticate. |
Password | The password used to authenticate the user. |
Subdomain | The subdomain of the Salesforce Marketing Cloud API. |
UseAsyncBatch | Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true. |
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
Scope | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Schema | Specify the Salesforce Marketing Cloud server version to connect with. |
Property | Description |
---|---|
AccountId | The account identifier, or MID, of the target business unit. |
DisplayChildDataExtensions | Displays the Data Extensions of Child Accounts if set. |
Instance | The instance of the Salesforce Marketing Cloud API used. |
ListDataExtensions | A boolean determining if data extensions should be listed as tables or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Salesforce Marketing Cloud. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryAllAccounts | Queries all accounts, including parent and all children, regarding an event. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TimeZone | The server timezone. The format should use the UTC offset, for example: +00:00. |
Authentication¶
This section provides a complete list of authentication properties you can configure.
Property | Description |
---|---|
AuthScheme | The type of authentication to use when connecting to Salesforce Marketing Cloud. |
APIIntegrationType | The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App. |
UseLegacyAuthentication | A boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication or not. |
User | The Salesforce Marketing Cloud user account used to authenticate. |
Password | The password used to authenticate the user. |
Subdomain | The subdomain of the Salesforce Marketing Cloud API. |
UseAsyncBatch | Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert. |
WaitForBulkResults | Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true. |
AuthScheme¶
The type of authentication to use when connecting to Salesforce Marketing Cloud.
Possible Values¶
Auto
, OAuth
, Basic
Data Type¶
string
Default Value¶
Auto
Remarks¶
- Auto: Lets the driver decide automatically based on the other connection properties you have set.
- OAuth: Set to this to perform OAuth authentication.
- Basic: Set this to use BASIC user / password authentication.
APIIntegrationType¶
The grant type for the OAuth flow. Accepted entries are Server-to-Server and Web-App.
Possible Values¶
Server-to-Server
, Web-App
Data Type¶
string
Default Value¶
Web-App
Remarks¶
When an app is created on SF Marketing Cloud, you are given an option of Web-API and Server-to-Server. This acts to determine the grant type for the OAuth flow. Use the following options to select your authentication grant type:
- Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates OAuthGrantType = Client.
- Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates OAuthGrantType = Code.
Optionally set OAuthGrantType directly instead of setting this property. Using OAuthGrantType may be desireable in cases where multiple products are being used to keep everything consistent since APIIntegrationType
is specific to Salesforce Marketing Cloud.
UseLegacyAuthentication¶
A boolean determining if the connection should be made to Salesforce Marketing Cloud REST API using the legacy authentication or not.
Data Type¶
bool
Default Value¶
false
Remarks¶
To connect to Salesforce Marketing Cloud where you have installed a package with legacy functionality you must set this property to TRUE.
User¶
The Salesforce Marketing Cloud user account used to authenticate.
Data Type¶
string
Default Value¶
""
Remarks¶
Together with Password, this field is used to authenticate against the Salesforce Marketing Cloud server.
Password¶
The password used to authenticate the user.
Data Type¶
string
Default Value¶
""
Remarks¶
The User and Password
are together used to authenticate with the server.
Subdomain¶
The subdomain of the Salesforce Marketing Cloud API.
Data Type¶
string
Default Value¶
""
Remarks¶
The subdomain can be obtained as follows:
- Log in to Marketing Cloud.
- Navigate to the Setup page, then select: Apps -> Installed Packages
- Select the package with the API integration component you want to use.
- Subdomain will be specified in the Authentication Base URI. Example:
https://SUBDOMAIN.auth.marketingcloudapis.com/
Note: This property must be specified if UseLegacyAuthentication is set to FALSE or if Instance is greater than s10.
UseAsyncBatch¶
Whether to use the synchronous or the asynchronous SOAP API to perform Batch insert.
Data Type¶
bool
Default Value¶
true
Remarks¶
This property determines whether or not the asynchronous API is used for Insert data to Salesforce Marketing Cloud. These requests will be processed asynchronously meaning the driver will not wait for Salesforce to process the results fully. You can query the following table to get information about the jobs and batches that were created:
SELECT * FROM LastResultInfo#TEMP
WaitForBulkResults¶
Whether to wait for bulk results when using the asynchronous API. Only active when UseAsyncBatch is true.
Data Type¶
bool
Default Value¶
false
Remarks¶
This property determines whether the connector will wait for bulk requests to report their status. By default this property is false and any INSERT queries will complete as soon as they are submitted to Salesforce Marketing Cloud. When this property is true, the connector will wait for INSERT to finish.
When this property is false, data modification queries will be faster but less detailed status information will be available. The LastResultInfo#TEMP table will list the creates batches and not the status of individual rows. Information about individual rows will only be availble if you execute the GetBatchResults stored procedure for each batch.
When this property is true, data modification queries will be slower but more status information will be available. The LastResultInfo#TEMP table will list the ID of each updated row, its status and any associated error messages.
OAuth¶
This section provides a complete list of OAuth properties you can configure.
Property | Description |
---|---|
InitiateOAuth | Set this property to initiate the process to obtain or refresh the OAuth access token when you connect. |
OAuthClientId | The client ID assigned when you register your application with an OAuth authorization server. |
OAuthClientSecret | The client secret assigned when you register your application with an OAuth authorization server. |
OAuthAccessToken | The access token for connecting using OAuth. |
CallbackURL | The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings. |
Scope | Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages. |
OAuthGrantType | The grant type for the OAuth flow. |
OAuthVerifier | The verifier code returned from the OAuth authorization URL. |
OAuthRefreshToken | The OAuth refresh token for the corresponding OAuth access token. |
OAuthExpiresIn | The lifetime in seconds of the OAuth AccessToken. |
OAuthTokenTimestamp | The Unix epoch timestamp in milliseconds when the current Access Token was created. |
InitiateOAuth¶
Set this property to initiate the process to obtain or refresh the OAuth access token when you connect.
Possible Values¶
OFF
, GETANDREFRESH
, REFRESH
Data Type¶
string
Default Value¶
OFF
Remarks¶
The following options are available:
OFF
: Indicates that the OAuth flow will be handled entirely by the user. An OAuthAccessToken will be required to authenticate.GETANDREFRESH
: Indicates that the entire OAuth Flow will be handled by the connector. If no token currently exists, it will be obtained by prompting the user via the browser. If a token exists, it will be refreshed when applicable.REFRESH
: Indicates that the connector will only handle refreshing the OAuthAccessToken. The user will never be prompted by the connector to authenticate via the browser. The user must handle obtaining the OAuthAccessToken and OAuthRefreshToken initially.
OAuthClientId¶
The client ID assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId
value, sometimes also called a consumer key, and a client secret, the OAuthClientSecret.
OAuthClientSecret¶
The client secret assigned when you register your application with an OAuth authorization server.
Data Type¶
string
Default Value¶
""
Remarks¶
As part of registering an OAuth application, you will receive the OAuthClientId, also called a consumer key. You will also receive a client secret, also called a consumer secret. Set the client secret in the OAuthClientSecret
property.
OAuthAccessToken¶
The access token for connecting using OAuth.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthAccessToken
property is used to connect using OAuth. The OAuthAccessToken
is retrieved from the OAuth server as part of the authentication process. It has a server-dependent timeout and can be reused between requests.
The access token is used in place of your user name and password. The access token protects your credentials by keeping them on the server.
OAuthSettingsLocation¶
The location of the settings file where OAuth values are saved when InitiateOAuth is set to GETANDREFRESH or REFRESH. Alternatively, you can hold this location in memory by specifying a value starting with 'memory://'
.
Data Type¶
string
Default Value¶
%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt
Remarks¶
When InitiateOAuth is set to GETANDREFRESH
or REFRESH
, the driver saves OAuth values to avoid requiring the user to manually enter OAuth connection properties and to allow the credentials to be shared across connections or processes.
Instead of specifying a file path, you can use memory storage. Memory locations are specified by using a value starting with 'memory://'
followed by a unique identifier for that set of credentials (for example, memory://user1). The identifier can be anything you choose but should be unique to the user. Unlike file-based storage, where credentials persist across connections, memory storage loads the credentials into static memory, and the credentials are shared between connections using the same identifier for the life of the process. To persist credentials outside the current process, you must manually store the credentials prior to closing the connection. This enables you to set them in the connection when the process is started again. You can retrieve OAuth property values with a query to the sys_connection_props
system table. If there are multiple connections using the same credentials, the properties are read from the previously closed connection.
The default location is "%APPDATA%\CData\Acumatica Data Provider\OAuthSettings.txt" with %APPDATA%
set to the user's configuration directory. The default values are
- Windows: "
register://%DSN
" - Unix: "%AppData%..."
where DSN is the name of the current DSN used in the open connection.
The following table lists the value of %APPDATA%
by OS:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Linux | ~/.config |
CallbackURL¶
The OAuth callback URL to return to when authenticating. This value must match the callback URL you specify in your app settings.
Data Type¶
string
Default Value¶
""
Remarks¶
During the authentication process, the OAuth authorization server redirects the user to this URL. This value must match the callback URL you specify in your app settings.
Scope¶
Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.
Data Type¶
string
Default Value¶
""
Remarks¶
Space-separated list of data-access permissions for your application. Review REST API Permission IDs and Scopes for a full list of permissions. If scope is not specified, the token is issued with the scopes assigned to the API integration in Installed Packages.
OAuthGrantType¶
The grant type for the OAuth flow.
Possible Values¶
Client
, Code
Data Type¶
string
Default Value¶
""
Remarks¶
When an app on is created on Salesforce Marketing Cloud, you are given an option of Web-API or Server-to-Server. Use the following options to select your authentication grant type:
- Server-to-Server: This is used when applications request an access token to access their own resources, not on behalf of a user. This indicates
OAuthGrantType
= Client. - Web-App: This is used by confidential and public clients to exchange an authorization code for an access token. This indicates
OAuthGrantType
= Code.
APIIntegrationType may alternatively be specified to indicate the GrantType.
OAuthVerifier¶
The verifier code returned from the OAuth authorization URL.
Data Type¶
string
Default Value¶
""
Remarks¶
The verifier code returned from the OAuth authorization URL. This can be used on systems where a browser cannot be launched such as headless systems.
Authentication on Headless Machines¶
See to obtain the OAuthVerifier
value.
Set OAuthSettingsLocation along with OAuthVerifier
. When you connect, the connector exchanges the OAuthVerifier
for the OAuth authentication tokens and saves them, encrypted, to the specified file. Set InitiateOAuth to GETANDREFRESH automate the exchange.
Once the OAuth settings file has been generated, you can remove OAuthVerifier
from the connection properties and connect with OAuthSettingsLocation set.
To automatically refresh the OAuth token values, set OAuthSettingsLocation and additionally set InitiateOAuth to REFRESH.
OAuthRefreshToken¶
The OAuth refresh token for the corresponding OAuth access token.
Data Type¶
string
Default Value¶
""
Remarks¶
The OAuthRefreshToken
property is used to refresh the OAuthAccessToken when using OAuth authentication.
OAuthExpiresIn¶
The lifetime in seconds of the OAuth AccessToken.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthTokenTimestamp to determine when the AccessToken will expire.
OAuthTokenTimestamp¶
The Unix epoch timestamp in milliseconds when the current Access Token was created.
Data Type¶
string
Default Value¶
""
Remarks¶
Pair with OAuthExpiresIn to determine when the AccessToken will expire.
SSL¶
This section provides a complete list of SSL properties you can configure.
Property | Description |
---|---|
SSLServerCert | The certificate to be accepted from the server when connecting using TLS/SSL. |
SSLServerCert¶
The certificate to be accepted from the server when connecting using TLS/SSL.
Data Type¶
string
Default Value¶
""
Remarks¶
If using a TLS/SSL connection, this property can be used to specify the TLS/SSL certificate to be accepted from the server. Any other certificate that is not trusted by the machine is rejected.
This property can take the following forms:
Description | Example |
---|---|
A full PEM Certificate (example shortened for brevity) | -----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE----- |
A path to a local file containing the certificate | C:\cert.cer |
The public key (example shortened for brevity) | -----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY----- |
The MD5 Thumbprint (hex values can also be either space or colon separated) | ecadbdda5a1529c58a1e9e09828d70e4 |
The SHA1 Thumbprint (hex values can also be either space or colon separated) | 34a929226ae0819f2ec14b4a3d904f801cbb150d |
If not specified, any certificate trusted by the machine is accepted.
Certificates are validated as trusted by the machine based on the System's trust store. The trust store used is the 'javax.net.ssl.trustStore' value specified for the system. If no value is specified for this property, Java's default trust store is used (for example, JAVA_HOME\lib\security\cacerts).
Use '*' to signify to accept all certificates. Note that this is not recommended due to security concerns.
Schema¶
This section provides a complete list of schema properties you can configure.
Property | Description |
---|---|
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
BrowsableSchemas | This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA, SchemaB, SchemaC. |
Tables | This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA, TableB, TableC. |
Views | Restricts the views reported to a subset of the available tables. For example, Views=ViewA, ViewB, ViewC. |
Schema | Specify the Salesforce Marketing Cloud server version to connect with. |
Location¶
A path to the directory that contains the schema files defining tables, views, and stored procedures.
Data Type¶
string
Default Value¶
%APPDATA%\SFMarketingCloud Data Provider\Schema
Remarks¶
The path to a directory which contains the schema files for the connector (.rsd files for tables and views, .rsb files for stored procedures). The folder location can be a relative path from the location of the executable. The Location
property is only needed if you want to customize definitions (for example, change a column name, ignore a column, and so on) or extend the data model with new tables, views, or stored procedures.
Note
Given that this connector supports multiple schemas, the structure for Salesforce Marketing Cloud custom schema files is as follows:
- Each schema is given a folder corresponding to that schema name.
- These schema folders are contained in a parent folder.
- The
parent folder
should be set as theLocation
, not an individual schema's folder.
If left unspecified, the default location is "%APPDATA%\SFMarketingCloud Data Provider\Schema" with %APPDATA%
being set to the user's configuration directory:
Platform | %APPDATA% |
---|---|
Windows | The value of the APPDATA environment variable |
Mac | ~/Library/Application Support |
Linux | ~/.config |
BrowsableSchemas¶
This property restricts the schemas reported to a subset of the available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the schemas from databases can be expensive. Providing a list of schemas in the connection string improves the performance.
Tables¶
This property restricts the tables reported to a subset of the available tables. For example, Tables=TableA,TableB,TableC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the tables from some databases can be expensive. Providing a list of tables in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the tables you want in a comma-separated list. Each table should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Views¶
Restricts the views reported to a subset of the available tables. For example, Views=ViewA,ViewB,ViewC.
Data Type¶
string
Default Value¶
""
Remarks¶
Listing the views from some databases can be expensive. Providing a list of views in the connection string improves the performance of the connector.
This property can also be used as an alternative to automatically listing views if you already know which ones you want to work with and there would otherwise be too many to work with.
Specify the views you want in a comma-separated list. Each view should be a valid SQL identifier with any special characters escaped using square brackets, double-quotes or backticks. For example, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.
Note that when connecting to a data source with multiple schemas or catalogs, you will need to provide the fully qualified name of the table in this property, as in the last example here, to avoid ambiguity between tables that exist in multiple catalogs or schemas.
Schema¶
Specify the Salesforce Marketing Cloud server version to connect with.
Possible Values¶
SOAP
, REST
Data Type¶
string
Default Value¶
SOAP
Remarks¶
Set this property to REST to use the Salesforce Marketing Cloud 1.x REST API or SOAP to use the Salesforce Marketing Cloud SOAP API.
Miscellaneous¶
This section provides a complete list of miscellaneous properties you can configure.
Property | Description |
---|---|
AccountId | The account identifier, or MID, of the target business unit. |
DisplayChildDataExtensions | Displays the Data Extensions of Child Accounts if set. |
Instance | The instance of the Salesforce Marketing Cloud API used. |
ListDataExtensions | A boolean determining if data extensions should be listed as tables or not. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Pagesize | The maximum number of results to return per page from Salesforce Marketing Cloud. |
PseudoColumns | This property indicates whether or not to include pseudo columns as columns to the table. |
QueryAllAccounts | Queries all accounts, including parent and all children, regarding an event. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
TimeZone | The server timezone. The format should use the UTC offset, for example: +00:00. |
AccountId¶
The account identifier, or MID, of the target business unit.
Data Type¶
string
Default Value¶
""
Remarks¶
Use this property to switch between business units. If you don't specify account_id, the returned access token is in the context of the business unit that created the integration. The specified AccountId will be used only during the OAuth flow. It is not supported for legacy packages.
DisplayChildDataExtensions¶
Displays the Data Extensions of Child Accounts if set.
Data Type¶
bool
Default Value¶
false
Remarks¶
Use this property to list child accounts data extension objects. By default, only parent and shared data extensions are displayed.
Instance¶
The instance of the Salesforce Marketing Cloud API used.
Possible Values¶
s1
, s4
, s6
, s7
, s8
, s10
, s11
, s12
Data Type¶
string
Default Value¶
s7
Remarks¶
The Salesforce Marketing Cloud instance used by default is s7. To determine your instance, follow the steps below:
- Log in to Marketing Cloud.
- Click the name of your account.
- Copy the MID value for your account.
- In a separate browser tab or window, navigate to
https://trust.marketingcloud.com
. - Enter the copied MID value in the text field and click Go.
Note: If the instance is greater than s10, then Subdomain must be specified.
ListDataExtensions¶
A boolean determining if data extensions should be listed as tables or not.
Data Type¶
bool
Default Value¶
true
Remarks¶
A boolean determining if data extensions should be listed as tables or not.
MaxRows¶
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Data Type¶
int
Default Value¶
-1
Remarks¶
Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time.
Other¶
These hidden properties are used only in specific use cases.
Data Type¶
string
Default Value¶
""
Remarks¶
The properties listed below are available for specific use cases. Normal driver use cases and functionality should not require these properties.
Specify multiple properties in a semicolon-separated list.
Integration and Formatting¶
Property | Description |
---|---|
DefaultColumnSize | Sets the default length of string fields when the data source does not provide column length in the metadata. The default value is 2000. |
ConvertDateTimeToGMT | Determines whether to convert date-time values to GMT, instead of the local time of the machine. |
RecordToFile=filename | Records the underlying socket data transfer to the specified file. |
Pagesize¶
The maximum number of results to return per page from Salesforce Marketing Cloud.
Data Type¶
int
Default Value¶
-1
Remarks¶
The Pagesize
property affects the maximum number of results to return per page from Salesforce Marketing Cloud. Setting a higher value may result in better performance at the cost of additional memory allocated per page consumed.
PseudoColumns¶
This property indicates whether or not to include pseudo columns as columns to the table.
Data Type¶
string
Default Value¶
""
Remarks¶
This setting is particularly helpful in Entity Framework, which does not allow you to set a value for a pseudo column unless it is a table column. The value of this connection setting is of the format "Table1=Column1, Table1=Column2, Table2=Column3". You can use the "*" character to include all tables and all columns; for example, "*=*".
QueryAllAccounts¶
Queries all accounts, including parent and all children, regarding an event.
Data Type¶
bool
Default Value¶
false
Remarks¶
Use this property to query all accounts, including parent and all children, regarding an event. Available only for SOAP schema.
Timeout¶
The value in seconds until the timeout error is thrown, canceling the operation.
Data Type¶
int
Default Value¶
60
Remarks¶
If Timeout
= 0, operations do not time out. The operations run until they complete successfully or until they encounter an error condition.
If Timeout
expires and the operation is not yet complete, the connector throws an exception.
TimeZone¶
The server timezone. The format should use the UTC offset, for example: +00:00.
Data Type¶
string
Default Value¶
-06:00
Remarks¶
If you have contacted your Marketing Cloud representative to disable the "Incoming Date Normalization" feature, you must specify the Account timezone instead of server timezone.