CData Cloud offers access to Salesforce Marketing Cloud across several standard services and protocols, in a cloud-hosted solution. Any application that can connect to a SQL Server database can connect to Salesforce Marketing Cloud through CData Cloud.
CData Cloud allows you to standardize and configure connections to Salesforce Marketing Cloud as though it were any other OData endpoint or standard SQL Server.
This page provides a guide to Establishing a Connection to Salesforce Marketing Cloud in CData Cloud, as well as information on the available resources, and a reference to the available connection properties.
Establishing a Connection shows how to authenticate to Salesforce Marketing Cloud and configure any necessary connection properties to create a database in CData Cloud
Accessing data from Salesforce Marketing Cloud through the available standard services and CData Cloud administration is documented in further details in the CData Cloud Documentation.
Connect to Salesforce Marketing Cloud by selecting the corresponding icon in the Database tab. Required properties are listed under Settings. The Advanced tab lists connection properties that are not typically required.
For both REST and SOAP APIs, you have the option to refine data access using the following properties:
The Salesforce Marketing Cloud REST API uses the OAuth authentication standard. To authenticate using OAuth, you must create a custom OAuth application to obtain values for the OAuthClientId and OAuthClientSecret connection properties. See Creating a Custom OAuth App for more information.
The Salesforce Marketing Cloud SOAP API can connect using OAuth, but also supports a legacy use of login credentials.
Note: Data extension objects in Salesforce Marketing Cloud are only accessible through the SOAP API.
After setting the following, you are ready to connect:
Option 1: Obtain and Exchange a Verifier Code
To obtain a verifier code, you must authenticate at the OAuth authorization URL.
Follow the steps below to authenticate from the machine with an Internet browser and obtain the OAuthVerifier connection property.
On the headless machine, set the following connection properties to obtain the OAuth authentication values:
After the OAuth settings file is generated, you need to re-set the following properties to connect:
Option 2: Transfer OAuth Settings
Prior to connecting on a headless machine, you need to create and install a connection with the driver on a device that supports an Internet browser. Set the connection properties as described in "Desktop Applications" above.
After completing the instructions in "Desktop Applications", the resulting authentication values are encrypted and written to the location specified by OAuthSettingsLocation. The default filename is OAuthSettings.txt.
Once you have successfully tested the connection, copy the OAuth settings file to your headless machine.
On the headless machine, set the following connection properties:
Specify the following properties to enable server-to-server OAuth authentication for your application:
To connect to data using login credentials authentication, set the following:
Follow the procedure below to create and register an application and obtain the OAuth client credentials, the client Id, and client secret:
The Cloud offers the possibility to select, insert, update, and delete data from data extensions as relational tables. To query a data extension, simple enter its name in the format DataExtensionObject_Name where Name is the name of your data extension.
Note: To connect to data extension objects in Salesforce Marketing Cloud, you must use the SOAP API. Set Schema to SOAP.
SELECT * FROM DataExtensionObject_fsefes3
SELECT * FROM DataExtensionObject_fsefes3 WHERE FieldName1 = 'One'
Note 1: All filters which work with normal tables/views also work with data extensions.
Note 2: By default the Salesforce Marketing Cloud retrieves data for the LoggedIn ClientId. To retrieve results for more than one ClientID, use semi-colons (;) as a separator. The ClientID can be accounts and sub-accounts, including Enterprise 2.0, On-Your-Behalf, and Lock & Publish accounts.
SELECT * FROM DataExtensionObject_fsefes3 WHERE ClientID = '1234567'
INSERT INTO DataExtensionObject_fsefes3 (FieldName1, FieldName2, FieldName3) VALUES ('One', 'Two', 'Three')
UPDATE DataExtensionObject_secondtest15 SET [Name] = 'ChangedFromTheApi' WHERE [Email Address] = '[email protected]'
Note: A primary key has to exist for this data extension for the update to work.
DELETE FROM DataExtensionObject_secondtest15 WHERE [Email Address] = '[email protected]'
Note: A primary key has to exist for this data extension for the deletion to work.
By default, the Cloud attempts to negotiate TLS with the server. The server certificate is validated against the default system trusted certificate store. You can override how the certificate gets validated using the SSLServerCert connection property.
To specify another certificate, see the SSLServerCert connection property.
To authenticate to an HTTP proxy, set the following:
Set the following properties:
The CData Cloud 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.
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.
The SOAP API provides comprehensive access to most email functionality. The SOAP API uses SOAP envelopes to pass information between you and Salesforce Marketing Cloud. See SOAP Data Model for the available entities in the SOAP API.
The Cloud 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.
The Cloud uses the Salesforce Marketing Cloud API to process supported filters. The Cloud processes other filters client-side within the Cloud.
Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.
Stored Procedures are function-like interfaces to Salesforce Marketing Cloud. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.
The Cloud models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Assets | Provides access to digital assets within Salesforce Marketing Cloud. Assets include reusable content elements such as images, templates, or code snippets that are stored and managed in Content Builder. This table allows you to create, update, delete, and query these assets to support consistent brand messaging across campaigns and channels. |
| Callbacks | Manages event notification callbacks that are configured in Salesforce Marketing Cloud. A callback defines an endpoint that receives real-time notifications when specified system events occur, such as message delivery or data import completion. This table allows you to create, update, delete, and query callback definitions to automate event-driven workflows. |
| CampaignAssets | Maintains relationships between campaigns and their associated assets in Salesforce Marketing Cloud. Each record links campaign initiatives with digital assets such as email templates, images, or social media content. This table supports create, update, delete, and query operations for managing campaign resources effectively. |
| Campaigns | Represents campaigns in Salesforce Marketing Cloud. Each campaign groups related marketing efforts and performance metrics under a single initiative. This table allows you to create, update, delete, and query campaigns to manage lifecycle stages, track engagement, and associate related assets or audiences. |
| Categories | Stores category information (also known as folders) within Content Builder in Salesforce Marketing Cloud. Categories organize assets and content for easier navigation and management. This table allows you to create, update, delete, and query folder structures that help maintain a logical and accessible content hierarchy. |
| EventDefinitions | Manages event definitions within Salesforce Marketing Cloud. An event definition specifies a trigger, such as a form submission or API call, that initiates an automated process like a journey entry or data update. This table allows you to create, delete, and query event definitions to orchestrate customer experiences. |
| FacebookMessengerProperties | Defines properties for Facebook Messenger integrations in Salesforce Marketing Cloud. These properties control how messages are formatted, delivered, and tracked within Facebook channels. This table allows you to query existing properties or create new configurations to manage social messaging campaigns. |
| JourneyActivities | Contains details about journey activities in Salesforce Marketing Cloud. A journey activity represents an action or decision point in a customer journey, such as sending an email or evaluating a contact attribute. This table allows you to create, update, and query journey activities to refine automation workflows. |
| Journeys | Represents customer journeys in Salesforce Marketing Cloud. A journey defines an automated, multi-step process that guides contacts through personalized interactions across channels. This table allows you to create, update, delete, and query journey definitions to manage audience engagement strategies. |
| LineMessengerProperties | The table that defines configuration properties for LINE messenger integrations in Salesforce Marketing Cloud. These properties determine how messages are delivered and tracked within LINE communication channels. This table allows you to query and create properties to support messaging automation for the LINE platform. |
| SendDefinitions | Stores send definitions in Salesforce Marketing Cloud. A send definition specifies the parameters for email, Short Message Service (SMS), or push sends, including target audiences, content, and delivery options. This table allows you to create, update, delete, and query send definitions to manage outbound communication workflows. |
| Subscriptions | Manages event notification subscriptions within Salesforce Marketing Cloud. A subscription defines which events are monitored and where notifications are sent. This table allows you to create, update, delete, and query event subscriptions to support custom automation and data integration processes. |
Provides access to digital assets within Salesforce Marketing Cloud. Assets include reusable content elements such as images, templates, or code snippets that are stored and managed in Content Builder. This table allows you to create, update, delete, and query these assets to support consistent brand messaging across campaigns and channels.
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
To create an Asset, you will need to specify at least the Name and TypeId column.
INSERT INTO ASSETS (TypeID, TypeName, Name) VALUES (207, 'templatebasedemail', 'First_Based_Template_Email_CData')
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
Assets may be deleted by providing the Id of the Asset and issuing a DELETE statement.
DELETE FROM ASSETS WHERE ID = 20027
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | Integer | True | =,!=,<,<=,>,>= |
Identifies the unique record for the asset in Salesforce Marketing Cloud. This system-generated value is immutable and serves as the primary reference for all internal relationships, audit logs, and API operations. It links the asset to its associated metadata such as owner, category, and asset type, and is required for replication tracking and dependency resolution during publishing or enterprise sharing. | |
| CustomerKey | String | False | =,!= |
Stores the customer-defined key or external identifier (Id) for the asset. This human-readable key is unique within a business unit and allows developers or marketers to reference the asset programmatically through REST or SOAP API operations. Unlike the system-generated Id or ObjectId fields, this key maintains referential integrity during migrations or environment synchronization. When not provided, the system automatically derives it from the asset name. | |
| ObjectId | String | True |
Contains the system-controlled, read-only text string that globally identifies the asset object. Unlike the Id field, which represents the local record Id within a specific environment, this field remains consistent across services, API layers, and replicated versions of the same asset. It enables the platform to track and reconcile an asset's identity across business units, environments, and publishing workflows. | ||
| Name | String | False | =,!= |
Specifies the display name that identifies the asset in the Content Builder module, the REST API, and automation tools. This value is defined by the user and used by marketers to locate, reference, and reuse assets across multiple campaigns. Renaming an asset updates its metadata but does not affect integrations that reference the CustomerKey. | |
| Description | String | False | =,!= |
Provides a human-readable explanation of the asset's content, purpose, or intended audience. This description improves search accuracy, filtering, and collaboration within shared libraries. It can be updated freely and is displayed in both the UI and API results to assist with documentation and compliance review. | |
| OwnerId | Integer | True | =,!=,<,<=,>,>= |
Identifies the user or business unit that owns the asset. This value defines edit and publish permissions and establishes accountability within enterprise environments. Ownership metadata is propagated to shared business units to preserve audit traceability. Changing this value can modify access rights in approval or publishing workflows. | |
| OwnerName | String | True | =,!= |
Displays the full name of the asset owner for visibility and collaboration. This value mirrors the user record that is associated with the OwnerId field and helps administrators coordinate updates and enforce brand stewardship policies. | |
| OwnerEmail | String | True | =,!= |
Holds the email address of the asset owner for audit reports, approval notifications, and workflow communication. This field supports compliance by enabling direct contact with content custodians and updates automatically when the owner's profile changes in Account Settings. | |
| OwnerUserId | Integer | True |
Links the asset owner to their internal user record. This numeric Id verifies permissions when publishing or sharing assets and functions as a join field for ownership validation across enterprise business units. | ||
| CreatedDate | Datetime | True | =,!=,<,<=,>,>= |
Records the date and time when the asset was first created in Salesforce Marketing Cloud. This timestamp is automatically generated and cannot be modified. It supports reporting dashboards, content lifecycle analytics, and compliance audit trails to identify creation trends and authorship. | |
| CreatorId | Integer | True | =,!=,<,<=,>,>= |
Identifies the user who originally created the asset. This Id persists even if ownership later changes and supports accountability in activity-based reporting or historical audits. It ensures that original authorship is preserved for governance and performance review. | |
| CreatorName | String | True |
Shows the full name of the user who created the asset. This information appears in system logs, API metadata, and collaboration interfaces, allowing reviewers to attribute original authorship during approval or migration processes. | ||
| CreatorEmail | String | True |
Holds the email address of the user who created the asset. This address is used to identify the original creator in audit notifications or cross-business-unit requests. It remains static even if the creator's role or access level changes later. | ||
| CreatorUserId | Integer | True |
Links the asset creation event to the specific internal user record. This Id enables precise permission validation, and it is referenced in governance reporting and automation scripts to attribute imported assets to valid users. | ||
| ModifiedDate | Datetime | True | =,!=,<,<=,>,>= |
Captures the most recent date and time when the asset was modified. This value updates automatically upon any change to the asset's content or metadata. It underpins version tracking, synchronization, and rollback operations, helping administrators identify assets requiring review before publication. | |
| ModifierId | Integer | True | =,!=,<,<=,>,>= |
Identifies the user who most recently modified the asset. This field provides traceability in shared environments and enables auditors to determine who performed the last update. It is referenced in version control processes to associate each revision with a specific editor. | |
| ModifierName | String | True |
Shows the name of the user who last modified the asset. This value appears in audit logs and the Content Builder details pane, informing collaborators of recent updates and supporting distributed review workflows. | ||
| ModifierEmail | String | True |
Holds the email address of the user who most recently modified the asset. This address supports workflow notifications or change-request follow-ups and stays synchronized with user profile data to maintain audit consistency. | ||
| ModifierUserId | Integer | True |
Links modification events to the user account that performed them. This Id connects the revision history to permission models, ensuring accurate accountability in compliance and quality-assurance reports. | ||
| EnterpriseId | Integer | True | =,!=,<,<=,>,>= |
Identifies the enterprise-level business unit that governs the asset. This value represents the root organization in an Enterprise 2.0 hierarchy and remains constant even when the asset is replicated or shared across subordinate units. In contrast, the MemberId field specifies the individual business unit that owns or manages the asset locally. | |
| MemberId | Integer | True | =,!=,<,<=,>,>= |
Stores the Marketing Cloud Member Id (MID) for the business unit that owns the asset. This value defines the operational context for editing, localization, and data governance. Whereas the EnterpriseId field identifies the overarching enterprise parent, this field determines ownership and access permissions within that unit and is evaluated alongside EnterpriseId to resolve sharing scope and publishing rights. | |
| ActiveDate | Datetime | False | =,!=,<,<=,>,>= |
Defines the date and time when the asset becomes active or available for use. When no value is supplied, the asset is active immediately upon creation. | |
| ExpirationDate | Datetime | False | =,!=,<,<=,>,>= |
Defines when the asset expires or becomes inactive. After this date, the asset can no longer be used in new sends or automations but remains accessible for reporting. Used together with the ActiveDate field, it enforces lifecycle governance to prevent reuse of outdated content. | |
| ContentType | String | False | =,!= |
Specifies the format or media category of the asset (for example, HTML, Text, Image, or JSON). This field determines which rendering engine and delivery channels are supported and ensures compatibility between asset design and targeted output medium. | |
| TypeId | Integer | False | =,!=,<,<=,>,>= |
Identifies the asset's structural type definition within Salesforce Marketing Cloud. This system reference links the asset to internal metadata that controls supported properties, channels, and rendering logic. | |
| TypeName | String | False |
Indicates the internal technical name of the asset type. This value is used in API filtering and classification, enabling automation scripts to determine processing rules for specific asset formats during import or export. | ||
| TypeDisplayName | String | False |
Provides the user-friendly display name of the asset type. This label appears in the Content Builder interface and reporting views to describe the content kind (for example, Email Template or Image File), helping users recognize content categories quickly. | ||
| CategoryId | Integer | False | =,!=,<,<=,>,>= |
Links the asset to the category or folder where it resides. Categories organize assets hierarchically for storage and access control and are evaluated when determining folder permissions and applying Content Builder filters for retrieval. | |
| CategoryName | String | False |
Displays the name of the category or folder that contains the asset. This value supports navigation and search within Content Builder's folder hierarchy and maintains consistency between UI and API folder structures. | ||
| CategoryParentId | Integer | False |
References the parent category of the folder containing the asset. This value defines the hierarchical relationship between nested folders and supports inherited permissions and breadcrumb navigation. | ||
| Content | String | False | =,!= |
Contains the main content of the asset. This field can hold HTML markup, JSON configuration, or text that is used to render messages and pages. The message compiler reads this field directly during send execution to generate personalized output. | |
| Design | String | False | =,!= |
Defines fallback design data that used when neither the primary Content nor SuperContent field is available. This field ensures a consistent layout by providing default visuals or placeholders and preserves rendering integrity in conditional-content assets. | |
| SuperContent | String | False | =,!= |
Contains enhanced content that overrides the standard Content field during rendering. Typically used for localized or dynamic variations, this field allows targeted delivery of alternate layouts or messages when conditions are met. | |
| File | String | False |
Stores a Base64-encoded binary representation of a file that is associated with the asset. Supported media include images, documents, or templates uploaded to Content Builder. The file is validated for size and type according to the FileProperties field before distribution or publication. | ||
| FileProperties | String | False |
Holds structured metadata about file-type assets, including file name, extension, size, and content type. These properties are generated automatically during upload and used to validate compatibility, enforce storage policies, and optimize asset delivery performance. | ||
| ForwardHtml | String | False |
Contains the HTML markup that is used for the 'Forward to a Friend' version of the asset. This version renders when a recipient forwards the message using the platform's forwarding feature. This field preserves layout, branding, and personalization tokens where permitted to maintain a consistent experience across email clients. | ||
| ForwardText | String | False |
Provides the plain-text equivalent of the 'Forward to a Friend' view. This version appears when a recipient's mail client or the forward flow supports text-only rendering. Including this view ensures accessibility and reliable delivery in environments that restrict HTML. | ||
| HtmlContent | String | False |
Contains the primary HTML that is used by the compiler to render the asset during message generation. This field can include layout elements, reusable blocks, and personalization tokens that resolve for each recipient. Maintaining valid, lightweight HTML improves rendering accuracy and deliverability. | ||
| HtmlSlots | String | False |
Defines named content regions, or slots, within the asset's HTML layout. Each slot acts as a placeholder where blocks or dynamic content can be inserted during authoring or send compilation. Well-defined slots standardize layouts while preserving design flexibility. | ||
| HtmlTemplate | String | False |
References the base HTML template that governs the asset's structure and styling. The template determines available slots, shared components, and default formatting. Using consistent templates enforces brand standards and accelerates campaign creation. | ||
| Preheader | String | False |
Stores the preheader text that appears beside or below the subject line in many inboxes. This short summary gives recipients additional context and encourages opens. The compiler evaluates this text at send time, and marketers can edit it in Content Builder. | ||
| SubjectLine | String | False |
Specifies the subject line used for an email asset. The subject line directly influences open rates and must accurately reflect message content. This field can include personalization tokens that resolve during send execution. | ||
| SubscriptionCenter | String | False |
Links the asset to an associated subscription-management experience. This connection enables recipients to manage preferences such as topics, frequency, and channels. Integrating assets with subscription centers supports compliance and reduces opt-out churn. | ||
| Text | String | False |
Holds the plain-text representation of the asset for recipients who use text-only mail clients or prefer simplified messages. This field conveys the same information as the HTML version and includes required compliance text. Providing both formats improves accessibility and deliverability. | ||
| ViewAsAWebPage | String | False |
Defines the configuration for the 'View as a Web Page' option in email assets. When this option is enabled, recipients can open the message in a browser to view a fully rendered version independent of client restrictions. This feature also aids troubleshooting and content review. | ||
| GenerateFrom | String | False |
Specifies which view or template the compiler should use to generate the final version of the asset. This field directs the system to resolve the appropriate slots and content blocks for the selected channel. Using the correct source view ensures consistent presentation across automations and triggered sends. | ||
| Slots | String | False |
Lists all content slots that are available within the asset. Each slot represents a defined region that can contain blocks or dynamic content during design. Establishing clear slot definitions provides structure and prevents layout errors. | ||
| Blocks | String | False |
Lists the content blocks that compose the asset. Blocks are reusable modules such as images, text, buttons, or dynamic content elements that are inserted into slots. Standardized blocks speed production and preserve brand consistency. | ||
| MinBlocks | Integer | False |
Specifies the minimum number of content blocks that are required for the asset to be considered complete. Authoring tools might enforce this rule to prevent incomplete designs and maintain layout integrity. | ||
| MaxBlocks | Integer | False |
Specifies the maximum number of blocks that the asset can contain. This limit prevents overloaded layouts, improves rendering performance, and ensures a balanced design across devices. | ||
| AllowedBlocks | String | False |
Lists the block types that are permitted within the asset. Restricting allowed blocks maintains technical compatibility and enforces creative guidelines. Validation occurs during authoring and send compilation to ensure compliance with design standards. | ||
| Template | String | False |
Identifies the template that defines the asset's foundational layout and default styling. Templates establish reusable frameworks that simplify localization and seasonal updates while maintaining visual consistency. | ||
| CustomFields | String | False |
Contains user-defined metadata fields that extend the standard asset schema. Custom fields capture workflow details, targeting notes, or reporting tags used during production. They appear in both the UI and APIs for automation and governance. | ||
| Data | String | False |
Stores a set of key-value pairs that represent dynamic asset data. These values can be accessed by AMPscript or personalization logic during message compilation. Maintaining concise, well-structured data improves performance and readability. | ||
| Channels | String | False |
Lists the delivery channels through which the asset can be used (for example, 'Email', 'SMS', 'Push', or 'Social'). Declaring supported channels guides validation and prevents use of incompatible assets. Clear channel assignment streamlines content discovery for multi-channel teams. | ||
| Version | Integer | True |
Tracks the sequential version number of the asset. Each increment represents a published or saved milestone that supports rollback and approval workflows. Version tracking provides transparent change history for audit and collaboration. | ||
| Locked | Boolean | False |
A Boolean field that returns a value of 'true' when the asset is locked to prevent edits or deletion, typically during approval, publication, or governance review. It returns a value of 'false' when the asset is open for modification. This state integrates with Content Builder approvals to safeguard approved content during campaigns. | ||
| Status | String | False |
Defines the current workflow state of the asset (for example, 'Draft', 'Approved', 'Published', or 'Archived'). Status determines whether the asset can be used in sends and whether additional approval is required before editing. Consistent status management improves operational visibility and compliance. | ||
| Tags | String | False |
Stores tags that are associated with the asset for filtering, search, and reporting. Tags help teams organize libraries by theme, campaign, or audience. Using standardized tags improves discoverability and reduces duplication. | ||
| BusinessUnitAvailability | String | False |
Contains a mapping of business-unit Ids (MIDs) that are authorized to access or use the asset. This field ensures that shared content remains visible yet protected from unauthorized modification. | ||
| SharingProperties | String | False |
Defines the configuration rules for sharing assets across business units that have Content Builder Sharing enabled. This field controls how those assets behave once they are shared, whether they replicated, synchronized, or linked as read-only copies. These settings maintain enterprise-wide content consistency while preserving source control. |
Manages event notification callbacks that are configured in Salesforce Marketing Cloud. A callback defines an endpoint that receives real-time notifications when specified system events occur, such as message delivery or data import completion. This table allows you to create, update, delete, and query callback definitions to automate event-driven workflows.
Select all callbacks:
SELECT * FROM Callbacks
Retrieve a specific callback:
SELECT * FROM Callbacks WHERE CallbackId = 94766
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')
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'
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'
| Name | Type | ReadOnly | References | Filters | Description |
| CallbackId [KEY] | String | False | = |
Identifies the unique string value that represents the event notification callback within Salesforce Marketing Cloud. This system-generated identifier (Id) is used to register, track, and manage callbacks that are defined for API event notifications. | |
| CallbackName | String | False |
Specifies the name that defines the event notification callback. This user-assigned label is used to identify callbacks in administrative views and API responses and helps distinguish multiple notification configurations that can exist within an account. | ||
| Url | String | False |
Defines the endpoint URL that the system calls when an event notification is triggered. This value must be a valid, reachable URL that receives HTTPS POST requests containing payload data for subscribed events. | ||
| MaxBatchSize | Integer | False |
Indicates the maximum number of event notifications that can be included in a single callback batch. This value controls the payload size for each delivery cycle and helps balance throughput against network performance. The system enforces this limit to optimize event dispatch efficiency. | ||
| Status | String | False |
Defines the current operational state of the event notification callback (for example, 'Active', 'Paused', or 'Disabled'). This field determines whether the callback is currently processing notifications or awaiting reactivation. Monitoring callback status helps ensure uninterrupted event delivery. | ||
| StatusReason | String | False |
Provides a descriptive reason that explains the callback's current status. This field records contextual information, such as error responses or administrative actions, that is used to diagnose callback issues or justify configuration changes. |
Maintains relationships between campaigns and their associated assets in Salesforce Marketing Cloud. Each record links campaign initiatives with digital assets such as email templates, images, or social media content. This table supports create, update, delete, and query operations for managing campaign resources effectively.
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'
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | Integer | True | = |
Identifies the unique record for each campaign asset in Salesforce Marketing Cloud. This system-generated identifier (Id) serves as the primary key that is used to reference the campaign asset in API calls, reporting, and campaign management workflows. | |
| CampaignId | Integer | True | = |
Stores the Id of the campaign with which that the asset is associated. This value links the asset to its parent campaign, allowing Marketing Cloud to group and report assets that contribute to a specific marketing initiative. It ensures data integrity and supports cross-channel campaign tracking. | |
| Type | String | False |
Specifies the classification or type of campaign asset (for example, 'Email', 'Landing Page', or 'Content Block'). This field determines how the asset is processed and displayed in campaign analytics and reporting dashboards. | ||
| ItemId | String | False |
Stores the internal object Id that represents the specific asset within Salesforce Marketing Cloud. This value links the campaign asset record to its source object, such as a Content Builder item or send definition, enabling end-to-end traceability between campaign components and asset instances. | ||
| CreatedDate | Datetime | False |
Records the exact date and time when the campaign asset was created. This timestamp is system-generated and used for audit trails, campaign versioning, and time-based analytics. It helps marketers track asset creation trends and manage campaign lifecycle events. |
Represents campaigns in Salesforce Marketing Cloud. Each campaign groups related marketing efforts and performance metrics under a single initiative. This table allows you to create, update, delete, and query campaigns to manage lifecycle stages, track engagement, and associate related assets or audiences.
Select all campaigns:
SELECT * FROM Campaigns
Retrieve a specific Campaign:
SELECT * FROM Campaigns WHERE Id = '3130'
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 operations are not supported for this table.
Campaigns may be deleted by providing the CampaignId of the campaign and issuing a DELETE statement.
DELETE FROM [Campaigns] WHERE Id = '5161'
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | Integer | True | = |
Identifies the unique record for each campaign in Salesforce Marketing Cloud. This system-generated identifier (Id) serves as the primary key that is used to reference the campaign in API calls, analytics, and campaign management workflows. It ensures data integrity and supports reporting relationships across assets, sends, and journeys. | |
| Name | String | False |
Specifies the name that identifies the campaign. This user-defined value appears in Marketing Cloud dashboards, reports, and automation interfaces. Maintaining a clear and consistent naming convention helps users quickly locate and organize campaigns across business units. | ||
| CampaignCode | String | False |
Stores the custom code that uniquely represents the campaign. This value can be used for cross-platform integration, analytics tracking, or external system synchronization. Campaign codes help align Marketing Cloud campaigns with third-party customer relationship management (CRM) or advertising identifiers. | ||
| Color | String | False |
Defines the hexadecimal or predefined color value that represents the campaign visually in the user interface. This color helps users differentiate campaigns quickly in dashboards and overview reports. | ||
| Favorite | Boolean | False |
A Boolean field that returns a value of 'true' when the campaign is marked as a favorite by the user. It returns a value of 'false' when it is not marked as a favorite. Marking a campaign as a favorite adds it to personalized quick-access lists within the user interface for faster navigation. | ||
| CreatedDate | Datetime | False |
Records the date and time when the campaign was first created. This system-generated timestamp supports audit tracking, campaign lifecycle management, and time-based reporting. It is immutable and reflects the campaign's original creation event. | ||
| ModifiedDate | Datetime | False |
Records the most recent date and time when the campaign was updated. This timestamp is automatically refreshed whenever campaign details or metadata are changed. It enables teams to track modification activity and identify recently edited campaigns. | ||
| Description | String | False |
Provides a summary that explains the purpose, scope, or target audience of the campaign. This field supports search, categorization, and collaboration by offering context for marketing goals and key initiatives within Salesforce Marketing Cloud. |
Stores category information (also known as folders) within Content Builder in Salesforce Marketing Cloud. Categories organize assets and content for easier navigation and management. This table allows you to create, update, delete, and query folder structures that help maintain a logical and accessible content hierarchy.
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
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')
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
Categories may be deleted by providing the Id of the category and issuing a DELETE statement.
DELETE FROM Categories WHERE Id = 94843
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | Integer | True | = |
Identifies the unique record for each category (folder) in Content Builder. This system-generated identifier (Id) is used to organize assets hierarchically and to link them to their parent or shared folders within Salesforce Marketing Cloud. | |
| Name | String | False |
Specifies the display name that identifies the category within Content Builder. This name appears in folder navigation, search filters, and sharing dialogs. Clear naming conventions improve asset discoverability and governance across business units. | ||
| ParentId | Integer | False | = |
Stores the Id of the parent category that contains the current folder. This value defines the folder hierarchy and supports inherited access permissions, breadcrumb navigation, and logical content organization within Content Builder. | |
| CategoryType | String | False |
Defines the type of category, which is automatically aligned with the category type of its parent folder. | ||
| EnterpriseId | Integer | False |
Identifies the enterprise-level business unit that owns the category. This Id links the folder to the root organization in an Enterprise 2.0 account and ensures that folder ownership and content visibility remain consistent across all subordinate business units. | ||
| MemberId | Integer | False |
Stores the Id of the member (business unit) that created the category. This field defines ownership at the business-unit level and determines who can modify, rename, or delete the folder. | ||
| SharedWith | String | False |
Lists up to 100 Marketing Cloud Member Ids (MIDs) that identify the business units with which the category is shared. To share the category with all business units in the enterprise, set this value to '0'. This option is available only if the account has access to Content Builder Across Enterprise Sharing. The SharedWith field cannot contain '0' and other MIDs simultaneously. Because shared categories reside in and are owned by the enterprise business unit, the enterprise MID should not be included in this list. | ||
| SharingType | String | False |
Indicates the level of permission granted to the business units that are listed in the SharedWith field. The allowed values are edit. | ||
| Description | String | False |
Provides a human-readable explanation of the category's purpose, contents, or usage context. Including a meaningful description improves folder searchability and helps maintain content governance across shared and private workspaces. |
Manages event definitions within Salesforce Marketing Cloud. An event definition specifies a trigger, such as a form submission or API call, that initiates an automated process like a journey entry or data update. This table allows you to create, delete, and query event definitions to orchestrate customer experiences.
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')
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)
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'
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | String | True | = |
Specifies the unique identifier (Id) that represents the event definition in Salesforce Marketing Cloud. This system-generated value is used to reference the event definition in Journey Builder, Event Administration, and API operations. | |
| Type | String | False |
Defines the type of the event definition. The event type determines how the event is initiated and processed within Journey Builder. The allowed values are Event, ContactEvent, DateEvent, RestEvent. | ||
| Name | String | False | Contains |
Specifies the name that identifies the event definition in Marketing Cloud. This name appears in Event Administration and Journey Builder interfaces and helps users distinguish among available event sources. | |
| CreatedDate | Datetime | True |
Records the date and time when the event definition was created. This timestamp is automatically assigned and supports audit tracking and historical reporting. | ||
| CreatedBy | Integer | True |
Specifies the Id of the user who created the event definition. This reference enables audit traceability and assists administrators in reviewing ownership or activity history. | ||
| ModifiedDate | Datetime | True |
Records the most recent date and time when the event definition was updated. This value updates automatically whenever any configuration property is changed. | ||
| ModifiedBy | Integer | True |
Specifies the Id of the user who last modified the event definition. This field helps track configuration updates for governance and compliance auditing. | ||
| Mode | String | False | = |
Defines the operational mode that determines how the event definition runs. Mode settings affect whether events are triggered manually, by schedule, or through API calls. The allowed values are Production, Test. The default value is Production. | |
| EventDefinitionKey | String | False |
Specifies the external key that uniquely identifies the event definition in Salesforce Marketing Cloud. This key must be unique and cannot contain special characters. It provides a stable reference across environments and API integrations. | ||
| DataExtensionId | String | False |
Specifies the Id of the data extension that is associated with the event. When an event is fired through the API, the system writes event data to this data extension. This parameter is required when no schema is provided. | ||
| DataExtensionName | String | False |
Displays the read-only name of the data extension that is associated with the event. This value helps users verify which data extension is linked to a specific event definition. | ||
| Description | String | False |
Provides a summary that describes the purpose or behavior of the event definition. Including a meaningful description improves discoverability and documentation accuracy across business units. | ||
| Schema | String | False |
Specifies the schema information that defines the structure of event data. When no data extension Id is provided, this schema is used to create the corresponding data extension automatically. This property ensures that incoming event data conforms to the expected format. | ||
| SendableCustomObjectField | String | False |
Defines the field within the associated data extension that stores the subscriber key or email address. This value is required when defining a schema and enables message sends and contact association. | ||
| SendableSubscriberField | String | False |
Indicates the type of subscriber field that the event definition uses to identify recipients. This field is required when defining a schema to ensure proper linkage between contact records and event data. | ||
| Schedule | String | False |
Defines the scheduling information for an event-driven automation that runs daily according to the specified timing. When a schedule is configured, the system automatically creates a Fire Event activity in Automation Studio that triggers events from the associated data extension. | ||
| FilterDefinitionId | String | False |
Specifies the Id of the filter definition that applies to the event. Filter definitions allow targeted event processing by limiting the scope of contacts that qualify for triggering. | ||
| FilterDefinitionTemplate | String | False |
Specifies the template that is used to create or apply a filter definition for the event. Templates help standardize segmentation logic across event definitions. | ||
| IconUrl | String | False |
Specifies the URL of the icon that represents the event definition in Event Administration and the Journey Builder Canvas. The icon provides a visual cue that helps users recognize the event type quickly. | ||
| Arguments | String | False |
Contains filter criteria that define how the event data is evaluated before triggering. | ||
| Configuration | String | False |
Specifies additional configuration data for the event. | ||
| ConfigurationArguments | String | False |
Defines the set of arguments that configure how the event definition executes. These arguments can include dynamic parameters, mappings, or service endpoints used during event processing. | ||
| Metadata | String | False |
Contains optional metadata that describes the event and its configuration properties. This parameter is typically used for event types other than 'Event' to store descriptive or operational information that supplements the definition. | ||
| InteractionCount | Integer | False |
Records the total number of interactions that are associated with the event definition. This value provides insight into event usage and frequency within Journey Builder. | ||
| IsVisibleInPicker | Boolean | False |
A Boolean field that returns a value of 'true' when the event definition is visible in the Event Picker for use in Journey Builder configuration. It returns a value of 'false' when the event is hidden or reserved for system use. The default value is true. | ||
| Category | String | False |
Specifies the general category or classification of the event type. Categories help group events by function or source for easier discovery and filtering in administrative tools. The default value is event. | ||
| PublishedInteractionCount | Integer | False |
Records the number of published interactions that use the event definition. This value helps determine the event's adoption and deployment within live journeys. | ||
| AutomationId | String | False |
Specifies the Id of the automation that is linked to the event definition. This reference connects the event configuration to its corresponding Automation Studio workflow. |
Defines properties for Facebook Messenger integrations in Salesforce Marketing Cloud. These properties control how messages are formatted, delivered, and tracked within Facebook channels. This table allows you to query existing properties or create new configurations to manage social messaging campaigns.
Retrieve all registred facebook messenger properties:
SELECT * FROM FacebookMessengerProperties
Retrieve a specific registred facebook messenger property:
SELECT * FROM FacebookMessengerProperties WHERE PageId = '1732555047025799'
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')
| Name | Type | ReadOnly | References | Filters | Description |
| PageId [KEY] | String | False | = |
Specifies the unique identifier (Id) of the Facebook Page that is connected to the Messenger property. This identifier allows Salesforce Marketing Cloud to associate outgoing messages and incoming events with the correct Facebook Page. | |
| ApplicationId | String | False |
Specifies the Facebook Application Id that is registered for use with the Messenger integration. This value links the Salesforce Marketing Cloud account to a specific Facebook Application configuration for API authentication and message delivery. | ||
| ApplicationSecret | String | False |
Specifies the Facebook application secret key that is used with the ApplicationId value to authenticate API requests. This value should be stored securely because it grants access to the associated Facebook App and its Messenger permissions. | ||
| PageName | String | False |
Specifies the name of the Facebook page that is connected to the Messenger property. This name appears in user-facing interfaces and helps identify the origin of messages within Salesforce Marketing Cloud. | ||
| PageAccessToken | String | False |
Specifies the access token that is required to authenticate message send requests to the Facebook Graph API. This token allows Salesforce Marketing Cloud to post messages, retrieve replies, and handle event callbacks for the connected page. | ||
| CallbackVerifyToken | String | False |
Specifies the verification token that Facebook uses to validate webhook callbacks. This token ensures that incoming callback events originate from Facebook and have not been tampered with. | ||
| EndpointUrl | String | False |
Specifies the Send API endpoint URL of the Facebook network. Salesforce Marketing Cloud uses this URL to deliver outbound messages and event notifications through the Facebook Graph API. | ||
| IsActive | Boolean | False |
A Boolean field that returns a value of 'true' when the Facebook Messenger property is active and available for use. It returns a value of 'false' when the property is disabled, expired, or not linked to a valid page. | ||
| ApiVersion | String | False |
Specifies the Facebook Graph API version that is used for the Messenger integration. This version determines available endpoints, authentication behavior, and compatibility with Facebook's latest messaging features. |
Contains details about journey activities in Salesforce Marketing Cloud. A journey activity represents an action or decision point in a customer journey, such as sending an email or evaluating a contact attribute. This table allows you to create, update, and query journey activities to refine automation workflows.
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
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": ""
}')
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
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | String | True |
Specifies the unique identifier (Id) that Marketing Cloud assigns to the activity. This Id links the activity to its corresponding configuration within Journey Builder. | ||
| JourneyId [KEY] | String | True |
Journeys.Id | = |
Specifies the unique Id of the journey that contains this activity. This Id is generated by the Journey Builder API when the journey is created and ensures that the activity is associated with the correct journey record. |
| JourneyVersion [KEY] | Integer | True |
Journeys.Version | = |
Specifies the version number of the journey that contains this activity. Each version represents a published or edited state of the journey and helps distinguish activity behavior across iterations. |
| Key | String | False |
Specifies the customer key that uniquely identifies the activity within the journey. This key remains stable across edits and is used for API calls, configuration storage, and journey versioning. | ||
| Name | String | False |
Specifies the display name of the activity as shown in the Journey Builder user interface. This name helps users identify the purpose or function of the activity during journey design. | ||
| Description | String | False |
Specifies the descriptive text that explains the purpose or behavior of the activity. This description provides context to users who configure or troubleshoot the journey. | ||
| Type | String | False |
Specifies the activity type (for example, email activity, wait activity, event activity, or decision activity). Each activity type expects specific inputs that must be provided for the activity to run correctly within the journey. | ||
| Outcomes | String | False |
Specifies the JSON array that defines the available outcomes for the activity. Outcomes determine the paths a contact can follow after the activity executes (for example, success, failure, or custom-defined branching results). | ||
| Arguments | String | False |
Specifies the set of arguments that the activity requires at runtime. These arguments define operational behavior (for example, message payloads, wait durations, filter conditions, or event-mapped values). Each activity type requires its own argument structure. | ||
| ConfigurationArguments | String | False |
Specifies the arguments that the activity uses during both publish time and runtime. These arguments define configuration values, mappings, or settings that must remain consistent across journey versions for the activity to execute correctly. |
Represents customer journeys in Salesforce Marketing Cloud. A journey defines an automated, multi-step process that guides contacts through personalized interactions across channels. This table allows you to create, update, delete, and query journey definitions to manage audience engagement strategies.
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
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')
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
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
| Name | Type | ReadOnly | References | Filters | Description |
| Id [KEY] | String | True | = |
Specifies the unique identifier (Id) that Marketing Cloud generates for the journey when it is created. This Id is used to reference, query, and manage the journey across Journey Builder and API operations. | |
| Version | Integer | True | = |
Specifies the version number of the journey. Each time the journey is republished, Marketing Cloud increments this value to represent the updated iteration. | |
| Key | String | False |
Specifies the customer key that uniquely identifies the journey within the business unit. This key is user-defined and remains stable across journey versions. | ||
| Name | String | False |
Specifies the display name of the journey as shown in Journey Builder. Users see this name when configuring, publishing, or monitoring journeys across the Salesforce Marketing Cloud account. | ||
| Status | String | False | = |
Specifies the current publishing or execution status of the journey. This field helps filter journeys by their operational state. The allowed values are Draft, Published, ScheduledToPublish, Stopped, Unpublished, Deleted. | |
| CreatedDate | Datetime | True |
Specifies the date and time when the journey was originally created in Journey Builder. This timestamp reflects the initial creation event. | ||
| ModifiedDate | Datetime | True |
Specifies the date and time when the journey was last modified. This timestamp reflects any change to content, structure, configuration, or settings. | ||
| LastPublishedDate | Datetime | True |
Specifies the date and time when the journey was most recently published. This value is used to track deployment events and determine when updates were released. | ||
| Description | String | False |
Specifies a descriptive summary of the journey that explains its business purpose, target audience, or automation objective. This description helps teams understand how and why the journey operates. | ||
| WorkFlowApiVersion | Double | False | = |
Specifies the version of the Journey Builder workflow API that governs the execution logic for the journey. This version determines the available features and processing behaviors. The default value is 1. | |
| Tags | String | False |
Specifies the collection of tags that are assigned to the journey to support organization, filtering, and categorization within Journey Builder and API queries. | ||
| Goals | String | False |
Specifies the goals that are associated with the journey. Goals define the success criteria that Salesforce Marketing Cloud evaluates during execution to determine when a contact has completed the journey. | ||
| Triggers | String | False |
Specifies the trigger configuration for the journey, including the entry source that determines how contacts enter the workflow. Trigger details vary by entry type (for example, event, data extension, or API entry). | ||
| Defaults | String | False |
Specifies the ordered list of email address expressions that Journey Builder evaluates to determine which address should be used as the default sender or recipient context for applicable activities. | ||
| DefinitionId | String | True |
Specifies the Id of the journey definition that governs the structure, configuration, and publishable form of the journey. This Id links execution logic to the underlying definition. |
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 |
Specifies whether the query should return only the most recent version of each matching journey. The value is 'true' when limiting results to the latest version and 'false' when including all versions. The default value is true. |
| Tag | String |
Specifies a single tag to apply as a filter when retrieving journeys. The query returns only journeys that are associated with the specified tag. |
| NameOrDescription | String |
Specifies a search string used to filter journeys by matching the provided text against the Name or Description fields. |
The table that defines configuration properties for LINE messenger integrations in Salesforce Marketing Cloud. These properties determine how messages are delivered and tracked within LINE communication channels. This table allows you to query and create properties to support messaging automation for the LINE platform.
Retrieve all registred line messenger properties:
SELECT * FROM LineMessengerProperties
Retrieve a specific registred line messenger property:
SELECT * FROM LineMessengerProperties WHERE ID = '23493453984234345'
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')");
| Name | Type | ReadOnly | References | Filters | Description |
| ChannelId [KEY] | String | False | = |
Specifies the unique identifier (Id) of the LINE Messenger property. This Id corresponds to the LINE channel configured in Salesforce Marketing Cloud and is required for authentication and message routing. | |
| ChannelName | String | False |
Specifies the name of the LINE channel. This value matches the channel name configured in the LINE Developer Console and helps identify the messaging source within Salesforce Marketing Cloud. | ||
| ChannelSecret | String | False |
Specifies the LINE channel secret that is required to authenticate requests between Salesforce Marketing Cloud and the LINE platform. This value validates that calls originate from a trusted integration. | ||
| CustomerConnectSecret | String | False |
Specifies the LINE Customer Connect secret that validates inbound events sent through the Switcher API. This secret ensures that messages, replies, and webhook events originate from LINE and have not been tampered with. | ||
| IsTransactional | Boolean | False |
Specifies whether the LINE channel is classified as transactional or reseller. A value of 'true' designates a transactional channel that is used for direct customer messaging, and a value of 'false' designates reseller channel behavior. | ||
| IsTestChannel | Boolean | False |
Specifies whether the LINE channel is configured as a test channel. A value of 'true' indicates a sandbox or non-production configuration, and a value of 'false' indicates a live messaging channel. | ||
| EndpointUrl | String | False |
Specifies the LINE Send API URL that Salesforce Marketing Cloud uses to transmit outbound messages. The endpoint determines where message payloads are delivered for processing by LINE. | ||
| IsActive | Boolean | False |
Specifies whether the LINE Messenger resource is currently active. A value of 'true' indicates that the channel is enabled for messaging operations, and a value of 'false' indicates that the channel is disabled or not fully configured. | ||
| ApiVersion | String | False |
Specifies the version of the Open Traceability Transport (OTT) API that applies to the LINE Messenger property. This version determines the supported message formats and API capabilities. |
Stores send definitions in Salesforce Marketing Cloud. A send definition specifies the parameters for email, Short Message Service (SMS), or push sends, including target audiences, content, and delivery options. This table allows you to create, update, delete, and query send definitions to manage outbound communication workflows.
Retrieve all send definitions:
SELECT * FROM SendDefinitions
Retrieve a specific send definition:
SELECT * FROM SendDefinitions WHERE DefinitionKey = '9955614b-02e7-4147-91a2-3f5f5fe9d679'
Retrieve all send definitions with Status as 'Active':
SELECT * FROM SendDefinitions WHERE Status = 'Active'
To create a send definition, you will need to specify at least the DefinitionKey, Name, SubscriptionsList and ContentCustomerKey column.
INSERT INTO SendDefinitions (DefinitionKey, Name, ContentCustomerKey, SubscriptionsList, OptionsCc, OptionsCreateJourney) VALUES ('TEST_Definition_Key', 'Test Definition Key', '76ad3572-abbc-4baa-b3fe-04c4364bf34a', 'All Subscribers', '[email protected]', true)
To update a send definition, you will need to specify the DefinitionKey of the SendDefinition.
UPDATE SendDefinitions SET OptionsCc = '[email protected],[email protected]', OptionsBcc = '[email protected],[email protected]' WHERE DefinitionKey = 'TEST_Definition_Key'
Send definitions may be deleted by providing the Definition Key of the send definition and issuing a DELETE statement.
DELETE FROM SendDefinitions WHERE DefinitionKey = 'TEST_Definition_Key'
| Name | Type | ReadOnly | References | Filters | Description |
| DefinitionKey [KEY] | String | False | = |
Specifies the unique, user-generated key that identifies the send definition. This key is used to reference the definition programmatically and remains stable across edits. | |
| DefinitionId | String | True |
Specifies the unique identifier (Id) that Salesforce Marketing Cloud assigns to the send definition. This Id is used internally to manage, retrieve, and execute the definition. | ||
| Classification | String | False |
Specifies the external key of the sending classification that is defined in Email Studio Administration. Only transactional classifications are permitted for this object. The default value is the system's transactional classification. | ||
| ContentCustomerKey | String | False |
Specifies the unique key of the content asset that is associated with the send definition. This key identifies the email asset that is used when the definition executes. | ||
| CreatedDate | Datetime | True |
Specifies the date and time when the send definition was created in Salesforce Marketing Cloud. | ||
| Description | String | False |
Specifies the user-provided description that explains the purpose or intended use of the send definition. | ||
| Journey | Boolean | True |
Specifies whether the send definition is available in Journey Builder as a transactional send journey. A value of 'true' enables the definition for journey-based triggering. | ||
| JourneyInteractionKey | String | True |
Specifies the unique Id of the transactional send journey that is associated with the definition. This Id links the definition to the journey that triggers it. | ||
| ModifiedDate | Datetime | True |
Specifies the date and time when the send definition was most recently modified. | ||
| Name | String | False |
Specifies the name of the send definition as displayed in Email Studio and through API queries. | ||
| OptionsBcc | String | False |
Specifies one or more email addresses to receive blind carbon copies (BCC) for every send. To dynamically populate BCC addresses at send time, create a profile attribute and reference it using the %%attribute%% syntax. | ||
| OptionsCc | String | False |
Specifies one or more email addresses to receive carbon copies (CC) for every send. To dynamically populate CC addresses at send time, create a profile attribute and reference it using the %%attribute%% syntax. | ||
| OptionsTrackLinks | Boolean | False |
Specifies whether Salesforce Marketing Cloud should wrap hyperlinks for click tracking and reporting. The default value is 'true'. | ||
| OptionsCreateJourney | Boolean | False |
Specifies whether the system should create the underlying journey configuration when defining sendable schema fields such as subscriber key or email address. This setting is required only when schema information must be defined or validated. | ||
| RequestId | String | True |
Specifies the unique Id of the request that performed the most recent operation on the send definition. | ||
| Status | String | False | =,!= |
Specifies the operational state of the send definition (for example, active, inactive, or deleted). Messages submitted to an active definition are processed and delivered. Messages submitted to an inactive definition are not processed and are instead queued for up to three days for possible reactivation. | |
| SubscriptionsAutoAddSubscriber | Boolean | False |
Specifies whether the system should automatically add the recipient's email address and contact key to the system-managed subscriber list that stores subscriber keys and profile attributes. The default value is 'true'. | ||
| SubscriptionsDataExtension | String | False |
Specifies the external key of the triggered send data extension. Each triggered request inserts a new row into this data extension with relevant message and subscriber details. | ||
| SubscriptionsList | String | False |
Specifies the external key of the list or All Subscribers context in which subscriber keys and profile attributes are stored. This list is used as a repository for subscription and profile data related to the send. | ||
| SubscriptionsUpdateSubscriber | Boolean | False |
Specifies whether the system should update the recipient's subscriber key with the provided email address and profile attributes in subscriptions.list. This setting applies to email messages only. The default value is 'true'. |
Manages event notification subscriptions within Salesforce Marketing Cloud. A subscription defines which events are monitored and where notifications are sent. This table allows you to create, update, delete, and query event subscriptions to support custom automation and data integration processes.
Select all subscriptions:
SELECT * FROM Subscriptions
Retrieve a specific subscription:
SELECT * FROM Subscriptions WHERE SubscriptionId = 94766
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\"]')
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'
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'
| Name | Type | ReadOnly | References | Filters | Description |
| SubscriptionId [KEY] | String | False | = |
Specifies the unique identifier (Id) of the event notification subscription. This Id links the subscription to the callback configuration that processes event notifications. | |
| SubscriptionName | String | False |
Specifies the name of the event notification subscription. This value helps identify the subscription within Salesforce Marketing Cloud and through API queries. | ||
| CallbackId | String | False |
Callbacks.CallbackId | = |
Specifies the Id of the event notification callback that the subscription uses to deliver event data. The callback determines where and how event notifications are sent. |
| CallbackName | String | False |
Specifies the name of the event notification callback associated with the subscription. This value helps distinguish among multiple callbacks that can exist in the account. | ||
| EventCategoryTypes | String | False |
Specifies the event category types that the subscription monitors. These types determine which Salesforce Marketing Cloud events (for example, sends, opens, clicks, or bounces) are forwarded to the callback. | ||
| Filters | String | False |
Specifies the filters that limit which events are included in the subscription. Filters can restrict events by category, source, or other attributes to control which notifications are sent. | ||
| Url | String | False |
Specifies the URL endpoint that receives the event notifications from the callback. The system posts event data to this address according to the subscription's configuration. | ||
| MaxBatchSize | Integer | False |
Specifies the maximum number of event records that the system includes in a single callback request. This value controls batching behavior for event delivery. | ||
| Status | String | False |
Specifies the operational status of the event notification callbac (for example, active, inactive, or error). This status determines whether event notifications are currently being sent. | ||
| StatusReason | String | False |
Specifies the reason associated with the callback's current status. This value can include diagnostic information or system notes explaining why the callback is active, inactive, or in an error state. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| AssetTypes | Returns the available asset types configured in Salesforce Marketing Cloud. Each asset type defines the structure, behavior, and rendering rules for specific types of content elements, such as templates, blocks, or layouts. This view is useful for identifying supported asset formats when creating or managing digital content. |
| Contact | Retrieves detailed information for a specific contact in Salesforce Marketing Cloud. A contact represents an individual subscriber or customer who interacts with your marketing campaigns. This view provides insights into contact attributes, engagement status, and associated data extensions. |
| Contacts | Retrieves a comprehensive list of all contacts in Salesforce Marketing Cloud. Each contact represents a unique individual with associated communication preferences and subscription data. This view is used to review or export contact records for segmentation, personalization, or compliance reporting. |
| JourneyAuditLogs | Returns audit logs for journeys and their versions in Salesforce Marketing Cloud. Each record captures configuration changes, version updates, or execution details that provide transparency and traceability for journey management. This view supports compliance and debugging by tracking historical activity. |
| JourneyHistory | Retrieves the historical execution records of customer journeys in Salesforce Marketing Cloud. Each record reflects the runtime status, performance, and event details of a specific journey instance. Record retrieval is subject to a maximum file size of 1 GB to ensure performance and stability during data access. |
| MobileApplications | Returns the list of mobile applications (apps) configured in a Salesforce Marketing Cloud account. Each mobile app record identifies applications that are used for push notifications or in-app messages. This view helps administrators manage mobile channels and confirm that app credentials and configurations are current. |
| SmsStatusCodes | Returns Short Message Service (SMS) status codes recognized by Salesforce Marketing Cloud. Each status code represents a specific state of message delivery, such as pending, delivered, or failed. This view is useful for monitoring message outcomes and troubleshooting SMS communication issues. |
| TransactionalMessages | Retrieves a paginated list of transactional messages that are not successfully sent in Salesforce Marketing Cloud. Results are ordered from the oldest to the newest message. This view provides visibility into message delivery issues and supports troubleshooting for transactional send processes. |
Returns the available asset types configured in Salesforce Marketing Cloud. Each asset type defines the structure, behavior, and rendering rules for specific types of content elements, such as templates, blocks, or layouts. This view is useful for identifying supported asset formats when creating or managing digital content.
Retrieve all asset types:
SELECT * FROM AssetTypes
| Name | Type | References | Description |
| Id [KEY] | Integer |
Assets.TypeId | Identifies the unique record for each asset type in Salesforce Marketing Cloud. This system-generated identifier (Id) serves as the primary key that is used to reference the asset type in API calls, relationship mappings, and configuration metadata. |
| Name | String | Specifies the display name that defines the asset type. This user-readable name (for example, such as 'Email Template', 'Image', or 'Content Block') appears in the Content Builder and API results and helps developers and marketers distinguish among asset categories. | |
| IsBaseAssetType | Boolean | A Boolean field that returns a value of 'true' when the asset type represents a foundational base type that other asset types inherit from. It returns a value of 'false' when the asset type is derived from or extends another type. | |
| ParentId | Integer | Stores the Id of the parent asset type from which the current asset type is derived. This reference establishes inheritance relationships between asset types and supports type-based categorization, allowing complex content structures to share common properties and rendering behaviors. |
Retrieves detailed information for a specific contact in Salesforce Marketing Cloud. A contact represents an individual subscriber or customer who interacts with your marketing campaigns. This view provides insights into contact attributes, engagement status, and associated data extensions.
Retrieve all contacts:
SELECT * FROM ContactNote: 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.
| Name | Type | References | Description |
| ContactID [KEY] | Int | Identifies the system-defined identifier (Id) that uniquely represents the contact within Salesforce Marketing Cloud. This Id is automatically generated when the contact record is created and remains immutable across all channels and data extensions. It serves as the master reference for contact relationships, event tracking, and subscription management within the Contact Builder module. | |
| ContactKey | String | Specifies the user-defined Id that is assigned to the contact. This value acts as a cross-channel key that links contact records across email, mobile, and other customer engagement data sources. Maintaining a consistent contact key ensures that profile attributes, preferences, and engagement history are accurately unified within the contact model. |
Retrieves a comprehensive list of all contacts in Salesforce Marketing Cloud. Each contact represents a unique individual with associated communication preferences and subscription data. This view is used to review or export contact records for segmentation, personalization, or compliance reporting.
Retrieve all contacts:
SELECT * FROM ContactsNote: 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.
| Name | Type | References | Description |
| GroupConnect LINE Demographics.Address ID | String | Stores the unique identifier (Id) that represents the physical or account-level address that is associated with a LINE contact in the GroupConnect field. This Id links demographic details with the contact's LINE profile and is used to support localized targeting and message delivery. | |
| GroupConnect LINE Demographics.Contact ID | Long | Specifies the system-defined Id that uniquely represents the contact within GroupConnect for LINE. This value enables Salesforce Marketing Cloud to associate LINE message interactions and subscription preferences with the unified contact profile in Contact Builder. | |
| GroupConnect LINE Demographics.Contact Key | String | Specifies the user-defined contact key that links the LINE contact to the unified customer record in Contact Builder. Maintaining a consistent contact key across channels ensures that LINE activity, preferences, and subscription status are reflected accurately in cross-channel reports. | |
| Contact.Contact ID [KEY] | Int | Specifies the system-defined Id that uniquely represents the contact in Salesforce Marketing Cloud. This identifier is automatically generated when the contact is created and provides the primary linkage point for all contact data extensions and engagement activities. | |
| Contact.Contact Key | String | Specifies the user-defined contact key that is assigned to the contact record. This key acts as the cross-channel Id that is used to unify profile data and behavioral tracking across Email, MobileConnect, MobilePush, and GroupConnect interactions. | |
| Email Demographics.Contacts ID | Long | Specifies the system-defined Id that represents the contact within the Email Demographics data set. This Id links each contact to their email send, open, and click activities that are tracked for personalization and reporting. | |
| Email Demographics.NewAttrTest | String | Represents a test attribute that is used for validating new or custom demographic fields in Email Demographics. This column serves as an example or placeholder for custom attributes that are added during development or data model extension testing. | |
| Email Demographics.NewAttrTest1 | String | Represents a secondary test attribute that demonstrates how additional demographic fields can be incorporated into the Email Demographics data set. It allows users to verify schema mapping and integration logic. | |
| Email Demographics.NewAttrTest 2 | String | Represents a tertiary test attribute that is used for evaluating new attribute behavior and ensuring compatibility with email segmentation or personalization logic. | |
| Email Demographics.tet | String | Represents a temporary test column that is used for data validation or sandbox testing purposes in the Email Demographics data extension. | |
| Email Addresses.Email Address | String | Stores the primary email address that is associated with the contact record. This value is used for message delivery, subscription management, and identity resolution across Marketing Cloud email activities. | |
| Email Addresses.HTML Enabled | Bool | A Boolean field that returns a value of 'true' when the contact prefers to receive HTML-formatted emails. It returns a value of 'false' when the contact prefers plain-text messages. This preference is referenced during message compilation to determine which version of an email to send. | |
| MobileConnect Demographics.Contact ID | Long | Specifies the system-defined Id that uniquely represents the contact within the MobileConnect Demographics data set. This identifier links Short Message Service (SMS) activity, opt-in status, and message response data to the unified contact record. | |
| MobileConnect Demographics.Locale | String | Specifies the language or regional setting that is associated with the contact's MobileConnect profile. Locale data supports personalized SMS messaging and compliance with local language requirements. | |
| MobileConnect Demographics.Mobile Number | String | Stores the mobile phone number that is associated with the contact's MobileConnect profile. This number is validated during opt-in workflows and is used for message targeting, delivery tracking, and compliance reporting. | |
| MobilePush Demographics.Application | String | Specifies the mobile application that is registered with Salesforce Marketing Cloud MobilePush and linked to the contact. This value identifies which application instance is used for push notifications and supports segmentation by application or platform. | |
| MobilePush Demographics.Contact ID | Long | Specifies the system-defined Id that represents the contact within the MobilePush Demographics data set. This Id links push notification activity and subscription status to the unified contact profile. | |
| MobilePush Demographics.Device ID | String | Stores the unique Id of the mobile device that is registered for receiving push notifications. This value supports device-level targeting, frequency capping, and troubleshooting for mobile engagement campaigns. | |
| Contact.Business Unit ID | Int | Specifies the business unit Id that defines the organizational context for the contact record. This field determines which business unit owns or manages the contact's data and permissions within the enterprise hierarchy. | |
| Email Addresses.Member ID | Int | Stores the Marketing Cloud Member Id (MID) that identifies the business unit responsible for managing the contact's email address and associated subscription data. This linkage ensures that opt-in preferences are properly enforced within each unit. | |
| Email Addresses.List ID | Int | Specifies the list identifier (Id) that represents the subscriber list or audience segment that includes the contact's email address. This value is used to associate the contact with specific mailing lists and supports list-level subscription management. |
Returns audit logs for journeys and their versions in Salesforce Marketing Cloud. Each record captures configuration changes, version updates, or execution details that provide transparency and traceability for journey management. This view supports compliance and debugging by tracking historical activity.
| Name | Type | References | Description |
| JourneyId | String |
Journeys.Id | Specifies the unique identifier (Id) of the journey for which audit activity is recorded. This Id is generated by the Journey Builder API when the journey is created. |
| JourneyVersion | Integer |
Journeys.Version | Specifies the version number of the journey at the time the audited action occurred. Each version represents a specific published or edited state of the journey. |
| Key | String | Specifies the customer key that uniquely identifies the journey within the business unit. This key provides a stable reference across versions and API interactions. | |
| Action | String | Specifies the action that was recorded in the audit log (for example, creating, editing, publishing, pausing, or stopping the journey).
The allowed values are all, create, modify, publish, unpublish, delete. The default value is all. | |
| Name | String | Specifies the display name of the journey at the time of the audited action. This name appears in the Journey Builder user interface and helps identify the journey's purpose during review. | |
| Description | String | Specifies the descriptive text that explains the purpose or function of the journey. This description can assist administrators during audit reviews or change-history analysis. | |
| ActionDate | Datetime | Specifies the date and time when the audited action occurred. This timestamp enables chronological tracking of journey changes and operations. | |
| UserId | Integer | Specifies the Id of the user who performed the audited action. This information supports administrative reviews and compliance reporting. | |
| UserName | String | Specifies the name of the user who performed the audited action. This value helps identify the origin of configuration changes or operational events. | |
| ExecutionMode | String | Specifies the execution mode in which the journey was running at the time of the action (for example, test mode or standard execution). The mode affects how Journey Builder processes contacts and evaluates activities. | |
| OriginalDefinitionId | String | Specifies the Id of the original journey definition from which the current version was derived. This value helps establish lineage across journey versions. | |
| PublishRequestId | String | Specifies the Id of the publish request that initiated the journey's publication process. This Id can be used to correlate publication events with corresponding audit records. | |
| PublishStatus | String | Specifies the publication status of the journey at the time of the audited action (for example, pending, publishing, published, or error). | |
| Errors | String | Specifies any errors that occurred during the audited action. These details help diagnose configuration or publication issues. | |
| ContactsEjected | String | Specifies the list of contacts that were ejected when the journey was stopped. This information provides traceability for contact paths that were terminated due to administrative actions. |
Retrieves the historical execution records of customer journeys in Salesforce Marketing Cloud. Each record reflects the runtime status, performance, and event details of a specific journey instance. Record retrieval is subject to a maximum file size of 1 GB to ensure performance and stability during data access.
Retrieves information about a specific contact, journey, or journey version:
SELECT * FROM JourneyHistory
Retrieves information about a specific contact, journey, or journey version within the specified date range.:
SELECT * FROM JourneyHistory where StartDate='2022-09-01T10:29:22.438Z' and EndDate = '2022-09-30T11:29:22.438Z'
NOTE: A maximum of 10k records can be retrieved using JourneyHistory. If only StartDate is mentioned, it will retrieve a maximum of 10k records from the StartDate. If both StartDate and EndDate are mentioned, it will fetch the first 10k records.
| Name | Type | References | Description |
| Id | String | Specifies the unique identifier (Id) of the journey history record. This Id is generated by the Journey Builder API when the journey begins processing contacts and is used to track execution details for the associated run. | |
| ActivityId | String | Specifies the unique Id of the activity that the history record pertains to. This Id links the execution data to a specific activity within the journey version. | |
| ActivityName | String | Specifies the name of the activity that is associated with the history record. This name helps identify the action or function performed during contact processing. | |
| ActivityType | String | Specifies the type of activity that generated the history entry (for example, a message activity, event activity, wait activity, or decision activity). | |
| ClientStatus | String | Specifies the client-facing status of the activity execution, indicating how the system interpreted the activity outcome during processing. | |
| ContactKey | String | Specifies the customer key that identifies the contact being processed in the journey. This key ensures that the history record is associated with the correct individual within the business unit. | |
| CreatedDate | Datetime | Specifies the date and time when the journey entered its running state for the associated contact or activity. This timestamp provides the starting point for evaluating the execution timeline. | |
| DefinitionId | String | Specifies the Id of the journey definition that governs the activity being executed. This Id identifies the parent definition that underlies the version and structure of the journey. | |
| DefinitionInstanceId | String | Specifies the Id of the journey definition instance that executed the activity. This instance Id represents the specific published version of the journey used during processing. | |
| DefinitionName | String | Specifies the name of the journey definition that is associated with the execution record. This value helps identify the overarching journey that produced the history entry. | |
| EndDate | Datetime | Specifies the date and time when the activity execution completed. This timestamp marks the end of the processing window for the activity. | |
| EntrySource | String | Specifies the entry source that admitted the contact into the journey (for example, an event, data extension entry, or API entry call). | |
| EpochTimeInMilliseconds | Long | Specifies the timestamp of the activity execution that is expressed as epoch time in milliseconds. This value provides a standardized format for time-based calculations and comparisons. | |
| EventId | String | Specifies the Id of the event that triggered the activity or contributed to the execution context for the history record. | |
| EventName | String | Specifies the name of the event that influenced the execution of the activity. This value is used to identify the event source within the journey. | |
| LongId | String | Specifies the extended Id that represents the execution instance in long-format identifier form. This value allows for precise correlation across systems that require long Id formats. | |
| Mid | String | Specifies the Marketing Cloud member Id (MID) of the business unit in which the journey executed. This value provides organizational context for the history record. | |
| Message | String | Specifies the message or descriptive text that is associated with the activity execution. This message can include diagnostic information, event details, or system-generated notes. | |
| OutcomeActivityId | String | Specifies the Id of the activity that represents the outcome of the executed step. This Id identifies the next activity selected by the journey based on evaluation results. | |
| ResultMessages | String | Specifies the messages that describe the execution results of the activity. These messages can provide operational details or context for success, failure, or branching behavior. | |
| ResultOutcomes | String | Specifies the outcome values that are returned during activity execution. These values determine how contacts proceed to the next activity or exit the journey. | |
| ResultStatus | String | Specifies the status of the activity execution (for example, success, failure, or a system-defined result state). This status helps assess processing performance or identify issues. | |
| ResultTags | String | Specifies the tags that are associated with the activity execution. Tags can provide metadata or classification details used for reporting or debugging. | |
| SourceType | String | Specifies the source type that generated the history entry (for example, an API-driven event, an automation-triggered event, or a system-based action). | |
| StartDate | Datetime | Specifies the date and time when the activity execution started. This timestamp marks the beginning of the execution interval for the associated activity. | |
| Status | String | Specifies the overall status of the journey history record, indicating whether the activity or contact path is pending, running, paused, completed, or terminated. | |
| TransactionTime | Datetime | Specifies the timestamp of the transaction that recorded the history entry. This value provides a precise reference point for chronological sorting and auditing. |
Returns the list of mobile applications (apps) configured in a Salesforce Marketing Cloud account. Each mobile app record identifies applications that are used for push notifications or in-app messages. This view helps administrators manage mobile channels and confirm that app credentials and configurations are current.
| Name | Type | References | Description |
| ApplicationId [KEY] | String | Specifies the unique identifier (Id) of the MobilePush application. This Id is generated by MobilePush and is required when sending notifications, retrieving configuration details, or managing the application through the API. | |
| Name | String | Specifies the name that is assigned to MobilePush. This value appears in MobilePush configuration screens and helps users distinguish between different applications across platforms or environments. | |
| Description | String | Specifies the descriptive text that explains the purpose or function of MobilePush. This description is often used for internal documentation and administrative clarity. | |
| CreatedDate | Datetime | Specifies the date and time when the MobilePush application was created. This timestamp records its initial provisioning within Marketing Cloud. | |
| ModifiedDate | Datetime | Specifies the date and time when MobilePush was last modified. Updates can include changes to credentials, certificates, or application settings. | |
| Keys | String | Specifies the set of key–value pairs that store customer-defined metadata for use in MobilePush. These values can drive personalization, segmentation, or conditional message logic. | |
| ApnsCertificateExpiration | Datetime | Specifies the expiration date and time of the Apple Push Notification service (APNs) certificate that is associated with the application. This value is essential for maintaining uninterrupted delivery to iOS devices. | |
| ApnsEnabled | Boolean | Specifies whether Apple Push Notification service (APNs) is enabled for the application. A value of 'true' allows the application to send push notifications to iOS devices, and a value of 'false' indicates that APNs messaging is disabled. | |
| GcmEnabled | Boolean | Specifies whether Google Cloud Messaging (GCM) is enabled for the application. A value of 'true' allows the application to send push notifications to Android devices through legacy GCM routing, and a value of 'false' indicates that GCM messaging is disabled. |
Returns Short Message Service (SMS) status codes recognized by Salesforce Marketing Cloud. Each status code represents a specific state of message delivery, such as pending, delivered, or failed. This view is useful for monitoring message outcomes and troubleshooting SMS communication issues.
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
| Name | Type | References | Description |
| Code [KEY] | Integer | Specifies the numeric status code that represents a Short Message Service (SMS) delivery or processing outcome. Carriers and the MobileConnect application use these codes to classify message behavior such as delivery, queuing, rejection, or failure. | |
| Status | String | Specifies the descriptive status that corresponds to the SMS code. This value summarizes the delivery outcome or processing state that is returned by the carrier or messaging system. | |
| Definition | String | Specifies the detailed explanation of the SMS status code. This definition provides context about why the status occurred and how the carrier or system interpreted the message event. |
Retrieves a paginated list of transactional messages that are not successfully sent in Salesforce Marketing Cloud. Results are ordered from the oldest to the newest message. This view provides visibility into message delivery issues and supports troubleshooting for transactional send processes.
Select all TransactionalMessages:
SELECT * FROM TransactionalMessages
| Name | Type | References | Description |
| LastEventId | Integer | Specifies the unique identifier (Id) of the most recent event from which the response should begin. This Id allows you to retrieve transactional message events starting from a specific point in the event stream. | |
| StatusCode | Integer | Specifies the numeric code that represents the reason that a transactional send did not complete. These codes map to the Email Send error codes and help identify delivery failures, validation issues, or provider errors. | |
| StatusMessage | String | Specifies the descriptive message that explains why the transactional send did not complete. This message supplements the StatusCode value and provides human-readable context for diagnosing the issue. | |
| EventCategoryType | String | Specifies the type of transactional send event. Common values include 'EmailSent' (for messages that are successfully handed off to the email provider), 'EmailNotSent' (for messages that failed with a specific reason), and 'EmailQueued' (for messages that are awaiting processing). | |
| Timestamp | String | Specifies the date and time when the event occurred, expressed in Central Standard Time (CST) without daylight saving adjustments. This timestamp indicates when the system recorded the event. | |
| DefinitionKey | String | Specifies the unique Id of the transactional send definition that is associated with the event. This Id links the event back to the definition that provided the message content and configuration. | |
| EventId | Integer | Specifies the numeric Id of the event within the transactional messaging event stream. This Id helps identify and sequence events for tracking and reporting purposes. | |
| MessageKey | String | Specifies the unique identifier used to track the status of the message throughout the transactional send process. This key is unique per message instance and appears in status and tracking queries. | |
| ContactKey | String | Specifies the contact key that identifies the subscriber that is associated with the transactional message. This key maps the event to the subscriber's profile and activity history in Salesforce Marketing Cloud. | |
| To | String | Specifies the channel address of the recipient. For email messages, this value is the recipient's email address. For Short Message Service (SMS) messages, this value is the recipient's mobile phone number. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Salesforce Marketing Cloud.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Salesforce Marketing Cloud, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CheckDataExtensionJobStatus | Retrieves the current status of a data extension job in Salesforce Marketing Cloud. This procedure is used to monitor asynchronous requests that insert or upsert rows into a data extension. It provides feedback on job completion, errors, and processing progress. |
| CreateDataExtensionJob | Initiates an asynchronous process to insert or upsert data into a data extension in Salesforce Marketing Cloud. It supports operations by key or identifier (Id) and returns job details for tracking and performance monitoring. |
| CreateImportSendDeliveryReport | Generates a CSV file (.csv) containing detailed delivery information for Short Message Service (SMS) messages in Salesforce Marketing Cloud. This procedure produces a report for a specified message list (MessageList) and places it in the account's enhanced File Transfer Protocol (FTP) location. This report helps administrators verify delivery metrics and troubleshoot communication results. |
| CreateKeyword | Creates a keyword for a specified account in Salesforce Marketing Cloud. Keywords are used to manage Short Message Service (SMS) interactions by associating inbound text responses with specific campaigns or workflows. This procedure facilitates automated opt-in or content-triggered messaging. |
| CreateMessageListDeliveryReport | Triggers the generation of a delivery report for a specified message list (MessageList) in Salesforce Marketing Cloud. This procedure provides performance metrics for message delivery and engagement tracking. |
| CreateOptInMessage | Creates a Short Message Service (SMS opt-in message in Salesforce Marketing Cloud. This message confirms a recipient's consent to receive future SMS communications and records subscription details for compliance tracking. |
| CreateTriggeredSend | Creates a triggered send object in Salesforce Marketing Cloud. A triggered send represents a specific instance of an automated email send initiated by an API event or system trigger. This procedure allows real-time delivery of personalized messages. |
| DeleteKeyword | Deletes an existing keyword from a specified Salesforce Marketing Cloud account. Removing a keyword prevents further inbound Short Message Service (SMS) messages from being associated with the corresponding campaign or automation. |
| FireEntryEvent | Fires an entry event to initiate a journey in Salesforce Marketing Cloud. This procedure triggers contact entry into a defined customer journey, enabling automated interactions based on real-time behavioral or data events. |
| GetChannelViewHtml | Returns the compiled HTML for a specified channel view within Salesforce Marketing Cloud. This output represents the final rendered content of an asset, allowing developers to preview or validate HTML rendering for a channel or campaign. |
| GetDataExtensionJobResults | Retrieves the results of a completed data extension job in Salesforce Marketing Cloud. It returns information about rows inserted, updated, or skipped, providing transparency into data import or synchronization operations. |
| GetDeliveryStatusOfQueuedMO | Retrieves the delivery status of a queued mobile-originated (MO) message in Salesforce Marketing Cloud. This procedure provides delivery details to support message tracking and diagnostic reporting for mobile messaging workflows. |
| GetFileForAnAsset | Retrieves the binary file associated with an asset in Salesforce Marketing Cloud. This procedure enables direct access to stored files, such as images or documents, for reuse or download through integrations. |
| GetHeaderFooterAccount | Retrieves the default header and footer configuration for a Salesforce Marketing Cloud account. These settings define standardized branding elements that can be applied to email and web templates for consistency across communications. |
| GetHeaderFooterEmail | Retrieves the header and footer content that is associated with a specific email in Salesforce Marketing Cloud. These elements define the standardized branding and layout sections that appear at the top and bottom of an email message. This procedure helps ensure consistent design and compliance across campaigns. |
| GetImportSendStatus | Retrieves the status of an ImportSend automation in Salesforce Marketing Cloud. This automation imports data and triggers send operations, and the procedure returns information about execution state, completion time, and any related errors. |
| GetImportStatus | Retrieves the status of an import job in Salesforce Marketing Cloud. This procedure provides details about job progress, success, or failure, allowing users to monitor large-scale data import operations and resolve potential processing issues. |
| GetJourneyPublicationStatus | Retrieves the publication status of a journey in Salesforce Marketing Cloud. This procedure returns information about whether a journey version is published, queued, or has encountered errors during deployment. It is essential for verifying automation readiness. |
| GetMessageContactHistory | Retrieves the history of the last message that was sent to a specific mobile number in Salesforce Marketing Cloud. This procedure provides delivery timestamps, message content identifiers (Ids), and channel information for audit and tracking purposes. |
| GetMessageContactStatus | Retrieves the overall delivery status of a message that was sent to a specific contact in Salesforce Marketing Cloud. This procedure aggregates delivery states such as queued, sent, delivered, or failed, supporting detailed message tracking and performance monitoring. |
| GetMessageListStatus | Returns the status of a message that was sent to a group of mobile numbers in Salesforce Marketing Cloud. This procedure provides a summary of delivery outcomes for the entire list, enabling administrators to confirm message reach and troubleshoot delivery issues. |
| GetMessageSendStatus | Retrieves the current send status of a message in Salesforce Marketing Cloud. This procedure provides operational insights into queued, in-progress, or completed sends, allowing real-time monitoring of outbound communication performance. |
| GetRefreshListStatus | Retrieves the status of a list refresh job in Salesforce Marketing Cloud. This procedure returns progress indicators, completion results, and error information for automation processes that update subscriber or data extension lists. |
| GetSubscriptionStatus | Returns the current subscription status for one or more mobile numbers or subscriber keys in Salesforce Marketing Cloud. This procedure identifies whether each contact is subscribed, unsubscribed, or pending confirmation, supporting compliance with communication preferences and opt-in regulations. |
| GetTrackingHistoryOfQueuedMO | Retrieves the complete tracking history of a queued mobile-originated (MO) message in Salesforce Marketing Cloud. This procedure includes delivery attempts, carrier responses, and timestamps that help administrators analyze message flow and resolve delivery issues. |
| ImportAndSendMessage | Imports contact or message data and immediately initiates message sends in Salesforce Marketing Cloud. This procedure combines data ingestion and outbound communication in a single automated operation to support rapid campaign deployment. |
| PostMessageToList | Initiates a message send to one or more contact lists in Salesforce Marketing Cloud. This procedure supports mass communication by triggering predefined message content for targeted lists managed within the account. |
| PostMessageToNumber | Initiates the sending of a message to one or more mobile numbers in Salesforce Marketing Cloud. This procedure supports direct, one-to-one or one-to-many mobile communications for marketing or transactional purposes. |
| PublishJourney | Publishes a specified journey version asynchronously in Salesforce Marketing Cloud. Publication makes the journey active and available for contact entry, enabling real-time automation execution. |
| QueueContactImport | Queues a contact import job in Salesforce Marketing Cloud. This procedure prepares contact data for processing and import into the system, allowing for asynchronous execution and progress tracking. |
| QueueMoMessage | Queues a mobile-originated (MO) message for sending in Salesforce Marketing Cloud. It supports asynchronous message handling to manage large volumes of inbound or outbound Short Message Service (SMS) traffic efficiently. |
| RefreshList | Refreshes a list in Salesforce Marketing Cloud. This procedure updates subscriber data and segmentation logic to reflect recent imports or status changes, ensuring that campaigns target the most current audience information. |
| SendMessageToRecipient | Sends an over-the-top (OTT) message to a specific recipient in Salesforce Marketing Cloud. Supported OTT networks include Facebook Messenger and LINE. This procedure facilitates cross-platform communication with customers through integrated messaging channels. |
| SendTransactionalMessageToMultipleRecipients | Sends a transactional message to multiple recipients using a defined send definition in Salesforce Marketing Cloud. This procedure supports bulk message delivery while maintaining individualized personalization for each recipient. |
| SendTransactionalMessageToRecipient | Sends a transactional message to a single recipient using a specified send definition in Salesforce Marketing Cloud. This procedure enables the delivery of personalized, event-triggered communications. |
| StopJourney | Stops a running journey in Salesforce Marketing Cloud. This procedure halts active automation processes and prevents new contacts from entering the journey while preserving existing data for analysis and compliance. |
Retrieves the current status of a data extension job in Salesforce Marketing Cloud. This procedure is used to monitor asynchronous requests that insert or upsert rows into a data extension. It provides feedback on job completion, errors, and processing progress.
| Name | Type | Required | Description |
| RequestId | String | True | Specifies the unique identifier (Id) that is provided by a previously submitted asynchronous insert or update request. This value identifies the original operation whose progress or results are being retrieved. |
| Name | Type | Description |
| RequestStatus | String | Indicates the current status of the asynchronous request (for example, 'Pending', 'Completed', or 'Error'). This value reflects the latest state of the job and helps developers monitor processing progress through API responses or automated workflows. |
| ResultStatus | String | Returns the overall outcome of the request (for example, 'Success' or 'Failure'). This field provides high-level completion information that can be used to determine whether subsequent data-retrieval or error-handling steps are required. |
| HasErrors | Boolean | A Boolean field that returns a value of 'true' when the results from processing the request contain one or more errors. It returns a value of 'false' when the request completes successfully without exceptions. This flag helps automate post-processing validation and exception reporting. |
| CallDateTime | Datetime | Records the date and time when the asynchronous request was first received by the system. This timestamp establishes the start point for performance monitoring and API auditing. |
| CompletionDateTime | Datetime | Records the date and time when the asynchronous request completed processing. This value is set automatically by the system and supports reporting on job duration and completion metrics. |
| PickupDateTime | Datetime | Records the date and time when the asynchronous request was picked up from the queue for processing. |
| RequestId | String | Returns the Id of the request that inserted or upserted data rows into the data extension. This output confirms that the system has processed and recorded the referenced job successfully. |
Initiates an asynchronous process to insert or upsert data into a data extension in Salesforce Marketing Cloud. It supports operations by key or identifier (Id) and returns job details for tracking and performance monitoring.
| Name | Type | Required | Description |
| DataExtensionId | String | False | Specifies the unique identifier (Id) of the data extension where rows are to be inserted or upserted. This system-generated value determines the target data extension for the asynchronous operation and ensures that the correct structure and field mapping are applied during execution. |
| CustomerKey | String | False | Specifies the customer-defined key that uniquely identifies the data extension in API operations. This key provides a stable reference across environments and can be used instead of the system-generated Id when initiating or automating insert and upsert operations. |
| RowsAggregate | String | False | Contains a JSON-formatted aggregate that defines the rows to be inserted or upserted into the target data extension. Each row includes field names and corresponding values that comply with the schema of the specified data extension. This parameter supports bulk operations and asynchronous job submission. |
| Mode | String | False | Specifies the operation mode that determines how data is written to the target data extension.
The allowed values are INSERT, UPSERT. The default value is INSERT. |
| Name | Type | Description |
| RequestId | String | Returns the unique identifier (Id) of the successfully queued asynchronous request. This Id is used in subsequent operations to retrieve the current status or results of the operation. |
Generates a CSV file (.csv) containing detailed delivery information for Short Message Service (SMS) messages in Salesforce Marketing Cloud. This procedure produces a report for a specified message list (MessageList) and places it in the account's enhanced File Transfer Protocol (FTP) location. This report helps administrators verify delivery metrics and troubleshoot communication results.
| Name | Type | Required | Description |
| TokenId | String | True | Specifies the unique identifier (Id) that is provided in the MessageList REST API response. This value authenticates the delivery report request and ensures that the report corresponds to the correct message batch or send event. |
| FileName | String | True | Specifies the name of the report file that is generated in the Enhanced FTP 'reports' folder for the associated Marketing Cloud account. The file name should include a recognizable prefix or timestamp to support automated retrieval and archival. |
| Name | Type | Description |
| Success | Boolean | A Boolean field that returns a value of 'true' when the CSV (.csv) delivery report file is successfully generated in the designated FTP folder. It returns a value of 'false' when the report generation fails or the file cannot be created due to configuration or connection errors. |
Creates a keyword for a specified account in Salesforce Marketing Cloud. Keywords are used to manage Short Message Service (SMS) interactions by associating inbound text responses with specific campaigns or workflows. This procedure facilitates automated opt-in or content-triggered messaging.
| Name | Type | Required | Description |
| LongCode | String | False | Specifies the long code on which the keyword is created. A long code is a standard ten-digit phone number that supports two-way Short Message Service (SMS) communication. Defining a long code allows the system to register and route keyword-based messages for localized or low-volume messaging programs. |
| ShortCode | String | False | Specifies the short code on which the keyword is created. A short code is a five- or six-digit number that supports high-volume SMS traffic. Associating a keyword with a short code enables subscribers to opt in, opt out, or interact with campaigns using simple text commands. |
| Keyword | String | False | Specifies the keyword that is created on the designated long or short code. The keyword serves as the trigger word that subscribers text to initiate subscription actions, request information, or participate in campaigns. Each keyword must be unique within its code and country context. |
| CountryCode | String | False | Specifies the two-letter country code that identifies the country associated with the short code. This value ensures that the keyword registration complies with local messaging regulations and carrier routing requirements. |
| Name | Type | Description |
| KeywordId | String | Returns the unique identifier (Id) of the keyword that is created. This system-generated value can be used in subsequent API operations to manage, track, or delete the keyword configuration. |
Triggers the generation of a delivery report for a specified message list (MessageList) in Salesforce Marketing Cloud. This procedure provides performance metrics for message delivery and engagement tracking.
| Name | Type | Required | Description |
| TokenId | String | True | Specifies the unique identifier (Id) that is provided in the MessageList REST API response. This value authenticates the request and ensures that the report generation process corresponds to the correct message batch within the MobileConnect messaging tool. |
| MessageId | String | True | Specifies the API key of the message definition that is configured in the MobileConnect user interface. This key identifies the specific message template or send definition for which the delivery report is being generated. |
| FileName | String | True | Specifies the name of the delivery report file that is generated in the Enhanced FTP 'reports' folder for the associated Marketing Cloud account. Using consistent file naming (for example, including a message identifier or timestamp) helps automate file retrieval and reporting workflows. |
| Name | Type | Description |
| Success | Boolean | A Boolean field that returns a value of 'true' when the delivery report is successfully triggered for the specified message definition. It returns a value of 'false' when the report cannot be initiated due to configuration, connection, or validation errors. |
Creates a Short Message Service (SMS opt-in message in Salesforce Marketing Cloud. This message confirms a recipient's consent to receive future SMS communications and records subscription details for compliance tracking.
| Name | Type | Required | Description |
| LongCode | String | False | Specifies the long code on which the opt-in message is created. A long code is a standard ten-digit number used for two-way Short Message Service (SMS) communication. Either a long code or short code is required for message setup. |
| ShortCode | String | False | Specifies the short code on which the opt-in message is created. A short code is a five- or six-digit number that supports high-volume SMS programs. Either a long code or short code must be provided when configuring the opt-in message. |
| MessageName | String | True | Specifies the display name that identifies the opt-in message within Salesforce Marketing Cloud. This name is used for management, reporting, and API reference. |
| MessageText | String | False | Specifies the text content of the opt-in message that users receive during the subscription process. The message typically includes welcome or instructional text that introduces the subscription program. |
| CountryCode | String | False | Specifies the two-letter country code that identifies the country to which the short code belongs. This value is required for short-code messages and ensures that message routing and compliance follow country-specific carrier regulations. |
| Keyword | String | True | Specifies the keyword that users text to subscribe to the message program. The keyword triggers the opt-in workflow and must be unique within its long code, short code, and country combination. |
| MessageOptInType | String | True | Defines the opt-in workflow template that determines how user confirmation is handled. Acceptable types include 'Single', 'Double', and 'Age'. 'Single' opt-in requires users to send one keyword (for example, 'JOIN') to subscribe. 'Double' opt-in requires an additional confirmation message (for example, 'Y' or 'YES'). 'Age' opt-in uses the double opt-in process with an added age confirmation step that verifies the user's eligibility before finalizing the subscription. |
| ResponseMessage | String | False | Specifies the message that is sent to users after they text the keyword in a 'Single' opt-in workflow. This parameter is required for 'Single' and is ignored for 'Double' or 'Age'. The message confirms successful enrollment and can include program details or help instructions. |
| DoubleOptInInitialMessage | String | False | Specifies the message that is sent to users to request confirmation of their opt-in in a 'Double' or 'Age' workflow. This message is required for both 'Double' and 'Age' types and prompts users to reply with a valid confirmation response or their age, as appropriate. |
| DoubleOptInConfirmationMessage | String | False | Specifies the confirmation message that is sent to users after they reply with 'Y' or 'YES' in a 'Double' workflow or after they complete the age confirmation step in an 'Age' workflow. This message confirms successful opt-in and is required for 'Double' and 'Age' templates. |
| DoubleOptInValidResponses | String | False | Lists the valid confirmation responses that users can send in a 'Double' workflow (for example, 'Y' or 'YES'). This parameter is required for 'Double' and ignored for 'Single' and 'Age' workflows. Validation ensures that only predefined confirmation responses trigger successful subscription. |
| OptInInvalidAgeMessage | String | False | Specifies the message that is sent to users whose provided age does not meet the minimum requirement in an 'Age' opt-in workflow. This message is required for 'Age' and is ignored for 'Single' and 'Double'. It helps maintain compliance with age-based subscription policies. |
| MinimumAge | Integer | False | Defines the minimum age that users must meet to be subscribed through an 'Age' workflow. This parameter is required for 'Age' and ignored for 'Single' and 'Double'. Users who provide a lower age recieve the message that is defined in the OptInInvalidAgeMessage field instead of being subscribed. |
| AllowSingleOptIn | Boolean | False | A Boolean field that returns a value of 'true' when users are allowed to receive a different response if they are already opted in to the same program. It returns a value of 'false' when duplicate opt-ins are not differentiated. |
| DuplicateOptInMessage | String | False | Specifies the message that is sent to users who attempt to opt in when they are already subscribed. This message acknowledges the duplicate opt-in attempt and can include program reminders or additional call-to-action text. |
| OptinErrorMessage | String | True | Specifies the message that is sent to users when an error occurs during the opt-in process. This message ensures that the user receives a meaningful response even when system or configuration issues prevent successful enrollment. |
| StartDate | Date | True | Defines the date and time when the opt-in message becomes active and available for user interaction. Messages sent before this date are not processed by the opt-in workflow. |
| EndDate | Date | True | Defines the date and time when the opt-in message becomes inactive. If users attempt to opt in after this date, they receive the default keyword response for the associated code or the response message of the replacement keyword. This behavior ensures continuity for users and prevents expired campaigns from receiving new opt-ins. |
| NextKeyword | String | False | Specifies the keyword that is automatically appended to the next inbound message that users send after the initial opt-in message. For example, if the NextKeyword value is 'ZIP', the system prompts users to reply with their postal code after subscribing. This parameter enables sequential data collection for progressive profiling. |
| Name | Type | Description |
| MessageID | String | Returns the unique identifier (Id) of the opt-in message that is created. This system-generated value can be used in subsequent API operations to retrieve, modify, or delete the opt-in configuration. |
Creates a triggered send object in Salesforce Marketing Cloud. A triggered send represents a specific instance of an automated email send initiated by an API event or system trigger. This procedure allows real-time delivery of personalized messages.
To create SubscriberAttributes, you must insert data in a temporary table called 'Subscribers#TEMP'.
INSERT INTO Subscribers#Temp(Order_Number,Order_Status,Purchase_Date) VALUES (1234,'received','2015-06-30 11:10:36.956') EXECUTE CreateTriggeredSend key='TEST_1', FromAddress='[email protected]', FromName='test', ToAddress='[email protected]',SubscriberKey='12345678', Subscribers='Subscribers#Temp'
you can execute the stored procedure.
EXECUTE CreateTriggeredSend key='TEST_1', FromAddress='[email protected]', FromName='test', ToAddress='[email protected]',SubscriberKey='12345678'
EXECUTE CreateTriggeredSend key='TEST_1', FromAddress='[email protected]', FromName='test', ToAddress='[email protected]', SubscriberKey='12345678', SubscriberAttributes='{\"attrname\":\"test\",\"attrname2\":22,\"attrname3\":\"testing\"}'
| Name | Type | Required | Description |
| Key | String | False | Specifies the external key that identifies the triggered send definition to use for this triggered send. This value corresponds to the external key that is assigned to the definition in Marketing Cloud and can be used instead of the SendId field to select the target definition. |
| SendId | String | False | Specifies the identifier (Id) of the entry-event send definition that is returned when a triggered send definition is created. You must provide either the send Id or the key to identify the triggered send definition that is executed. |
| FromAddress | String | False | Specifies the email address that is displayed as the sender of the message. This value should belong to a verified sending domain that is configured for deliverability and compliance. |
| FromName | String | False | Specifies the display name that appears as the sender in the recipient's inbox. Using a recognizable from name improves trust and open rates. |
| ToAddress | String | True | Specifies the recipient's email address. This address is validated before the send request is queued. |
| SubscriberKey | String | True | Specifies the unique Id that is defined for the message recipient. SubscriberKey links the send event to the contact profile so that tracking, preferences, and personalization resolve correctly. |
| SubscriberAttributes | String | False | Contains name-and-value pairs that provide attribute data used to personalize the message for this recipient. Attributes must match fields that are defined in the triggered send definition or its associated data sources. |
| RequestType | String | False | Specifies how the request is processed. |
| Name | Type | Description |
| Success | String | A Boolean field that returns a value of 'true' when the triggered send request is accepted and created successfully. It returns a value of 'false' when the request fails validation or cannot be queued. |
| RecipientSendId | String | Returns the Id that is generated for the recipient's send when the event send definition is triggered successfully. This Id can be used to correlate the request with tracking, logs, and diagnostics. |
| Messages | String | Returns a collection of message-level results and diagnostics that are produced by the triggered send, including status messages, error details, and validation feedback. These details assist with troubleshooting and audit reporting. |
Deletes an existing keyword from a specified Salesforce Marketing Cloud account. Removing a keyword prevents further inbound Short Message Service (SMS) messages from being associated with the corresponding campaign or automation.
Deletes a keyword on an account given a keyword Id.
EXECUTE DeleteKeyword KeywordId = 'alm5LXNSSktGMGluRznRb1Rb1R5MDZFQTo4Njow'
Deletes a keyword on an account given a keyword and long code.
EXECUTE DeleteKeyword LongCode = '5550003232', Keyword = 'TEST'
Deletes a keyword on an account given a keyword, short code, and country code.
EXECUTE DeleteKeyword ShortCode = '89239', Keyword = 'TEST', CountryCode = 'US'
| Name | Type | Required | Description |
| KeywordId | String | False | Specifies the encoded identifier (Id) of the keyword that is to be deleted. This system-generated value uniquely identifies the keyword configuration within Salesforce Marketing Cloud and ensures that the correct keyword record is targeted for deletion. |
| Keyword | String | False | Specifies the keyword that is to be deleted from the associated long or short code. Keywords act as trigger words that subscribers text to participate in programs or manage subscriptions. Deleting a keyword removes its ability to process inbound messages. |
| LongCode | String | False | Specifies the long code that is associated with the keyword being deleted. A long code is a standard ten-digit number that supports two-way Short Message Service (SMS) communication for localized or low-volume campaigns. |
| ShortCode | String | False | Specifies the short code that is associated with the keyword being deleted. A short code is a five- or six-digit number that supports high-volume SMS programs. Either a long code or short code must be provided to identify the correct keyword configuration. |
| CountryCode | String | False | Specifies the two-letter country code that identifies the country in which the short code is registered. This parameter ensures that deletion requests are processed under the correct country-level messaging compliance settings. |
| Name | Type | Description |
| Status | String | Returns the operational status of the keyword after the delete operation completes. This output confirms whether the deletion succeeded or if further action is required. |
Fires an entry event to initiate a journey in Salesforce Marketing Cloud. This procedure triggers contact entry into a defined customer journey, enabling automated interactions based on real-time behavioral or data events.
| Name | Type | Required | Description |
| ContactKey | String | True | Specifies the unique identifier (Id) that represents the subscriber or contact associated with the event. This key links the event instance to a specific contact record in Salesforce Marketing Cloud and ensures that the correct contact is admitted into the journey. |
| EventDefinitionKey | String | True | Specifies the unique event definition key that identifies the event source to be triggered. The event definition key is found in the Event Administration section of the Journey Builder after the event is created and saved. This value applies to both standard and custom events and must not contain a period ('.'). |
| Data | String | False | Specifies the data payload that defines the event properties. This parameter is required when the event includes custom fields or when the event definition specifies additional attributes. The provided data populates the data extension that is associated with the triggered event. |
| Name | Type | Description |
| EventInstanceId | String | Returns the Id that represents the specific instance of the entry event that is triggered. This system-generated value can be used to track, audit, or correlate the event with the corresponding Journey Builder execution. |
Returns the compiled HTML for a specified channel view within Salesforce Marketing Cloud. This output represents the final rendered content of an asset, allowing developers to preview or validate HTML rendering for a channel or campaign.
| Name | Type | Required | Description |
| AssetId | Integer | True | Specifies the unique identifier (Id) of the asset whose view content is to be retrieved. This value identifies the source asset in Content Builder and determines which file or message content is compiled. |
| ViewName | String | True | Specifies the name of the asset view to retrieve. Common view types include 'HTML', 'Text', and 'Preview'. This value determines which version of the asset content is returned by the stored procedure. |
| Thumbnail | Boolean | False | A Boolean field that is set to a value of 'true' to return a base64-encoded thumbnail image of the compiled content. It is set to a value of 'false' to return the complete HTML view instead of a thumbnail representation. |
| IncludeHeaderFooter | Boolean | False | A Boolean field that is set to a value of 'true' to include the message header and footer in the returned content when the asset contains HTML or text views. It is set to a value of 'false' to exclude header and footer content from the output. |
| IncludeDesignContent | Boolean | False | A Boolean field that is set to a value of 'true' to include additional design content, such as layout elements and design-time components, in the returned thumbnail image. It is set to a value of 'false' to return only the rendered message body. |
| DownloadPath | String | False | Specifies the full file path where the compiled HTML output is saved. This parameter determines the local or network storage location for the rendered asset view. |
| Encoding | String | False | Specifies the encoding type of the FileData input that is used when saving the compiled HTML file. The encoding ensures correct character rendering and compatibility with the chosen file format.
The allowed values are NONE, BASE64. The default value is BASE64. |
| Name | Type | Description |
| Success | Boolean | A Boolean field that returns a value of 'true' when the download or view retrieval operation completes successfully. It returns a value of 'false' when the operation fails due to an invalid path, permissions issue, or compilation error. |
| Compiled | String | Returns the fully rendered representation of the specified asset view. Depending on parameters, this output can contain the complete HTML markup or the Base64-encoded thumbnail image that represents the rendered asset. |
Retrieves the results of a completed data extension job in Salesforce Marketing Cloud. It returns information about rows inserted, updated, or skipped, providing transparency into data import or synchronization operations.
| Name | Type | Required | Description |
| RequestId | String | True | Specifies the unique identifier (Id) that is returned from a previously submitted asynchronous insert or update request. This Id is used to retrieve the status and detailed results of that specific data extension operation. |
| Name | Type | Description |
| Page | String | Returns the current page number of the result set that is retrieved for the asynchronous job. This value allows clients to page through large data sets in multiple retrieval calls. |
| PageSize | String | Returns the number of data rows that are included in each page of results. This parameter helps control pagination and optimize response size when reviewing job output. |
| Count | String | Returns the total number of data rows that were added or modified as a result of the asynchronous request. This count provides visibility into the scale of the processed operation. |
| Status | String | Returns the processing status of the request (for example, 'Pending', 'Completed', or 'Error'). This status helps determine whether additional pages or error-handling steps are required. |
| ErrorCode | String | Returns an error code when the API cannot insert or update a data row. The error code categorizes the type of failure that occurred and supports programmatic troubleshooting. |
| Message | String | Returns a descriptive message when the API cannot insert or update a data row. The message provides detailed context about the specific issue that prevented successful processing. |
| RequestId | String | Returns the unique Id of the asynchronous request whose results are being retrieved. This output confirms that the results correspond to the specified request and can be used for reconciliation or logging. |
Retrieves the delivery status of a queued mobile-originated (MO) message in Salesforce Marketing Cloud. This procedure provides delivery details to support message tracking and diagnostic reporting for mobile messaging workflows.
| Name | Type | Required | Description |
| TokenId | String | True | Specifies the unique token identifier (Id) that is returned for the queued mobile-originated (MO) message. This value is used to retrieve delivery details and confirm message status within the MobileConnect message queue. |
| Name | Type | Description |
| Tracking | String | Returns the tracking history of the queued MO message. The tracking history includes timestamps, delivery confirmations, and carrier response codes that indicate whether the message was successfully processed, delivered, or failed in transit. |
Retrieves the binary file associated with an asset in Salesforce Marketing Cloud. This procedure enables direct access to stored files, such as images or documents, for reuse or download through integrations.
| Name | Type | Required | Description |
| AssetId | Integer | True | Specifies the unique identifier (Id) of the asset whose associated file is to be retrieved. This identifier links the stored procedure request to the correct Content Builder asset. |
| DownloadPath | String | False | Specifies the full file path where the retrieved asset file is saved. This path determines the local or network location for the downloaded file output. |
| Name | Type | Description |
| Success | Boolean | A Boolean field that returns a value of 'true' when the asset file is successfully retrieved and stored. It returns a value of 'false' when the operation fails due to invalid identifiers, connection errors, or file access issues. |
| Content | String | Returns a Base64-encoded string that represents the binary content of the retrieved file. This value can be decoded to reconstruct the original asset file for use in other applications or systems. |
Retrieves the status of an ImportSend automation in Salesforce Marketing Cloud. This automation imports data and triggers send operations, and the procedure returns information about execution state, completion time, and any related errors.
| Name | Type | Required | Description |
| TokenID | String | True | Specifies the unique identifier (Id) that is returned by the ImportAndSend stored procedure. This Id links the status request to a specific ImportSend automation and ensures that the correct run history is retrieved. |
| Name | Type | Description |
| Status | String | Returns the current processing status of the ImportSend automation (for example, 'Pending', 'Running', 'Completed', or 'Error'). This value indicates the operational state of the automation at the time of the request. |
| LastUpdate | Datetime | Returns the most recent date and time when the ImportSend automation record was updated. This timestamp reflects changes to processing status or logging information. |
| CreatedTime | Datetime | Returns the date and time when the ImportSend automation was created. This timestamp provides a historical reference for tracking the lifecycle of the automation. |
| StartTime | Datetime | Returns the date and time when the ImportSend automation began processing the submitted import file. This timestamp helps determine when the automation started evaluating and sending messages. |
| CompletedTime | Datetime | Returns the date and time when the ImportSend automation finished processing. This timestamp confirms that all import and send operations have completed for the associated request. |
| LastRunTime | Datetime | Returns the date and time when the ImportSend automation last executed. This value helps administrators review recent activity and monitor automation frequency. |
| Source | String | Returns the source system or configuration that initiated the ImportSend automation. This value identifies where the import originated and assists in tracking end-to-end message-processing workflows. |
| Inserted | Integer | Returns the number of new records that were written to the _MobileSubscription data extension during the import process. This count reflects the volume of subscribers who were added as part of the automation. |
| Updated | Integer | Returns the number of existing subscriber records that were updated during the import process. This value indicates how many contacts received refreshed subscription attributes or statuses. |
| Invalid | Integer | Returns the number of rows in the import file that cannot be processed because of validation errors or missing data. This count helps identify issues that require correction before resubmitting the file. |
Retrieves the status of an import job in Salesforce Marketing Cloud. This procedure provides details about job progress, success, or failure, allowing users to monitor large-scale data import operations and resolve potential processing issues.
| Name | Type | Required | Description |
| ListID | String | True | Specifies the unique identifier (Id) of the MobileConnect list that is associated with the import operation. This identifier ensures that the stored procedure retrieves the status for the correct list-based import. |
| TokenID | String | True | Specifies the unique Id that is returned by the ImportQueue operation. This value links the request to a specific MobileConnect import job and allows the system to return its current processing status. |
| Name | Type | Description |
| Status | String | Returns the current status message that describes the progress or completion state of the MobileConnect list import associated with the provided token. This message helps determine whether the import is pending, processing, completed, or failed. |
Retrieves the publication status of a journey in Salesforce Marketing Cloud. This procedure returns information about whether a journey version is published, queued, or has encountered errors during deployment. It is essential for verifying automation readiness.
| Name | Type | Required | Description |
| StatusId | String | True | Specifies the unique identifier (Id) of the journey publication status record to retrieve. This identifier links the request to a specific publication attempt and allows the system to return its current state. |
| Name | Type | Description |
| Status | String | Returns the publishing status for the specified status Id, indicating whether the associated journey version is pending publication, actively publishing, successfully published, or has encountered an error. |
Retrieves the history of the last message that was sent to a specific mobile number in Salesforce Marketing Cloud. This procedure provides delivery timestamps, message content identifiers (Ids), and channel information for audit and tracking purposes.
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the unique identifier (Id) of the message that is associated with the MessageContact record. This identifier links the request to a specific outbound MobileConnect message whose contact-level history is being retrieved. |
| TokenId | String | True | Specifies the unique Id that is returned for the MessageContact operation. This value enables retrieval of message-tracking details that correspond to a specific send request. |
| MobileNumber | String | True | Specifies the mobile number that is associated with the contact whose message history is being requested. This value ensures that the stored procedure returns tracking data for the correct recipient. |
| Name | Type | Description |
| Count | Integer | Returns the total number of recipients that are included in the send request after subtracting any mobile numbers that were unsubscribed at the time of sending. This count reflects the number of intended recipients who were eligible to receive the message. |
| CreateDate | Datetime | Returns the date and time when the MessageContact send request was submitted. This timestamp provides a reference point for reviewing delivery history and tracking message-processing timelines. |
| Status | String | Returns the delivery status of the message for the specified contact. This status indicates whether the message was delivered, bounced, queued, or failed during carrier processing. |
| History | String | Returns the detailed history that is associated with the most recent message sent to the specified mobile number. This history can include status changes, carrier responses, timestamps, and other diagnostic information that describe the contact's message-delivery lifecycle. |
Retrieves the overall delivery status of a message that was sent to a specific contact in Salesforce Marketing Cloud. This procedure aggregates delivery states such as queued, sent, delivered, or failed, supporting detailed message tracking and performance monitoring.
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the unique identifier (Id) of the message that is associated with the MessageContact record. This identifier links the request to a specific MobileConnect message whose contact-level status is being retrieved. |
| TokenId | String | True | Specifies the unique Id that is returned for the MessageContact operation. This value enables retrieval of delivery information that corresponds to a specific send request. |
| Name | Type | Description |
| Message | String | Returns the text of the Short Message Service (SMS) message that was sent to the contact. This value reflects the final message content that was delivered or attempted for delivery. |
| Count | Integer | Returns the total number of recipients included in the send request after subtracting any mobile numbers that were unsubscribed at the time of sending. This count represents the number of contacts who were eligible to receive the message. |
| CreateDate | Datetime | Returns the date and time when the MessageContact send request was submitted. This timestamp establishes the start of the message-processing timeline. |
| CompleteDate | Datetime | Returns the date and time when the message send process completed for the associated request. This value helps confirm whether delivery events have fully resolved. |
| Status | String | Returns the delivery status of the message for the specified contact. This status indicates whether the message was delivered, bounced, queued, or failed during carrier or system processing. |
| Tracking | String | Returns the tracking information that describes how the message progressed through the delivery pipeline. Tracking details can include carrier responses, status transitions, timestamps, and other indicators that help diagnose message-delivery outcomes. |
Returns the status of a message that was sent to a group of mobile numbers in Salesforce Marketing Cloud. This procedure provides a summary of delivery outcomes for the entire list, enabling administrators to confirm message reach and troubleshoot delivery issues.
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the unique identifier (Id) of the message that is associated with the MessageList send operation. This Id links the request to the specific outbound SMS message definition used for the bulk send. |
| TokenId | String | True | Specifies the unique Id that is returned for the MessageList operation. This Id enables the stored procedure to retrieve delivery information for the correct batch of recipients. |
| Name | Type | Description |
| Message | String | Returns the text of the Short Message System (SMS) message that was sent to the group of recipients. This value reflects the final message content delivered or attempted for delivery during the MessageList send. |
| Count | Integer | Returns the total number of recipients included in the send request after subtracting any mobile numbers that were unsubscribed at the time of sending. This count represents the number of contacts who were eligible to receive the message. |
| CreateDate | Datetime | Returns the date and time when the MessageList send request was submitted. This timestamp marks the beginning of the message-processing timeline for the batch send. |
| CompleteDate | Datetime | Returns the date and time when the MessageList send process completed. This value confirms when all delivery events for the associated batch resolved, including carrier acknowledgments. |
| Status | String | Returns the delivery status of the message for the overall group of recipients. This status indicates whether the batch send is pending, in progress, completed, or has encountered errors during processing. |
| Tracking | String | Returns the tracking information that describes how the batch message progressed through the delivery pipeline for the group of recipients. Tracking details can include carrier responses, status transitions, timestamps, and delivery outcomes used for diagnostics and reporting. |
Retrieves the current send status of a message in Salesforce Marketing Cloud. This procedure provides operational insights into queued, in-progress, or completed sends, allowing real-time monitoring of outbound communication performance.
EXECUTE GetMessageSendStatus MessageKey = 'bcX0qaEp0USGciEnUJTW0w'
| Name | Type | Required | Description |
| MessageKey | String | True | Specifies the unique identifier (Id) that is used to track the delivery status of a specific transactional message send. This Id links the request to the message event that was generated through the Transactional Messaging API. |
| Name | Type | Description |
| RequestId | String | Returns the unique Id that represents this status-retrieval request. This value can be used for logging, auditing, or correlating multiple status inquiries. |
| EventCategoryType | String | Returns the event category type that is associated with the TransactionalSendEvents system. This value identifies the type of transactional messaging event that generated the status record, such as submission, delivery, or failure. |
| Timestamp | String | Returns the date and time when the event occurred, expressed in Central Standard Time. This timestamp allows send-status events to be sequenced accurately for analysis and troubleshooting. |
| CompositeId | String | Returns a Marketing Cloud–specific processing Id that uniquely identifies the combined event and message-processing sequence. This Id can be referenced in support cases or internal diagnostics to trace how the event was handled within the platform. |
Retrieves the status of a list refresh job in Salesforce Marketing Cloud. This procedure returns progress indicators, completion results, and error information for automation processes that update subscriber or data extension lists.
| Name | Type | Required | Description |
| ListId | String | True | Specifies the unique identifier (Id) of the MobileConnect list that is associated with the refresh operation. This Id ensures that the stored procedure retrieves the status for the correct list whose subscription records were refreshed. |
| TokenId | String | True | Specifies the unique Id that is returned by the RefreshList operation. This Id links the status request to a specific MobileConnect list-refresh job and allows the system to return the most recent processing outcome. |
| Name | Type | Description |
| Status | String | Returns the current processing status of the list-refresh job, indicating whether the refresh is pending, running, completed, or has encountered an error. |
Returns the current subscription status for one or more mobile numbers or subscriber keys in Salesforce Marketing Cloud. This procedure identifies whether each contact is subscribed, unsubscribed, or pending confirmation, supporting compliance with communication preferences and opt-in regulations.
EXECUTE GetSubscriptionStatus MobileNumbers = '["15555555555"]' EXECUTE GetSubscriptionStatus SubscriberKeys = '["ExampleSubKey1"]'
| Name | Type | Required | Description |
| MobileNumbers | String | False | Specifies an array of mobile numbers for which subscription status information is requested. Each number is evaluated against MobileConnect subscription records to determine whether the contact is currently opted in, opted out, or pending confirmation. |
| SubscriberKeys | String | False | Specifies an array of subscriber keys for which subscription status information is requested. Subscriber keys allow subscription checks to be performed even when mobile numbers change or when multiple numbers are associated with a single contact. |
| Name | Type | Description |
| Contacts | String | Returns detailed subscription status information for each mobile number or subscriber key provided in the request. This information can include opt-in status, opt-out status, pending confirmations, and any applicable messaging restrictions. |
Retrieves the complete tracking history of a queued mobile-originated (MO) message in Salesforce Marketing Cloud. This procedure includes delivery attempts, carrier responses, and timestamps that help administrators analyze message flow and resolve delivery issues.
| Name | Type | Required | Description |
| TokenId | String | True | Specifies the unique identifier (Id) that is returned for the queued mobile-originated (MO) message. This Id links the request to a specific inbound message that is awaiting processing and ensures that the correct tracking information is retrieved. |
| Name | Type | Description |
| Status | String | Returns the current processing status of the queued MO message, indicating whether the message is pending, processing, completed, or has encountered an error during carrier or system handling. |
| History | String | Returns the detailed tracking history of the queued MO message. This history can include timestamps, carrier responses, processing outcomes, and any status transitions that occurred while the message was being evaluated. |
Imports contact or message data and immediately initiates message sends in Salesforce Marketing Cloud. This procedure combines data ingestion and outbound communication in a single automated operation to support rapid campaign deployment.
EXECUTE ImportAndSendMessage MessageId = 'MessageId', " +
"Keyword = 'Test_Keyword'," +
"NotificationEmail = '[email protected]'," +
"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\"" +
" }]" +
" }]'
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the encoded message identifier (Id) of the MobileConnect message that is used during the import-and-send operation. This Id links the import request to the correct message template or send definition. |
| Keyword | String | True | Specifies the valid keyword on the associated short code that is used to opt the imported mobile numbers into the program. Using this keyword ensures that recipients are subscribed before message delivery occurs. |
| NotificationEmail | String | False | Specifies the email address that receives notifications when the import operation completes. This value provides visibility into job status and helps administrators monitor automated sends. |
| Override | Boolean | False | A Boolean field that is set to a value of 'true' when the override message text should be used instead of the default message. It is set to a value of 'false' when the system should send the original configured message. |
| OverrideText | String | False | Specifies the message text that replaces the default message when the Override parameter is set to a value of 'true'. This text provides customized content for the outbound send. |
| IsDuplicationAllowed | Boolean | False | A Boolean field that is set to a value of 'true' when duplicate messages are permitted during the import-and-send operation. It is set to a value of 'false' when duplicate sends should be prevented. |
| IsVisible | Boolean | False | A Boolean field that is set to a value of 'true' when the import definition and the automatically created list should be visible in the MobileConnect interface. It is set to a value of 'false' when these resources should remain hidden from standard user views. |
| ImportDefinition | String | True | Specifies the list of import definitions that should be created as part of the import-and-send operation. Currently, only one import definition is supported per request. |
| Name | Type | Description |
| TokenId | String | Returns the token Id that represents the queued import-and-send job. This Id can be used to retrieve status information or the results of the operation. |
| LastPublishDate | String | Returns the date and time when the associated message or import definition was last published. This value helps confirm that the latest configuration was used during the operation. |
Initiates a message send to one or more contact lists in Salesforce Marketing Cloud. This procedure supports mass communication by triggering predefined message content for targeted lists managed within the account.
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
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the encoded identifier (Id) of the outbound message definition. This Id appears when creating an 'API Entry Event' message in the user interface. If the configuration screen is no longer available, the Id can be retrieved by inspecting the associated API resource when the message is opened in the UI. |
| TargetListIds | String | False | Specifies one or more list Id values that identify the lists whose contacts will be included in the send. When these values are provided, they override the message's default inclusion lists. |
| OverrideTemplateTargetLists | Boolean | False | Specifies whether the values in the TargetListIds input should override the message's default target list configuration. A value of 'true' applies the override, and a value of 'false' retains the template defaults. |
| ExclusionListIds | String | False | Specifies one or more list Id values that identify the lists whose contacts must be excluded from the send. When these values are provided, they override the message's default exclusion lists. |
| OverrideTemplateExclusionLists | Boolean | False | Specifies whether the values in ExclusionListIds input should override the message's default exclusion list configuration. A value of 'true' applies the override, and a value of 'false' retains the template defaults. |
| IgnoreExclusionLists | Boolean | False | Specifies whether all exclusion lists, including default exclusion lists defined for the message, should be ignored. A value of 'true' disables exclusion filtering for the send. |
| OverrideMessageText | Boolean | False | Specifies whether the message text that is provided by the caller should override the message text that is stored with the outbound message definition. A value of 'true' applies the override. |
| MessageText | String | False | Specifies the outbound message text. This value is required when OverrideMessageText field is set to 'true' and replaces the existing message body stored in the definition. |
| UtcOffset | String | False | Specifies the offset from Coordinated Universal Time (UTC) that applies to the start and end times of the blackout window. A valid offset is required in every request to ensure that blackout restrictions are evaluated correctly. |
| WindowStart | String | False | Specifies the start time of the blackout window in the time zone that is determined by the UtcOffset parameter. To determine whether the scheduled SendTime input falls within the blackout period, convert both the start and end times to UTC before evaluating them. |
| WindowEnd | String | False | Specifies the end time of the blackout window in the time zone determined by the UtcOffset parameter. To determine whether the scheduled SendTime input falls within the blackout period, convert both the start and end times to UTC before evaluating them. |
| SendTime | Datetime | False | Specifies the UTC date and time when the message is scheduled for delivery. If the value represents a time in the past, the message is sent immediately. The blackout window is still enforced when a blackout configuration exists. |
| AllowDuplication | Boolean | False | Specifies whether the same mobile number is allowed to receive multiple copies of the message. A value of 'true' permits duplication during the send. |
| ContentURL | String | False | Specifies the URL of the media file that is to be included with a Multimedia Messaging Service (MMS) message. This content is downloaded by carriers when processing the outbound request. |
| Name | Type | Description |
| TokenId | String | Specifies the token Id that is returned after the request is submitted. This Id is used to request the processing status in a follow-up API call. |
Initiates the sending of a message to one or more mobile numbers in Salesforce Marketing Cloud. This procedure supports direct, one-to-one or one-to-many mobile communications for marketing or transactional purposes.
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. |
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'
| Name | Type | Required | Description |
| MessageId | String | True | Specifies the encoded identifier (Id) of the outbound message definition. This Id is required to route the send request to the appropriate MobileConnect message configuration. |
| MobileNumbers | String | False | Specifies an array that contains one or more mobile numbers that should receive the message. Each number must be in a valid format supported by the carrier. |
| Subscribe | Boolean | False | Specifies whether Salesforce Marketing Cloud should create a subscription for the mobile number when none exists. A value of 'true' creates a new subscription that aligns with the message's short code and keyword. |
| Resubscribe | Boolean | False | Specifies whether Salesforce Marketing Cloud should reinstate a subscription for the mobile number if it is currently unsubscribed. A value of 'true' reactivates the subscription so that the contact can receive messages again. |
| Keyword | String | False | Specifies the keyword associated with the short code that applies to the outbound message. This parameter is required when Subscribe or Resubscribe is set to 'true' because the subscription workflow must map to the appropriate keyword. |
| Override | Boolean | False | Specifies whether the provided MessageText value should override the message text that is stored with the message definition. A value of 'true' applies the override. |
| MessageText | String | False | Specifies the message text that replaces the text stored with the outbound message definition. This value is required when the Override input is set to 'true'. |
| UtcOffset | String | False | Specifies the offset from Coordinated Universal Time (UTC) that applies to the blackout window start and end times. This value is required in every request to ensure that blackout restrictions are evaluated correctly. |
| WindowStart | String | False | Specifies the start time of the blackout window in the time zone that is determined by the UtcOffset parameter. To determine whether the SendTime input falls within the blackout period, convert the start and end times to UTC before comparing them to the scheduled delivery time. |
| WindowEnd | String | False | Specifies the end time of the blackout window in the time zone that is determined by the UtcOffset parameter. To determine whether the SendTime input falls within the blackout period, convert the start and end times to UTC before comparing them to the scheduled delivery time. |
| SendTime | Date | False | Specifies the UTC date and time when the message should be delivered. If the value represents a time in the past, the system sends the message immediately. Blackout window rules still apply when a blackout configuration exists. |
| ContentURL | String | False | Specifies the URL of the media content to be sent with an Multimedia Messaging Service (MMS) message. Carriers retrieve this content when processing the outbound request. |
| Name | Type | Description |
| TokenId | String | Specifies the token Id that is returned after the request is submitted. This Id can be used in a subsequent API call to check the processing status of the send. |
Publishes a specified journey version asynchronously in Salesforce Marketing Cloud. Publication makes the journey active and available for contact entry, enabling real-time automation execution.
| Name | Type | Required | Description |
| JourneyId | String | True | Specifies the unique identifier (Id) of the journey, expressed as a globally unique Id. Salesforce Marketing Cloud assigns this value to each journey definition, and the publish operation uses it to locate and activate the correct journey. |
| JourneyVersion | Integer | True | Specifies the version number of the journey that should be published. This value determines which iteration of the journey definition is activated and made available for entry and execution. |
| Name | Type | Description |
| StatusId | String | Specifies the status Id that represents the outcome of the publish request. This Id can be used to retrieve additional publication details (for example, success, failure, or validation results). |
Queues a contact import job in Salesforce Marketing Cloud. This procedure prepares contact data for processing and import into the system, allowing for asynchronous execution and progress tracking.
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. |
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 = '[email protected]', " +
"ImportMappingType = 'MapByOrdinal', FileName = 'testdata.csv', FileType = 'csv', IsFirstRowHeader = true
| Name | Type | Required | Description |
| ListId | String | True | Specifies the list identifier (Id) that determines to which MobileConnect list the imported contacts should be added. This Id links the file import to the appropriate subscription list. |
| ShortCode | String | False | Specifies the short code that is associated with the import. The short code defines the messaging channel through which contacts can receive future messages. |
| Keyword | String | False | Specifies the keyword that applies to the import. The keyword determines the subscription context that is assigned to the imported contacts. |
| SendEmailNotification | Boolean | False | Specifies whether an email notification should be sent when the contact import begins or completes. A value of 'true' enables notifications. |
| EmailAddress | String | False | Specifies the email address that receives the import notification when the SendEmailNotification field is set to 'true'. |
| ImportMappingType | String | False | Specifies the field mapping strategy that is used to interpret the columns in the import file. This value determines how file fields map to MobileConnect attributes. |
| FileName | String | False | Specifies the name of the import file, including its extension. The file must be uploaded to the designated Enhanced FTP location before processing. |
| FileType | String | False | Specifies the type of that is file used for the import. The only supported file type is a .csv file. |
| IsFirstRowHeader | Boolean | False | Specifies whether the first row of the file contains column headers. A value of 'true' treats the first row as header information. |
| Name | Type | Description |
| TokenId | String | Specifies the token Id that is generated for the queued contact import. This Id can be used to check the processing status in a follow-up request. |
Queues a mobile-originated (MO) message for sending in Salesforce Marketing Cloud. It supports asynchronous message handling to manage large volumes of inbound or outbound Short Message Service (SMS) traffic efficiently.
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'
| Name | Type | Required | Description |
| MobileNumbers | String | False | Specifies an array of mobile numbers that represent the source of the mobile-originated (MO) message simulation. This parameter is used when the message should be processed as coming from raw phone numbers that are not linked to existing subscriber profiles. Either the MobileNumbers or Subscribers parameters must be provided, but not both. |
| Subscribers | String | False | Specifies an array of objects that each contain a subscriber key and a mobile number. This parameter is used when the MO message simulation must be tied to specific subscriber records in Salesforce Marketing Cloud. Each entry maps the inbound message to a known contact. Either the Subscribers or MobileNumbers parameters must be provided, but not both. |
| ShortCode | String | True | Specifies the short code through which the message is processed. The short code determines the messaging route and applies the appropriate subscription and compliance rules. |
| MessageText | String | True | Specifies the message text that is queued for delivery as an MO message simulation. This text represents the inbound message content that the system processes. |
| Name | Type | Description |
| Results | String | Specifies the results that are returned after the MO message is queued for processing. These results can include submission details, validation outcomes, or any errors that are detected during the queue operation. |
Refreshes a list in Salesforce Marketing Cloud. This procedure updates subscriber data and segmentation logic to reflect recent imports or status changes, ensuring that campaigns target the most current audience information.
| Name | Type | Required | Description |
| ListId | String | True | Specifies the unique identifier (Id) of the MobileConnect list that should be refreshed. Refreshing the list updates its membership based on the most recent subscription data tied to the associated short code and keyword. |
| Name | Type | Description |
| TokenId | String | Specifies the token Id that is returned after the refresh request is queued. This Id can be used in a follow-up call to check the processing status of the list refresh operation. |
Sends an over-the-top (OTT) message to a specific recipient in Salesforce Marketing Cloud. Supported OTT networks include Facebook Messenger and LINE. This procedure facilitates cross-platform communication with customers through integrated messaging channels.
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. |
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. |
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"
| Name | Type | Required | Description |
| MessageKey | String | True | Specifies the user-defined identifier (Id) for the outbound message. This key distinguishes the message from other requests and is used for tracking and reporting. |
| MessageGroupKey | String | False | Specifies a user-defined identifier that groups multiple send requests together. This grouping allows related message requests to be tracked and managed as a single logical set. |
| SenderType | String | True | Specifies the name of the over-the-top (OTT) messaging network that is used to deliver the message. This value determines the routing behavior and required authentication context. |
| SenderId | String | True | Specifies the Id of the OTT resource that sends the message. For LINE, this value is the LINE channel Id. For Messenger, this value is the Facebook page Id. |
| OttId | String | True | Specifies the recipient's identifier within the OTT network. For LINE, if the system cannot validate the userReference value, it retries by using the OttId value together with the sender Id. |
| UserReference | String | True | Specifies an alternate Id for the recipient. For Messenger, this value corresponds to the user_ref token. For LINE, this value corresponds to the reply token that LINE generates for an inbound message event. This token is used to send a direct reply to that event and is valid only for a short period. |
| Subject | String | False | Specifies the message name or subject label that identifies the content or purpose of the outbound message. |
| ValidityPeriod | Integer | True | Specifies the length of time during which the request remains valid. If delivery cannot be completed within this period, the request expires and is not processed. |
| Name | Type | Description |
| OttRequestId | String | Specifies the identifier (Id) that represents the OTT send request. This Id can be used in follow-up operations to check the status or outcome of the request. |
Sends a transactional message to multiple recipients using a defined send definition in Salesforce Marketing Cloud. This procedure supports bulk message delivery while maintaining individualized personalization for each recipient.
Transactional message send:
For RecipientAggregate and Attributes either JSON or temp table as input. For example,
INSERT INTO RecipientAggregate#TEMP (RecipientContactKey, RecipientTo, RecipientMessageKey, RecipientAttributes) VALUES ('recipient1', '[email protected]', 'nFL4ULgheUeaGbPIMzJJSw', '{"RequestAttribute_1":"value_1", "RequestAttribute_2":"value_2", "Attribute1":"This is one for recipient1", "Attribute2":"This is two for recipient1"}');
INSERT INTO RecipientAggregate#TEMP (RecipientContactKey, RecipientTo, RecipientMessageKey, RecipientAttributes) VALUES ('recipient2', '[email protected]', 'GV1LhQ6NFkqFUAE1IsoQ9Q', '{"UserAttribute_3":"value_3", "UserAttribute_4":"value_4"}');
EXECUTE SendTransactionalMessageToMultipleRecipients DefinitionKey = '2FA_order_accounts', RecipientAggregate = 'RecipientAggregate#TEMP', Attributes = '{"UserAttribute_a":"value_a", "UserAttribute_b":"value_b"}'
INSERT INTO Attributes#TEMP (UserAttr_1, UserAttr_2) VALUES ('UserAttrValue_1', 'UserAttrValue_2');
INSERT INTO RecipientAggregate#TEMP (RecipientContactKey, RecipientTo, RecipientMessageKey, RecipientAttributes) VALUES ('recipient1', '[email protected]', 'nFL4ULgheUeaGbPIMzJJSw', '{"RequestAttribute_1":"value_1", "RequestAttribute_2":"value_2", "Attribute1":"This is one for recipient1", "Attribute2":"This is two for recipient1"}');
INSERT INTO RecipientAggregate#TEMP (RecipientContactKey, RecipientTo, RecipientMessageKey, RecipientAttributes) VALUES ('recipient2', '[email protected]', 'GV1LhQ6NFkqFUAE1IsoQ9Q', '{"UserAttribute_3":"value_3", "UserAttribute_4":"value_4"}');
EXECUTE SendTransactionalMessageToMultipleRecipients DefinitionKey = '2FA_order_accounts', RecipientAggregate = 'RecipientAggregate#TEMP', Attributes = 'Attributes#TEMP'
| Name | Type | Required | Description |
| DefinitionKey | String | True | Specifies the unique identifier (Id) of the send definition that determines the content, settings, and classification used for the transactional send. This Id links the request to the definition configured in Marketing Cloud. |
| RecipientContactKey | String | False | Specifies the unique Id for the subscriber receiving the message. Each request must include a contact key. You can use an existing subscriber key or allow the system to create one at send time by providing the recipient's email address. |
| RecipientTo | String | False | Specifies the channel address of the recipient. For email, this value is the recipient's email address. For other channels, the address format depends on the channel type. |
| RecipientMessageKey | String | False | Specifies the unique Id that is used to track message status for the recipient. This value can be generated automatically or provided in the request. It can be up to 100 characters and accepts all characters. Each recipient in the request must have a unique message key; duplicate keys within the same request cause the message to be rejected. |
| RecipientAttributes | String | False | Specifies the set of key–value pairs that personalize the message for the recipient. These attributes must correspond to profile attributes, content attributes, or triggered send data extension attributes. |
| RecipientAggregate | String | True | Specifies an array of recipient objects that contain the parameters, personalization data, and metadata required for each recipient in a multirecipient send request. Each object can include tracking identifiers and attribute mappings. |
| Attributes | String | False | Specifies the key–value pairs used to personalize the message for the recipient. These values must map to profile attributes, content attributes, or triggered send data extension attributes. This parameter applies when attributes are provided at the request level rather than at the individual recipient level. |
| Name | Type | Description |
| RequestId | String | Specifies the unique Id that is assigned to the transactional send request. This Id is used in follow-up calls to retrieve the status or results of the request. |
| MessageKey | String | Specifies the unique Id that tracks the message send status for monitoring and reporting purposes. |
| Status | String | Specifies the operational status of the transactional send request (for example, queued, processing, completed, or failed). |
| ErrorMessage | String | Specifies the error message that is returned when the request encounters a failure. This value helps diagnose issues with validation, configuration, or delivery. |
Sends a transactional message to a single recipient using a specified send definition in Salesforce Marketing Cloud. This procedure enables the delivery of personalized, event-triggered communications.
Send a transactional message:
Attributes support either JSON or temp table as input. For example,
EXECUTE SendTransactionalMessageToRecipient MessageKey = 'e1c35141-6e5c-4bc2-813b-60f969e52b0d', DefinitionKey = 'CanBeAGUIDorAny100UnicodeCharString', RecipientContactKey = 'd3c4a2d2-b620-4a39-88aa-b14868b766c6', RecipientTo = '[email protected]', Attributes = '{"UserAttr_1":"UserAttrValue_1","UserAttr_2":"UserAttrValue_2"}'
INSERT INTO Attributes#TEMP (UserAttr_1, UserAttr_2) VALUES ('UserAttrValue_1', 'UserAttrValue_2');
EXECUTE SendTransactionalMessageToRecipient MessageKey = 'e1c35141-6e5c-4bc2-813b-60f969e52b0d', DefinitionKey = 'CanBeAGUIDorAny100UnicodeCharString', RecipientContactKey = 'd3c4a2d2-b620-4a39-88aa-b14868b766c6', RecipientTo = '[email protected]', Attributes = 'Attributes#TEMP';
| Name | Type | Required | Description |
| MessageKey | String | True | Specifies the user-defined identifier (Id) for the outbound message. This Id distinguishes the message from other send requests and is used to track the status of the transactional send. |
| DefinitionKey | String | True | Specifies the unique Id of the send definition that determines the content, sending classification, and configuration used for the transactional message. |
| RecipientContactKey | String | True | Specifies the contact key that identifies the subscriber who receives the message. Each request must include a contact key. You can use an existing subscriber key or allow the system to create one at send time by providing the recipient's email address. |
| RecipientTo | String | False | Specifies the channel address of the recipient. For email, this value is the recipient's email address. For other channels, the address format depends on the channel type. |
| Attributes | String | False | Specifies the set of key–value pairs that is used to personalize the message for the recipient. These values must correspond to profile attributes, content attributes, or triggered send-data extension attributes. |
| Name | Type | Description |
| RequestId | String | Specifies the unique Id that is assigned to the transactional send request. This Id is used in follow-up operations to retrieve the status or outcome of the request. |
Stops a running journey in Salesforce Marketing Cloud. This procedure halts active automation processes and prevents new contacts from entering the journey while preserving existing data for analysis and compliance.
| Name | Type | Required | Description |
| JourneyId | String | True | Specifies the unique identifier (Id) of the journey that should be stopped. This Id is expressed as a globally unique Id and corresponds to the journey definition that is stored in Journey Builder. |
| JourneyVersion | Integer | True | Specifies the version number of the journey to stop. This value determines which published iteration of the journey is affected by the stop operation. |
| Name | Type | Description |
| Success | Boolean | Specifies whether the stop operation succeeded. A value of 'true' confirms that the journey was stopped, and a value of 'false' indicates that the request did not complete successfully. |
The Cloud 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.
The Cloud uses the Salesforce Marketing Cloud API to process supported filters. The Cloud processes other filters client-side within the Cloud.
Tables describes the available tables. Tables are statically defined to model Assets, Categories, Journeys, and more.
Views are tables that cannot be modified. Typically, read-only data are shown as views. Stored procedures allow you to execute operations to Salesforce Marketing Cloud, including downloading and uploading objects.
The Cloud models the data in Salesforce Marketing Cloud as a list of tables in a relational database that can be queried using standard SQL statements.
| Name | Description |
| Account | Represents an account within Salesforce Marketing Cloud. Each record defines the configuration, credentials, and organizational context of a Marketing Cloud account. This table supports management of account-level metadata for system integration and user provisioning. |
| AccountUser | Represents an individual user who belongs to a specific Salesforce Marketing Cloud account. Each user record includes details such as roles, permissions, and access settings. This table supports queries and updates but does not allow deletions to protect account integrity. |
| BusinessUnit | Represents a business unit within an Enterprise or Enterprise 2.0 Salesforce Marketing Cloud account. Each business unit defines a logical partition for users, data, and permissions. This table supports query and update operations but does not allow deletions to maintain enterprise hierarchy integrity. |
| ContentArea | Represents a content area (ContentArea) in Salesforce Marketing Cloud. A ContentArea defines a reusable section of content, such as text, images, or dynamic blocks, that can be inserted into multiple messages or templates. This table allows you to manage reusable content elements to ensure brand consistency and efficiency. |
| DataExtension | Represents a data extension within a Salesforce Marketing Cloud account. A data extension is a custom table that stores subscriber or relational data used for segmentation, personalization, or automation. This table allows you to query, create, and manage data structures that support targeted communications. |
| Represents an email object in Salesforce Marketing Cloud. Each record contains metadata about an email message, including subject, content area references, and send configurations. This table is used to query or manage email assets that are stored and deployed from the account. | |
| EmailSendDefinition | Stores email send definitions in Salesforce Marketing Cloud. Each record includes message details, sender and delivery profiles, and audience configurations. This table allows you to define and manage parameters that control how and when emails are sent to subscribers. |
| FileTrigger | Represents configuration data that defines file-based automation triggers within Salesforce Marketing Cloud. A file trigger initiates an automation when a file is placed in a designated Enhanced FTP location, enabling automated imports or other workflow actions that begin upon file detection. This table does not support delete operations. |
| FilterDefinition | Defines audience segmentation filters in Salesforce Marketing Cloud. Each filter specifies logical rules that identify which contacts or subscribers meet specific criteria. This table supports update and query operations but does not allow inserts, as filters are managed within the platform interface. |
| ImportDefinition | Defines reusable import definitions in Salesforce Marketing Cloud. Each import definition specifies the file location, mapping, and data extension target for recurring import operations. This table supports query and update operations, but it does not allow inserts because imports are configured through the application interface. |
| List | Represents subscriber lists in Salesforce Marketing Cloud. A list defines a group of subscribers that share common attributes or purposes, such as newsletter recipients or event registrants. This table supports list management operations including queries, inserts, and updates. |
| Portfolio | Represents a file that is stored in the portfolio of a Salesforce Marketing Cloud account. Each record includes file metadata such as name, type, and storage location. This table supports query and management of digital assets that are uploaded or referenced across campaigns. |
| ProgramManifestTemplate | Represents standardized templates that define the structure and configuration of program manifests that are used within Salesforce Marketing Cloud workflows. These templates provide a consistent model for describing program components and their relationships. This table does not support insert or delete operations. |
| QueryDefinition | Represents an SQL query activity that can be executed through the SOAP API in Salesforce Marketing Cloud. Each query definition specifies the SQL text, data extension target, and scheduling information for automated query execution. This table supports query and retrieval operations but does not allow inserts or updates. |
| ReplyMailManagementConfiguration | Defines configuration settings for Reply Mail Management (RMM) in Salesforce Marketing Cloud. RMM determines how reply emails are processed, routed, and categorized for an account. This table does not support deletions to preserve email routing integrity. |
| Send | Represents email send operations in Salesforce Marketing Cloud. Each record includes aggregate tracking data for sent emails, such as audience size, delivery results, and performance metrics. This table supports query and reporting but does not allow deletes or updates. |
| SendClassification | Represents send classifications in Salesforce Marketing Cloud. A send classification defines the delivery parameters for a message, including CAN-SPAM classification (commercial and transactional or relationship messages), sender profile, and delivery profile. This table helps enforce consistent email compliance and brand policies. |
| SenderProfile | Stores sender profile configurations in Salesforce Marketing Cloud. A sender profile defines the 'From' name, 'From' email address, and reply handling for outbound messages. This table supports integration with send definitions to maintain consistent sender identity across campaigns. |
| SMSTriggeredSend | Represents individual instances of Short Message Service (SMS) triggered sends in Salesforce Marketing Cloud. Each record corresponds to a message sent as part of a triggered send definition. This table does not support deletes or updates to preserve historical send data. |
| Subscriber | Represents a subscriber in Salesforce Marketing Cloud. Each record identifies an individual who has opted to receive marketing communications via email or Short Message Service (SMS). This table is central to subscriber management, preference handling, and audience segmentation. |
| SuppressionListDefinition | Represents suppression lists in Salesforce Marketing Cloud. A suppression list defines subscribers who should be excluded from specific sends or publications. Each record can be associated with one or more suppression contexts to enforce message exclusions. |
| TriggeredSendDefinition | Defines triggered send definitions in Salesforce Marketing Cloud. A triggered send definition establishes parameters for automatically sending emails to contacts who meet specified conditions or trigger events. The 'All Subscribers' list permission is required when using the default list for triggered sends. |
Represents an account within Salesforce Marketing Cloud. Each record defines the configuration, credentials, and organizational context of a Marketing Cloud account. This table supports management of account-level metadata for system integration and user provisioning.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Account WHERE Id = 123 SELECT * FROM Account WHERE Id IN (123, 456) SELECT * FROM Account WHERE CreatedDate > '2017/01/25'
You must specify the Name column when executing an insert against this table.
INSERT INTO Account (Name) VALUES ('Test')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Account SET Fax = '1123123' WHERE Id = 123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Account WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the unique identifier (Id) of the account. This Id distinguishes the account within the Salesforce Marketing Cloud environment and is used to reference it in configuration, hierarchy, and API operations. |
| AccountType | String | False |
Specifies the type of Salesforce Marketing Cloud account (for example, 'BUSINESS_UNIT or 'ENTERPRISE_2'). This value determines the features, permissions, and structural capabilities available to the 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 of the parent account for hierarchical configurations such as Lock and Publish, On Your Behalf, Enterprise, and Enterprise 2.0 models. This value links the account to the business unit or enterprise structure that governs it. |
| BrandID | Int | False |
Specifies the Id of the branding profile that is associated with the account. Branding profiles provide sender identity details such as logos, colors, and footers that are applied to email assets. |
| PrivateLabelID | Int | False |
Specifies the Id of the private label configuration for the account. Private label settings control custom branding for login pages, navigation, and account-level interfaces. |
| ReportingParentID | Int | False |
Specifies the Id of the parent account that is used for consolidated reporting within an account hierarchy. This value determines which higher-level account receives aggregated metrics and roll-up reporting for the current business unit. |
| Name | String | False |
Specifies the name of the account as displayed in the Salesforce Marketing Cloud interface and in administrative tools. |
| String | False |
Specifies the default email address that is associated with the account. This address can be used for administrative communications and determines whether subscriber information is eligible for email sends. | |
| FromName | String | False |
[DEPRECATED] Specifies the default 'From Name' value that is applied to email messages. |
| BusinessName | String | False |
Specifies the business name of the account owner. This value often appears in email footers, compliance displays, and account-level branding. |
| Phone | String | False |
Specifies the primary phone number that is associated with the account owner or business entity. |
| Address | String | False |
Specifies the physical address that is used for compliance purposes when communicating with a person. This address can appear in the required footer of commercial messages. |
| Fax | String | False |
Specifies the fax number that is associated with the account owner, when it is applicable. |
| City | String | False |
Specifies the city portion of the account owner's physical mailing address. This value appears in the required footer of email messages. |
| State | String | False |
Specifies the geographic state or region that is associated with the account owner's physical mailing address. |
| Zip | String | False |
Specifies the postal or ZIP code of the account owner's physical mailing address. |
| Country | String | False |
Specifies the country associated with the account owner's physical mailing address. This value appears in the required footer of email messages to support compliance with regional regulations. |
| IsActive | Boolean | False |
Specifies whether the account is currently active. A value of 'true' indicates that the account can be used for sends, API requests, and administrative operations. |
| IsTestAccount | Bool | False |
Specifies whether the account is classified as a test account. A value of 'true' indicates that the account is designated for testing or non-production use. |
| Client_ClientID1 | Int | True |
Specifies the client Id that is associated with the account within the broader Salesforce Marketing Cloud client structure. |
| DBID | Int | False |
Specifies the internal database Id that Salesforce Marketing Cloud uses to reference the account within its underlying platform infrastructure. This value is system-generated, read-only, and not used in customer-facing operations. |
| CustomerID | Long | False |
Specifies the long-form internal customer Id that Salesforce Marketing Cloud assigns to the account for backend processing and system reconciliation. This value is system-generated, read-only, and not exposed in standard UI workflows. |
| DeletedDate | Datetime | True |
Specifies the date and time when the account was deleted or scheduled for deactivation. |
| EditionID | Int | False |
Specifies the edition of the Salesforce Marketing Cloud product that the account uses. Product editions determine feature availability and capacity limits. |
| ModifiedDate | Datetime | False |
Specifies the date and time when the account information was last modified through the interface or an API call. |
| CreatedDate | Datetime | False |
Specifies the date and time when the account was originally created within Salesforce Marketing Cloud. |
| ParentName | String | False |
Specifies the name of the parent account that appears in the account hierarchy. This value helps administrators understand business unit inheritance and governance relationships. |
| Subscription_SubscriptionID | String | True |
Specifies the internal subscription Id that Salesforce Marketing Cloud assigns for backend subscription management and billing alignment. This value is system-generated, read-only, and not surfaced in standard UI workflows. |
| Subscription_HasPurchasedEmails | Bool | True |
Indicates whether the subscription record is associated with purchased email-sending capacity. This value reflects backend subscription metadata and is not typically used in customer-facing operations. |
| Subscription_EmailsPurchased | Int | True |
Specifies the number of email sends that the account has purchased as part of its subscription. |
| Subscription_Period | String | True |
Specifies the subscription term that Salesforce Marketing Cloud records for internal billing and entitlement tracking. This value represents the period that is associated with the account's contracted services and is system-managed rather than used in customer-facing operations. |
| Subscription_AccountsPurchased | Int | True |
Specifies the total number of Salesforce Marketing Cloud accounts that are included in the subscription. |
| Subscription_LPAccountsPurchased | Int | True |
Specifies the number of Lock and Publish accounts that are purchased as part of the subscription. |
| Subscription_DOTOAccountsPurchased | Int | True |
Specifies the number of Salesforce Marketing Cloud agency reseller accounts that are purchased for the subscription. |
| Subscription_BUAccountsPurchased | Int | True |
Specifies the number of business units that are purchased for the subscription. |
| Subscription_AdvAccountsPurchased | Int | True |
Specifies the number of advertising accounts that are included in the subscription. |
| Subscription_BeginDate | Datetime | True |
Specifies the date when the subscription term begins. |
| Subscription_EndDate | Datetime | True |
Specifies the date when the subscription term ends. |
| Subscription_Notes | String | True |
[DEPRECATED] This field is no longer used. |
| PartnerKey | String | False |
Specifies the unique partner-supplied Id for the account. This value is available only through the API. |
| Client_PartnerClientKey | String | True |
Specifies the partner client key that is associated with the account within the partner integration. |
| InheritAddress | Bool | False |
Specifies whether an Enterprise 2.0 business unit inherits its physical address information from its parent business unit. |
| UnsubscribeBehavior | Int | True |
Specifies how the system handles unsubscribe actions for the account. The value determines the unsubscribe model that is applied. |
| Subscription_ContractNumber | String | True |
Specifies the contract number that is associated with the subscription. This value is not currently exposed in Salesforce Marketing Cloud but is expected to represent a contractual reference Id that licensing and billing systems use for cross-system reconciliation. |
| Subscription_ContractModifier | String | True |
Specifies an optional modifier value that is associated with the subscription contract. |
| IsTrialAccount | Bool | False |
Indicates whether the account operates under a trial subscription. This field is not currently in active use but is expected to help distinguish trial environments from paid environments for entitlement and feature-availability logic. |
| Client_EnterpriseID | Long | True |
Specifies the read-only Id of the enterprise to which the client belongs. |
| ParentAccount_ID | Int | False |
Specifies the read-only Id of the account's parent within the hierarchy. |
| ParentAccount_Name | String | True |
Specifies the name of the account's parent within the hierarchy. |
| ParentAccount_ParentID | Int | True |
Specifies the read-only Id of the parent's parent account within the hierarchy. |
| ParentAccount_CustomerKey | String | True |
Specifies the customer key for the parent account. The customer key uniquely identifies the parent account within its object type. |
| ParentAccount_AccountType | String | True |
Specifies the account type of the parent account (for example, an enterprise or business unit account). |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the account object within its object type. |
| Locale_LocaleCode | String | True |
Specifies the locale code that is associated with the account's localization settings. |
| TimeZone_ID | Int | True |
Specifies the read-only Id of the timezone that is assigned to the account. |
| TimeZone_Name | String | True |
Specifies the descriptive name of the timezone that is assigned to the account. |
| Roles | String | False |
Specifies the collection of roles that are assigned to the account for permission and access control. |
| ContextualRoles | Int | True |
Specifies the contextual role assignments that are applied to the account based on feature usage or business unit context. |
| ObjectState | String | False |
Specifies an internal state value that represents the account's current system-level condition. This field supports lifecycle tracking, such as indicating whether an account configuration is being provisioned, updated, or archived. |
| LanguageLocale_LocaleCode | String | True |
Specifies the locale code that is associated with the language layout for the account. |
| IndustryCode | String | False |
Specifies the industry classification code that is associated with the account. |
| AccountState | Int | False |
Specifies the operational state of the account, such as active or inactive. |
| SubscriptionRestrictionFlags | Long | False |
Specifies restriction settings that apply to the subscription. These flags control subscription-level limitations and operational constraints. |
Represents an individual user who belongs to a specific Salesforce Marketing Cloud account. Each user record includes details such as roles, permissions, and access settings. This table supports queries and updates but does not allow deletions to protect account integrity.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM AccountUser WHERE Id = 123 SELECT * FROM AccountUser WHERE Id IN (123, 456) SELECT * FROM AccountUser WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Client_Id, Name, Email, UserID, and Password.
INSERT INTO AccountUser (Client_Id, UserId, Name, Email, Password) VALUES (123, 'bcabsbasbcasb', 'Test', '[email protected]', 'testpas@2sowrd')
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
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the unique identifier (Id) that the system assigns to the account user record. |
| CreatedDate | Datetime | False |
Indicates the date and time when the account user record was created. This timestamp is maintained by the system. |
| ModifiedDate | Datetime | False |
Indicates the most recent date and time when the account user record was changed. This value helps track administrative updates and audit activity. |
| Client_ID [KEY] | Int | False |
Specifies the Id of the client that is associated with the account user. This value links the user to the appropriate Marketing Cloud client context. |
| AccountUserID | Int | False |
Specifies the Id that is assigned by Salesforce Marketing Cloud for the account user. This Id uniquely identifies the user within the account and is required for administrative and API-level operations. |
| UserID | String | False |
Specifies the Id of the user within the authentication and login system. This value is used for credential management and user lookup. |
| Name | String | False |
Specifies the display name that is associated with the user. This value appears in administrative interfaces and access-management tools. |
| String | False |
Specifies the primary email address that is associated with the user. This value is used for login, notifications, and administrative communication. | |
| MustChangePassword | Bool | False |
Returns a value of 'true' when the user must change their password at the next login. It returns a value of 'false' when no password change is required. |
| ActiveFlag | Bool | False |
Returns a value of 'true' when the user account is active and permitted to access the system. It returns a value of 'false' when the account is inactive or disabled. |
| ChallengePhrase | String | False |
Specifies the phrase that the user selects for login assistance workflows. This phrase helps verify the user's identity during account recovery. |
| ChallengeAnswer | String | False |
Specifies the answer that corresponds to the challenge phrase for login assistance. This value is validated during account recovery and authentication checks. |
| IsAPIUser | Bool | False |
Returns a value of 'true' when the user is authorized to authenticate through API methods. It returns a value of 'false' when the user can access the system only through the user interface. API-enabled users retain their passwords until those passwords are explicitly changed. |
| NotificationEmailAddress | String | False |
Specifies the email address to which system notifications, password alerts, and administrative messages for the user are sent. |
| Client_PartnerClientKey | String | False |
Specifies the partner client key that is associated with this user when the account is integrated with a partner system. This value is available through the API and supports partner-driven provisioning workflows. |
| Password | String | False |
Specifies the password that is assigned to the account user. This value is stored and handled according to Marketing Cloud's security protocols. |
| Locale_LocaleCode | String | True |
Specifies the locale code that defines the user's regional formatting for dates, numbers, and language preferences. |
| TimeZone_ID | Int | True |
Specifies the Id of the time zone that is associated with the user. This value determines how the platform displays time-based information to the user. |
| TimeZone_Name | String | True |
Specifies the name of the time zone that is associated with the user. This value provides a readable reference that aligns with the user's TimeZone_ID. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for this object within its object type. This value enables custom integration, mapping, and synchronization scenarios. |
| DefaultBusinessUnit | Int | False |
Specifies the business unit that the user accesses by default upon login. This value determines the user's initial workspace and content scope. |
| LanguageLocale_LocaleCode | String | True |
Specifies the locale code that determines the user's language and translation preferences within the interface. |
| Client_ModifiedBy | Int | False |
Specifies the Id of the user who most recently modified this account user record. This value supports auditing and administrative traceability. |
Represents a business unit within an Enterprise or Enterprise 2.0 Salesforce Marketing Cloud account. Each business unit defines a logical partition for users, data, and permissions. This table supports query and update operations but does not allow deletions to maintain enterprise hierarchy integrity.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BusinessUnit WHERE Id = 123 SELECT * FROM BusinessUnit WHERE Id IN (123, 456) SELECT * FROM BusinessUnit WHERE CreatedDate > '2017/01/25'
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE BusinessUnit SET Name = 'Changed' WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the system-generated identifier (Id) that uniquely represents the business unit within the Marketing Cloud hierarchy. |
| AccountType | String | False |
Specifies the Salesforce Marketing Cloud account classification assigned to the business unit. Valid values include BUSINESS_UNIT, CHANNEL_CONNECT, CONNECT, DOTO_MEMBER, ENTERPRISE_2, EXACTTARGET, LP_MEMBER, None, PRO_CONNECT, and PRO_CONNECT_CLIENT. This classification determines feature access, provisioning rules, and administrative scope. |
| ParentID | Int | False |
Specifies the Id of the parent account or enterprise business unit. This value determines the hierarchical structure that governs permissions, shared content, and inherited settings. |
| BrandID | Int | False |
Specifies the branding profile that is associated with the business unit. This value determines which brand tags and identity properties apply to messages sent from the unit. |
| PrivateLabelID | Int | False |
Specifies the private label configuration that is associated with the business unit. This configuration customizes interface elements and branding in supported contexts. |
| ReportingParentID | Int | False |
Specifies the Id of the parent account used for consolidated roll-up reporting. This value determines where the business unit's tracking and performance metrics aggregate within an enterprise hierarchy. |
| Name | String | False |
Specifies the display name that is assigned to the business unit. This value appears in Salesforce Marketing Cloud Administration and in business-unit selection menus. |
| String | False |
Specifies the default email address that is associated with the business unit. Systems use this address as the default sender context when subscriber information does not provide an override. | |
| FromName | String | False |
Specifies the default 'From Name' value that is used for email messages that originate from the business unit. This value helps establish sender identity in outbound communications. |
| BusinessName | String | False |
Specifies the legal or operational business name that is associated with the business unit. This value is included in required physical mailing address components in email footers. |
| Phone | String | False |
Specifies the contact phone number that is associated with the business unit. This value appears in compliance-required physical address details. |
| Address | String | False |
Specifies the mailing address that is associated with the business unit. This address appears in the physical address footer that all compliant email messages must include. |
| Fax | String | False |
Specifies the fax number that is associated with the business unit. This value is maintained for completeness within the physical address profile. |
| City | String | False |
Specifies the city component of the business unit's physical mailing address. This value appears in the required footer of all outbound email messages. |
| State | String | False |
Specifies the state component of the physical mailing address associated with the business unit. |
| Zip | String | False |
Specifies the postal or zip code for the business unit's physical address. |
| Country | String | False |
Specifies the country component of the physical mailing address that is associated with the business unit. |
| IsActive | Bool | False |
Returns a value of 'true' when the business unit is active and available for use. It returns a value of 'false' when the business unit is inactive or restricted through administrative controls. |
| IsTestAccount | Bool | False |
Returns a value of 'true' when the business unit is designated as a test account. It returns a value of 'false' when the business unit operates as a production environment. |
| Client_ID | Int | False |
Specifies the internal client Id that is assigned to the business unit. This value determines the organizational and billing scope of the unit. |
| DBID | Int | False |
Specifies an internal database Id that is maintained for system-level operations. This value is not used in customer-facing processes. |
| CustomerID | Long | False |
Specifies the customer-level Id that is associated with the business unit. This value supports billing, entitlements, and account provisioning. |
| DeletedDate | Datetime | False |
Specifies the date and time when the business unit was marked for deletion. Administrators must set this value before the system can remove the business unit. |
| EditionID | Int | False |
Specifies the Salesforce Marketing Cloud product edition assigned to the business unit. This edition determines available features and entitlement boundaries. |
| IsTrialAccount | Bool | False |
Returns a value of 'true' when the business unit operates under a trial subscription. It returns a value of 'false' when the business unit is fully licensed. |
| Locale_LocaleCode | String | True |
Specifies the locale code that determines the business unit's default regional formatting, such as date, time, and number display rules. |
| Client_EnterpriseID | Long | True |
Specifies the enterprise-level Id that is associated with the business unit. This value defines the top-level organizational context for hierarchy and permissions. |
| ModifiedDate | Datetime | False |
Indicates the most recent date and time when the business unit's configuration or metadata was updated. |
| CreatedDate | Datetime | False |
Specifies the date and time when the business unit was created within the enterprise hierarchy. |
| Subscription_SubscriptionID | String | True |
Specifies the internal subscription Id that is associated with the business unit's licensed services. This value supports contract alignment and entitlement tracking. |
| Subscription_HasPurchasedEmails | Bool | True |
Returns a value of 'true' when the subscription record is associated with purchased email-sending capacity. It returns a value of 'false' when the subscription does not include email sends. |
| Subscription_EmailsPurchased | Int | True |
Specifies the number of email messages that the business unit is licensed to send under its subscription agreement. |
| Subscription_Period | String | True |
Specifies the subscription term that Salesforce Marketing Cloud records for internal billing and entitlement tracking. This value represents the contract period that is associated with licensed services. |
| Subscription_AccountsPurchased | Int | True |
Specifies the number of Salesforce Marketing Cloud accounts that are included in the subscription. This value determines how many child business units the organization can provision. |
| Subscription_LPAccountsPurchased | Int | True |
Specifies the number of Lock and Publish accounts that the subscription supports. These accounts enable controlled asset distribution and governance. |
| Subscription_DOTOAccountsPurchased | Int | True |
Specifies the number of Salesforce Marketing Cloud agency reseller accounts that are included in the subscription. These accounts support distributed operations across multiple customer entities. |
| Subscription_BUAccountsPurchased | Int | True |
Specifies the number of business units that the subscription allows the customer to create within the enterprise hierarchy. |
| Subscription_AdvAccountsPurchased | Int | True |
Specifies the number of advertising accounts that the business unit is licensed to use. These accounts support integrated advertising activities across connected channels. |
| Subscription_BeginDate | Datetime | True |
Specifies the date and time when the subscription term for the business unit begins. This value determines when licensed capabilities and entitlements become active. |
| Subscription_EndDate | Datetime | True |
Specifies the date and time when the subscription term ends. This value determines when licensed services expire unless the subscription is renewed. |
| Subscription_Notes | String | True |
Contains internal notes or annotations that are associated with the subscription record. This field is retained for compatibility but is not commonly used in modern subscription workflows. |
| Subscription_ContractNumber | String | True |
Specifies the contract number that is associated with the business unit's subscription. This value supports internal billing, licensing reconciliation, and cross-system contract tracking. |
| Subscription_ContractModifier | String | True |
Specifies an optional modifier or qualifier that is associated with the subscription contract. This value can represent amendments or special terms that affect the contract configuration. |
| PartnerKey | String | False |
Specifies the unique partner-supplied Id that is associated with the business unit. This value is available only through the API and allows external systems to map or track the account consistently. |
| Client_PartnerClientKey | String | True |
Specifies the partner client key that external systems provide for the business unit. This value enables cross-system reference, synchronization, and partner-level reporting. |
| ParentName | String | False |
Specifies the display name of the parent account that governs the business unit. This value reflects the hierarchical structure within the enterprise. |
| ParentAccount_ID | Int | True |
Specifies the Id of the parent account in the Salesforce Marketing Cloud hierarchy. This value determines which account provides inherited settings and administrative oversight. |
| ParentAccount_Name | String | True |
Specifies the display name of the parent account from which the business unit inherits configuration and permissions. |
| CustomerKey | String | False |
Specifies the user-defined unique Id that is assigned to the business unit within its object type. This value supports cross-system references and environment migrations. |
| Description | String | False |
Provides a human-readable description that communicates the purpose, characteristics, or administrative role of the business unit within the enterprise. |
| DefaultSendClassification_ObjectID | String | True |
Specifies the system-controlled, read-only Id of the default send classification that governs how commercial or transactional sends are defined for the business unit. |
| DefaultHomePage_ID | String | True |
Specifies the Id of the home page that users see when they access the business unit. This value determines the default landing experience in the user interface. |
| InheritAddress | Bool | False |
Returns a value of 'true' when the business unit inherits its address information from its parent account. It returns a value of 'false' when the business unit maintains its own address configuration. |
| ContextualRoles | Int | True |
Specifies the contextual role assignments that apply to the business unit. These values determine which permissions, capabilities, and feature-level access rights are available within this specific account context. |
| LanguageLocale_LocaleCode | String | True |
Specifies the locale code that governs language presentation within the business unit. This value determines the regional language format used in the interface. |
Represents a content area (ContentArea) in Salesforce Marketing Cloud. A ContentArea defines a reusable section of content, such as text, images, or dynamic blocks, that can be inserted into multiple messages or templates. This table allows you to manage reusable content elements to ensure brand consistency and efficiency.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ContentArea WHERE Id = 123 SELECT * FROM ContentArea WHERE Id IN (123, 456) SELECT * FROM ContentArea WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name and Content.
INSERT INTO ContentArea (Name, Content) VALUES ('Testing', 'Hello world')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE ContentArea SET Name = 'Changed' WHERE Id = 123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM ContentArea WHERE Id = 123
| Name | Type | ReadOnly | Description |
| RowObjectID | String | False |
Specifies the system-controlled text string that uniquely identifies the individual row that represents the content area in the underlying data store. This value supports internal tracking and record reconciliation. |
| ObjectID | String | False |
Specifies the system-controlled text string that uniquely identifies the content area object across API operations. This value ensures consistency when retrieving or updating content assets. |
| ID [KEY] | Int | False |
Specifies the system-generated identifier (Id) that uniquely represents the content area within Salesforce Marketing Cloud. This Id is read-only and supports administrative and programmatic reference. |
| CustomerKey | String | False |
Specifies the user-defined unique Id that is assigned to the content area within its object type. This value enables external systems and templates to reference the content area consistently across environments. |
| Client_ID | Int | False |
Specifies the Id of the client context that is associated with the content area. This value determines the business unit in which the content area exists. |
| ModifiedDate | Datetime | False |
Indicates the most recent date and time when the content area was updated. This value helps administrators track editorial and configuration changes. |
| CreatedDate | Datetime | False |
Specifies the date and time when the content area was created. This value supports lifecycle tracking and audit requirements. |
| CategoryID | Int | False |
Specifies the Id of the folder in which the content area is stored within Content Builder. This value supports folder-based organization and access control. |
| Name | String | False |
Specifies the name that has been assigned to the content area. This value appears in Content Builder, search results, and API responses. |
| Layout | String | False |
Specifies the layout type that is associated with the content area. This value determines how the content is structured or rendered in downstream email or content blocks. |
| IsDynamicContent | Bool | False |
Returns a value of 'true' when the content area contains dynamic content that renders different output based on subscriber attributes or rules. It returns a value of 'false' when the content area contains static content only. |
| Content | String | False |
Specifies the HTML or text content that the content area contains. This value represents the primary material used in email and template rendering. |
| IsSurvey | Bool | False |
Returns a value of 'true' when the content area includes survey-related material that is intended to collect responses or feedback. It returns a value of 'false' when the content area does not include survey elements. |
| IsBlank | Bool | False |
Returns a value of 'true' when the content area contains no content. It returns a value of 'false' when any content, markup, or whitespace is present. |
| Key | String | False |
Specifies the internal key that Salesforce Marketing Cloud uses to reference the content area when it is included in HTML bodies or template constructs. This value ensures proper resolution during rendering. |
Represents a data extension within a Salesforce Marketing Cloud account. A data extension is a custom table that stores subscriber or relational data used for segmentation, personalization, or automation. This table allows you to query, create, and manage data structures that support targeted communications.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtension WHERE CreatedDate > '2017/01/25'
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')
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'
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'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled identifier (Id) that uniquely identifies the data extension object. This value is assigned internally and cannot be modified by users. |
| PartnerKey | String | False |
Specifies the unique partner-provided key that is associated with the data extension. This value is available only through API interactions. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the data extension within its object type. This value is often used in programmatic operations and configuration workflows. |
| Name | String | False |
Specifies the name of the data extension. The value is visible in the user interface and is used to identify the resource in Salesforce Marketing Cloud applications. |
| CreatedDate | Datetime | False |
Indicates the date and time when the data extension was created. This value is system-controlled. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the system last modified the data extension. This information assists with auditing and lifecycle tracking. |
| Client_ID | Int | False |
Specifies the Id of the client associated with the data extension. |
| Description | String | False |
Provides descriptive information about the purpose and usage of the data extension. This text helps administrators and developers understand the intended function of the stored data. |
| IsSendable | Bool | False |
Returns a value of 'true' when the data extension can be used as a sendable audience in message sends. It returns a value of 'false' when the data extension is not eligible for send operations. |
| IsTestable | Bool | False |
Returns a value of 'true' when the data extension can be used in test sends. It returns a value of 'false' when the data extension cannot participate in test send processes. |
| SendableDataExtensionField_Name | String | False |
Specifies the name of the sendable field within the data extension. This field must correspond to a value that can be mapped to a subscriber identifier. |
| SendableSubscriberField_Name | String | False |
Specifies the name of the subscriber field to which the sendable data-extension field is mapped. This mapping establishes the subscriber context used during email sends. |
| Template_CustomerKey | String | False |
Specifies the user-supplied unique Id of the data extension template, if one is used. This value identifies the template structure from which the data extension was created. |
| CategoryID | Long | False |
Specifies the Id of the folder that stores the data extension in the folder hierarchy. |
| Status | String | False |
Indicates the status of the data extension. This value represents conditions such as active, inactive, or deleted. |
| IsPlatformObject | Bool | False |
Returns a value of 'true' when the data extension is classified as a platform object. It returns a value of 'false' when the data extension does not qualify as a platform-level resource. |
| DataRetentionPeriodLength | Int | False |
Specifies the number of time units that determine how long the data extension retains stored records before removal. |
| DataRetentionPeriodUnitOfMeasure | Int | False |
Specifies the unit of time (for example, days or months) that is associated with the data retention period. |
| RowBasedRetention | Bool | False |
Returns a value of 'true' when the data retention policy removes records based on individual rows. It returns a value of 'false' when the system deletes the entire data extension at the end of the retention cycle. |
| ResetRetentionPeriodOnImport | Bool | False |
Returns a value of 'true' when a successful import causes the retention period to restart. It returns a value of 'false' when the retention period continues without being reset after imports. |
| DeleteAtEndOfRetentionPeriod | Bool | False |
Returns a value of 'true' when the data extension is deleted at the end of its retention period. It returns a value of 'false' when the data extension remains available after the retention period ends. |
| RetainUntil | String | False |
Specifies the date that marks the end of the retention period for the data extension. This value is system-calculated based on the configured retention policy. |
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 |
Specifies a semicolon-separated list of field names that should be added to the data extension. This value is a pseudocolumn used for defining field creation operations. |
Represents an email object in Salesforce Marketing Cloud. Each record contains metadata about an email message, including subject, content area references, and send configurations. This table is used to query or manage email assets that are stored and deployed from the account.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Email WHERE Id = 123 SELECT * FROM Email WHERE Id IN (123, 456) SELECT * FROM Email WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name and Subject.
INSERT INTO Email (Name, Subject) VALUES ('Testing', 'Greetings')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Email SET Name = 'Changed' WHERE Id = 31558
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Email WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the identifier (Id) that uniquely identifies the email asset within Marketing Cloud. |
| PartnerKey | String | False |
Specifies the partner-provided unique Id that is associated with the email asset and is accessible only through the API. |
| CreatedDate | Datetime | False |
Indicates the date and time when the email asset was created. This value is generated automatically by the system. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the email asset was last modified. This value updates whenever the email content or configuration changes. |
| Client_ID | Int | False |
Specifies the Id of the client account that owns the email asset. |
| Name | String | False |
Specifies the display name of the email asset, which appears in the user interface and in retrieval operations. |
| PreHeader | String | False |
Contains the text that appears as the preheader for the email message on supported devices. This value provides preview context before the recipient opens the message. |
| Folder | String | False |
[DEPRECATED] Specifies informational folder metadata that is returned during retrieval. |
| CategoryID | Int | False |
Specifies the Id of the folder that stores the email asset within the Content Builder hierarchy. |
| HTMLBody | String | False |
Contains the HTML markup that defines the visual structure and content of the email message. |
| TextBody | String | False |
Contains the plain-text version of the email message that is used for recipients who receive non-HTML messages. |
| Subject | String | False |
Specifies the subject line of the email message, which appears in the recipient's inbox. |
| IsActive | Bool | False |
Returns a value of 'true' when the email asset is active and available for use in sends. It returns a value of 'false' when the asset is inactive or restricted through administrative controls. |
| IsHTMLPaste | Bool | False |
Returns a value of 'true' when the email message is created from pasted HTML rather than through the visual editor. It returns a value of 'false' when the email is created using other editing methods. |
| ClonedFromID | Int | False |
Specifies the Id of the source email from which the current email asset was cloned. This value helps track template or content lineage. |
| Status | String | False |
Specifies the current operational status of the email asset (for example, draft, published, or archived). |
| EmailType | String | False |
Specifies the preferred email format associated with the asset (for example, HTML or text-only). |
| CharacterSet | String | False |
Indicates the character encoding that is used in the email message to support proper rendering of special characters. |
| HasDynamicSubjectLine | Bool | False |
Returns a value of 'true' when the email message uses dynamic content to personalize the subject line at send time. It returns a value of 'false' when the subject line remains static for all recipients. |
| ContentCheckStatus | String | False |
Indicates the current validation state for the email's content, which reflects whether content checks have completed successfully or are still in progress. |
| Client_PartnerClientKey | String | False |
Specifies the partner client key that is associated with the account that owns the email asset. |
| ContentAreas | String | False |
Contains information about the content areas that are referenced within the email message, including any reusable or dynamic content blocks. |
| CustomerKey | String | False |
Specifies the user-supplied unique identifier for the email asset within its object type. |
Stores email send definitions in Salesforce Marketing Cloud. Each record includes message details, sender and delivery profiles, and audience configurations. This table allows you to define and manage parameters that control how and when emails are sent to subscribers.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM EmailSendDefinition WHERE ObjectID = 123 SELECT * FROM EmailSendDefinition WHERE ObjectID IN (123, 456) SELECT * FROM EmailSendDefinition WHERE CreatedDate > '2017/01/25'
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)
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE EmailSendDefinition SET Description = 'Changed' WHERE ObjectId = 'acasascas'
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM EmailSendDefinition WHERE ObjectId = 'sdfsdf123'
| Name | Type | ReadOnly | Description |
| Client_ID | Int | True |
Specifies the identifier (Id) of the client account that owns the send definition within Marketing Cloud. |
| CreatedDate | Datetime | False |
Indicates the date and time when the send definition was created. This value is generated automatically by the system. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the send definition was last modified. This value updates whenever configuration properties or delivery settings change. |
| ObjectID | String | False |
Contains the system-controlled text string Id that uniquely represents the send definition across internal services and API operations. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the send definition within its object type. This key is often used in API-based send operations and retrieval calls. |
| Name | String | False |
Defines the display name of the send definition that appears in the user interface and within associated send workflows. |
| CategoryID | Int | False |
Specifies the Id of the folder that stores the send definition within the Content Builder or Email Studio hierarchy. |
| Description | String | False |
Provides a descriptive explanation of the send definition's purpose, configuration, or business context. |
| SendClassification_CustomerKey | String | False |
Specifies the user-defined unique Id for the send classification that governs CAN-SPAM classification, delivery profile, and sender profile settings. |
| SenderProfile_CustomerKey | String | True |
Specifies the user-defined unique Id for the sender profile that controls the visible sender information for outbound email messages. |
| SenderProfile_FromName | String | True |
Defines the display name that appears in the email's 'From' field when the send definition is used. |
| SenderProfile_FromAddress | String | True |
Specifies the email address that appears in the 'From' field for the send definition's outbound messages. |
| DeliveryProfile_SourceAddressType | String | True |
Indicates the type of source internet protocol (IP) address that the delivery profile uses for message delivery (for example, default or dedicated IP pools). |
| DeliveryProfile_PrivateIP | String | True |
Contains information about the private IP addresses that are assigned to the delivery profile for routing outbound email traffic. |
| DeliveryProfile_DomainType | String | True |
Defines the domain type (for example, a default domain or a private authenticated domain) that is used by the delivery profile. |
| DeliveryProfile_PrivateDomain | String | True |
Specifies the private domain that the delivery profile uses for authenticated sending or domain alignment within deliverability configurations. |
| DeliveryProfile_HeaderSalutationSource | String | True |
Defines the source for the header salutation (for example, a profile attribute, a default value, or a content-derived value) that is applied to outbound messages . |
| DeliveryProfile_FooterSalutationSource | String | True |
Defines the source of the footer salutation applied to outbound messages. Valid options include Default, ContentLibrary, or None. |
| SuppressTracking | Bool | False |
Returns a value of 'true' when the send definition is configured to suppress tracking data for opens and clicks. It returns a value of 'false' when tracking metrics are fully captured and reported. |
| IsSendLogging | Bool | False |
Returns a value of 'true' when send logging is enabled for the send definition, allowing send-level data to be captured in a designated data extension. It returns a value of 'false' when logging is disabled. |
| Email_ID | Int | True |
Specifies the Id of the email asset that is associated with the send definition. |
| CCEmail | String | False |
Specifies one or more carbon copy (CC) email addresses that should receive copies of the outbound message. |
| BccEmail | String | False |
Specifies one or more blind carbon copy (BCC) email addresses that should receive copies of the outbound message without visibility to other recipients. |
| AutoBccEmail | String | False |
Defines the automatically applied BCC address that receives a copy of every message sent through the send definition. |
| TestEmailAddr | String | False |
Specifies an email address that is used to send test messages for validation prior to execution of a production send. |
| EmailSubject | String | False |
Defines the static subject line that is applied to messages sent through the send definition. |
| DynamicEmailSubject | String | False |
Contains subject-line content that can be personalized dynamically for recipients during send processing. |
| IsMultipart | Bool | False |
Returns a value of 'true' when the email is sent using Multipart/MIME formatting to deliver both HTML and plain-text versions. It returns a value of 'false' when a single-part format is used. |
| IsWrapped | Bool | False |
Returns a value of 'true' when link-wrapping is enabled to support click tracking within the message. It returns a value of 'false' when the message's links are not wrapped for tracking purposes. |
| SendLimit | Int | False |
Specifies the maximum number of messages that can be sent through the send definition within a predefined send window. |
| DeduplicateByEmail | Bool | False |
Returns a value of 'true' when the send definition removes duplicate email addresses before sending. It returns a value of 'false' when duplicate addresses are preserved. |
| ExclusionFilter | String | False |
Contains AMPscript logic that evaluates to a Boolean result to determine whether a recipient should be excluded from the send. |
| Additional | String | False |
Specifies a campaign-related Id that is associated with the send, often used for reporting or external system correlation. |
| IsPlatformObject | Bool | False |
Returns a value of 'true' when the send definition is classified as a platform-level object for internal use. It returns a value of 'false' when the object is not platform-scoped. |
Represents configuration data that defines file-based automation triggers within Salesforce Marketing Cloud. A file trigger initiates an automation when a file is placed in a designated Enhanced FTP location, enabling automated imports or other workflow actions that begin upon file detection. This table does not support delete operations.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) query is processed server side:
SELECT * FROM FileTrigger WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: Name.
INSERT INTO FileTrigger (Name) VALUES ('Testing')
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'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Contains the system-controlled text string identifier (Id) that uniquely represents the file-trigger configuration across internal services and API operations. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the file-trigger configuration within its object type. |
| Client_ID | Long | False |
Specifies the Id of the client account that owns the file-trigger configuration. |
| ExternalReference | String | False |
Provides an external reference value that is reserved for future integration or orchestration scenarios. |
| Name | String | False |
Defines the display name that is assigned to the file-trigger configuration in the user interface. |
| Description | String | False |
Provides a descriptive explanation of the file-trigger configuration and its intended purpose within data import or automation workflows. |
| Type | String | False |
Indicates the list type that is associated with the file-trigger configuration. Valid values include Public, Private, Salesforce, GlobalUnsubscribe, and Master. |
| Status | String | False |
Defines the current operational state of the file-trigger configuration (for example, active, inactive, or processing). |
| StatusMessage | String | False |
Contains a system-generated message that describes the most recent status returned by an API call or automation process. |
| RequestParameterDetail | String | False |
Contains supplemental request-parameter information that is captured during file-trigger processing. This value provides additional context for downstream automation, tracking, or diagnostic workflows that evaluate how the trigger was invoked. |
| ResponseControlManifest | String | False |
Captures system-generated response details that describe how the file-trigger operation was handled. This value provides structured information that downstream automation or monitoring tools can reference when evaluating trigger outcomes or execution paths. |
| FileName | String | False |
Specifies the name of the file that is associated with the file-trigger configuration, including its extension. |
| LastPullDate | Datetime | False |
Indicates the most recent date and time when the system attempted to retrieve or evaluate a file that is associated with the file-trigger configuration. This value helps track historical pull activity for auditing or troubleshooting. |
| ScheduledDate | Datetime | False |
Indicates the date and time when the file-trigger process is scheduled to execute according to its configuration. This timestamp helps align trigger activity with expected automation timing and supports auditing or monitoring workflows. |
| IsActive | Bool | False |
Returns a value of 'true' when the file-trigger configuration is enabled for evaluation or processing. It returns a value of 'false' when the configuration is disabled or inactive. |
| CreatedDate | Datetime | False |
Indicates the date and time when the file-trigger configuration was created. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the file-trigger configuration was last modified. |
| Client_CreatedBy | Int | False |
Returns the Id of the user who created the file-trigger configuration. |
| Client_ModifiedBy | Int | False |
Returns the Id of the user who last modified the file-trigger configuration. |
Defines audience segmentation filters in Salesforce Marketing Cloud. Each filter specifies logical rules that identify which contacts or subscribers meet specific criteria. This table supports update and query operations but does not allow inserts, as filters are managed within the platform interface.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) query is processed server side:
SELECT * FROM FilterDefinition WHERE CreatedDate > '2017/01/25'
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'
You must specify the ObjectId in the WHERE clause when executing a delete against this table.
DELETE FROM FilterDefinition WHERE Object = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Stores the system-controlled text string identifier (Id) that uniquely identifies the filter definition within Salesforce Marketing Cloud. This value is read-only and ensures consistent reference across filtering, segmentation, and automation activities. |
| Client_ID | Int | True |
Specifies the client Id that associates this filter definition with the correct Salesforce Marketing Cloud account or business unit. This value ensures that filtering logic executes in the appropriate account context. |
| Client_ClientPartnerKey | Int | True |
Stores the partner-assigned client key that links this filter definition to an external integration or partner system. This value provides cross-system traceability when filtering logic originates outside Salesforce Marketing Cloud. |
| Name | String | False |
Provides the display name of the filter definition. This value identifies the definition in the user interface and in API responses. |
| CustomerKey | String | False |
Stores the user-supplied unique Id for the filter definition. This Id corresponds to the external key that is used to reference the definition in API calls and automated workflows. |
| CreatedDate | Datetime | False |
Indicates the date and time when the filter definition was created. This timestamp supports auditing and version control in segmentation workflows. |
| ModifiedDate | Datetime | False |
Indicates the most recent date and time when the filter definition was modified. This value helps track updates to filtering logic and assists with troubleshooting. |
| Description | String | False |
Provides a detailed explanation of the purpose, criteria, and expected use of the filter definition. This text supports documentation efforts and improves maintainability. |
| DataSource_ID | Int | True |
Specifies the read-only numeric Id that identifies the data source used by the filter definition. The data source determines where the filter criteria are applied. |
| DataSource_ObjectID | String | True |
Stores the system-controlled text string Id that uniquely identifies the data source that is associated with the filter definition. This Id ensures consistent reference across data views and segmentation processes. |
| DataSource_Name | Int | True |
Provides the name of the data source that supplies the records being filtered. This value identifies the origin of the data used in the filtering operation. |
| DataSource_ListName | Int | True |
Specifies the list name that is associated with the data source when the filter definition references a subscriber list. This value helps identify the audience segment being targeted. |
| DataSource_CustomerKey | String | True |
Stores the user-supplied unique Id for the data source. This Id corresponds to the external key used to reference the data source in API operations. |
| DataSource_CreatedDate | Datetime | True |
Indicates the date and time when the associated data source was created. This timestamp helps track data lineage and dependency timing. |
| DataSource_ModifiedDate | Datetime | True |
Indicates the most recent date and time when the associated data source was modified. This value supports auditing and consistency checking when filter logic relies on evolving data structures. |
| DataFilter | String | False |
Contains the defined filtering criteria expressed as one or more filter parts. These criteria determine how the system evaluates records from the underlying data source to produce a targeted segmentation output. |
Defines reusable import definitions in Salesforce Marketing Cloud. Each import definition specifies the file location, mapping, and data extension target for recurring import operations. This table supports query and update operations, but it does not allow inserts because imports are configured through the application interface.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportDefinition WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM ImportDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM ImportDefinition WHERE CreatedDate > '2017/01/25'
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'
You must specify the ObjectId in the WHERE clause when executing a delete against this table.
DELETE FROM ImportDefinition WHERE ObjectId = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string identifier (Id) that uniquely represents this import definition object. |
| PartnerKey | String | False |
Specifies the unique partner-provided Id for this object, which is accessible only through API-level integrations. |
| Client_ClientID1 | Int | False |
Specifies the client Id that is associated with the account context in which this import definition operates. |
| Name | String | False |
Specifies the name of the import definition. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for this import definition within its object type. |
| Description | String | False |
Provides descriptive information that explains the purpose and configuration of the import definition. |
| FileSpec | String | False |
Specifies the file-naming pattern that the import process expects. Valid substitutions include %%YEAR%%, %%MONTH%%, and %%DAY%%, which allow dynamic file-name resolution. |
| AllowErrors | Bool | False |
Returns a value of 'true' when the import is permitted to continue after an error occurs. It returns a value of 'false' when the import must stop upon encountering an error. |
| FieldMappingType | String | False |
Specifies how the system maps fields between the imported file and the destination data structure for this import definition. |
| FileType | String | False |
Specifies the column delimiter type that is used in the import file (for example, 'CSV', 'TAB', or 'Other'). |
| UpdateType | String | False |
Specifies the update behavior that is applied to records during the import process. |
| MaxFileAge | Int | False |
Specifies the maximum allowable age, expressed in hours, of the oldest file that can be included in this import definition. |
| MaxFileAgeScheduleOffset | Int | False |
Specifies the number of hours used as an offset when calculating file age, which allows the import schedule to account for timezone differences. |
| MaxImportFrequency | Int | False |
Specifies the minimum number of hours the system must wait before allowing another file to be imported. |
| DestinationObject_ID | Int | False |
Specifies the destination object's Id. |
| DestinationObject_ObjectID | String | False |
Specifies the system-controlled text string Id of the destination object. |
| Notification_ResponseType | String | True |
Specifies the notification response type that is used when the import process generates a notification. |
| Notification_ResponseAddress | String | False |
Specifies the email address or endpoint to which the import notification should be sent. |
| RetrieveFileTransferLocation_ObjectID | String | False |
Specifies the system-controlled text string Id of the file transfer location from which import files are retrieved. |
| Delimiter | String | False |
Specifies the delimiter that is used to separate data within the imported file. |
| HeaderLines | Int | False |
Specifies the number of header lines in the file that should be ignored during processing. |
| EndOfLineRepresentation | String | False |
Specifies the line-ending character or character sequence that is used in the import file. |
| NullRepresentation | String | False |
Specifies the character or sequence that represents a null value during the import process. |
| StandardQuotedStrings | Bool | False |
Returns a value of 'true' when the import process uses standard quoted-string handling. It returns a value of 'false' when the import process uses non-standard handling. |
| DateFormattingLocale_LocaleCode | String | False |
Specifies the locale code that is used to interpret date formats during the import process. |
Represents subscriber lists in Salesforce Marketing Cloud. A list defines a group of subscribers that share common attributes or purposes, such as newsletter recipients or event registrants. This table supports list management operations including queries, inserts, and updates.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM List WHERE Id = 123 SELECT * FROM List WHERE Id IN (123, 456) SELECT * FROM List WHERE CreatedDate > '2017/01/25'
You must specify the following field when inserting to this table: ListName.
INSERT INTO List (ListName) VALUES ('Test')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE List SET ListName = 'Changed' WHERE Id = 123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM List WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the identifier (Id) that uniquely identifies the list. |
| ObjectID | String | False |
Specifies the system-controlled text string Id that is assigned to the list object for internal tracking. |
| PartnerKey | String | False |
Specifies the unique Id that is provided by a partner for the list when it is accessed through the API. |
| CreatedDate | Datetime | False |
Indicates the date and time when the list was created. |
| ModifiedDate | Datetime | False |
Indicates the date and time when information about the list was last modified. |
| Client_ID | Int | False |
Specifies the Id of the client that owns or manages the list. |
| Client_PartnerClientKey | String | False |
Specifies the partner-defined client key that is associated with the account. |
| ListName | String | False |
Specifies the name that is assigned to the list. |
| Description | String | False |
Provides descriptive information about the purpose, use case, or contents of the list. |
| Category | Int | False |
Specifies the Id of the folder where the list is stored within the account's folder structure. |
| Type | String | False |
Specifies the type of list. Valid values include 'Public', 'Private', 'Salesforce', 'GlobalUnsubscribe', and 'Master'. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the list within the list object type. |
| ListClassification | String | True |
Specifies the classification that defines how the list behaves within Salesforce Marketing Cloud Cloud, such as for subscription management or audience segmentation. |
| AutomatedEmail_ID | Int | False |
Specifies the Id of the automated email configuration that is associated with this list. |
Represents a file that is stored in the portfolio of a Salesforce Marketing Cloud account. Each record includes file metadata such as name, type, and storage location. This table supports query and management of digital assets that are uploaded or referenced across campaigns.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM Portfolio WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
SELECT * FROM Portfolio WHERE CreatedDate > '2017/01/25'
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')
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'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM Portfolio WHERE ObjectID = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| RowObjectID | String | False |
Specifies the system-generated identifier (Id) for the specific row within the Portfolio object. |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string that serves as the unique object Id for the Portfolio item. |
| PartnerKey | String | False |
Specifies the partner-provided unique Id that external systems use to reference the Portfolio item through the API. |
| CustomerKey | String | False |
Specifies the user-supplied unique identifier for the Portfolio item within the object type. |
| Client_ID | Int | False |
Specifies the Id of the client that is associated with the Portfolio item. |
| CategoryID | Int | False |
Specifies the Id of the folder that contains the Portfolio item. |
| FileName | String | False |
Specifies the file name that is associated with the Portfolio item, including any applicable extensions. |
| DisplayName | String | False |
Specifies the human-readable name that appears for the Portfolio item in user interfaces. |
| Description | String | False |
Provides descriptive and informational text that explains the purpose, contents, or usage of the Portfolio item. |
| TypeDescription | String | False |
Provides descriptive information about the type or classification of the Portfolio item. |
| IsUploaded | Bool | False |
Returns a value of 'true' when the Portfolio item originates from an uploaded file. It returns a value of 'false' when the file is system-generated or sourced from another internal process. |
| IsActive | Bool | False |
Returns a value of 'true' when the Portfolio item is active and available for use in Salesforce Marketing Cloud. It returns a value of 'false' when the item is inactive, archived, or restricted by administrative controls. |
| FileSizeKB | Int | False |
Specifies the file size of the Portfolio item in kilobytes. |
| ThumbSizeKB | Int | False |
Specifies the size in kilobytes of the thumbnail image that is associated with the Portfolio item. |
| FileWidthPX | Int | False |
Specifies the width of the Portfolio item's image in pixels. |
| FileHeightPX | Int | False |
Specifies the height of the Portfolio item's image in pixels. |
| FileURL | String | False |
Specifies the URL where the Portfolio file is stored and accessed for rendering or download. |
| ThumbURL | String | False |
Specifies the URL of the thumbnail image that corresponds to the Portfolio item. |
| CacheClearTime | Datetime | False |
Indicates the date and time when cached versions of the Portfolio item were last cleared to ensure updated rendering or retrieval. |
| CategoryType | String | False |
Specifies whether the Portfolio folder is shared with other account users. Valid values are 'shared_portfolio' and 'media'. |
| CreatedDate | Datetime | False |
Indicates the date and time when the Portfolio item was created. |
| CreatedBy | Int | False |
Specifies the Id of the user who created the Portfolio item. |
| ModifiedBy | Int | False |
Specifies the Id of the user who last modified the Portfolio item. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the Portfolio item was most recently modified. |
| ModifiedByName | String | True |
Specifies the name of the user who most recently modified the Portfolio item. |
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 |
Specifies the uniform resource name (URN) that identifies the original storage location of the Portfolio item. |
Represents standardized templates that define the structure and configuration of program manifests that are used within Salesforce Marketing Cloud workflows. These templates provide a consistent model for describing program components and their relationships. This table does not support insert or delete operations.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ProgramManifestTemplate WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM ProgramManifestTemplate WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-123')
SELECT * FROM ProgramManifestTemplate WHERE CreatedDate > '2017/01/25'
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'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string identifier (Id) that uniquely identifies the program manifest template within Marketing Cloud. |
| CustomerKey | String | False |
Specifies a user-supplied unique Id for the template within its object type. This value is commonly used for cross-environment promotion, API retrieval, and automation logic. |
| Client_ID | Long | False |
Specifies the Id of the client account that owns this program manifest template. |
| Name | String | False |
Provides the display name of the program manifest template. The name helps users locate and reference the template in configuration workflows and API calls. |
| Description | String | False |
Provides a detailed explanation of the purpose, usage, and functional intent of the program manifest template. This description helps administrators understand when and how to apply the template to automation or orchestration processes. |
| Type | String | False |
Specifies the program manifest category that classifies the template according to its functional purpose. This value determines how the template is interpreted during program execution and how it interacts with related automation steps. |
| OperationType | String | False |
Provides metadata that specifies the type of operation the system should perform when this program manifest template is invoked. This value influences downstream workflow behavior and processing rules. |
| Content | String | False |
Specifies the serialized configuration data or structured definition that the program manifest template contains. This content supplies the operational logic, field mappings, or execution details that should be applied when the template runs. |
| IsActive | Bool | False |
Returns a value of 'true' when the template is active and available for program execution. It returns a value of 'false' when the template is inactive or disabled for administrative or operational reasons. |
| CreatedDate | Datetime | False |
Specifies the read-only date and time when the program manifest template was created in the system. |
| ModifiedDate | Datetime | False |
Specifies the date and time when the program manifest template was most recently modified. |
Represents an SQL query activity that can be executed through the SOAP API in Salesforce Marketing Cloud. Each query definition specifies the SQL text, data extension target, and scheduling information for automated query execution. This table supports query and retrieval operations but does not allow inserts or updates.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM QueryDefinition WHERE ObjectID IN ('nzxcaslkjd-123', 456)
SELECT * FROM QueryDefinition WHERE CreatedDate > '2017/01/25'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM QueryDefinition WHERE ObjectID = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string identifier (Id) that uniquely identifies the query definition within the platform. |
| Client_ID | Int | False |
Specifies the Id of the client account that owns or executes the query definition. |
| Name | String | False |
Specifies the user-defined name of the query definition as displayed in automation tools and administrative interfaces. |
| CustomerKey | String | False |
Specifies the user-supplied unique key that identifies the query definition for API operations, imports, and automated activities. |
| Description | String | False |
Provides a detailed explanation of the purpose and behavior of the query definition, including how the resulting data set is intended to be used. |
| QueryText | String | False |
Specifies the SQL query text that defines the records to select, transform, or filter. The platform executes this query against the specified source data extensions. |
| TargetType | String | False |
Specifies the target output type that determines whether the query writes results to a data extension, overwrites an existing target, or appends to an existing data set. |
| DataExtensionTarget_Name | String | False |
Specifies the name of the data extension that is designated as the target for the query results. |
| DataExtensionTarget_CustomerKey | String | False |
Specifies the user-supplied unique key that identifies the target data extension where the query results will be written. |
| DataExtensionTarget_Description | String | False |
Provides a description of the target data extension that clarifies its structure, purpose, or the type of records it is expected to store. |
| TargetUpdateType | String | False |
Specifies the update behavior that is applied when the query writes data to the target (for example, overwrite, add, or update). |
| FileType | String | False |
Specifies the file-delimiter format that applies when exporting query results to a file (for example, 'CSV', 'TAB', or 'Other'). |
| FileSpec | String | False |
Specifies the file-naming pattern that is used when exporting query output to a file. The pattern supports date-based substitutions such as %%YEAR%%, %%MONTH%%, and %%DAY%%. |
| Status | String | False |
Specifies the operational status of the query definition, which indicates whether it is active, paused, running, or has encountered an error. |
| CreatedDate | Datetime | False |
Specifies the date and time when the query definition was initially created. |
| ModifiedDate | Datetime | False |
Specifies the date and time when the query definition was most recently modified. |
| CategoryID | Int | False |
Specifies the Id of the folder that stores the query definition within the account's organizational hierarchy. |
Defines configuration settings for Reply Mail Management (RMM) in Salesforce Marketing Cloud. RMM determines how reply emails are processed, routed, and categorized for an account. This table does not support deletions to preserve email routing integrity.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ReplyMailManagementConfiguration WHERE Id = 123 SELECT * FROM ReplyMailManagementConfiguration WHERE Id IN (123, 456) SELECT * FROM ReplyMailManagementConfiguration WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: EmailDisplayName and EmailReplyAddress.
INSERT INTO ReplyMailManagementConfiguration (EmailDisplayName, EmailReplyAddress) VALUES ('Test', '[email protected]')
You must set a new value for EmailReplyAddress when executing an update against this table, and also supply its Id.
UPDATE ReplyMailManagementConfiguration SET EmailReplyAddress = '[email protected]' WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
The unique identifier (Id) of the reply mail management configuration. |
| Client_ID | Int | True |
The Id of the client that is associated with this reply mail management configuration. |
| EmailDisplayName | String | False |
Provides the display name that appears in the 'From' field when subscribers receive reply mail management messages. This value defines how the sending identity is presented in email clients. |
| ReplySubdomain | String | False |
Specifies the subdomain that the reply mail management configuration uses for routing inbound replies. This subdomain forms part of the reply-to address that manages inbound subscriber responses. |
| EmailReplyAddress | String | False |
Identifies the forwarding address to which inbound email replies are delivered after reply mail management processing evaluates unsubscribe requests, keywords, and filtering rules. |
| CreatedDate | Datetime | False |
Indicates the date and time when this reply mail management configuration was created. |
| ModifiedDate | Datetime | False |
Indicates the most recent date and time when this reply mail management configuration was modified by any system or user action. |
| DNSRedirectComplete | Bool | False |
Returns a value of 'true' when the reply-to subdomain's domain name system (DNS) records have been fully redirected to the Salesforce Marketing Cloud mail servers. It returns a value of 'false' when DNS routing has not yet been completed or verified. |
| DeleteAutoReplies | Bool | False |
Returns a value of 'true' when automatic replies (for example, out-of-office messages or auto-responders) are deleted instead of being forwarded to the configured reply address. It returns a value of 'false' when automatic replies are allowed to pass through to the forwarding mailbox. |
| SupportUnsubscribes | Bool | False |
Returns a value of 'true' when the reply mail management configuration processes unsubscribe requests that are submitted through inbound email replies. It returns a value of 'false' when unsubscribe handling is disabled and inbound requests must be managed through other workflows. |
| SupportUnsubKeyword | Bool | False |
Returns a value of 'true' when the configuration recognizes an unsubscribe keyword within an inbound email and applies the corresponding opt-out action. It returns a value of 'false' when unsubscribe-keyword recognition is disabled. |
| SupportUnsubscribeKeyword | Bool | False |
Returns a value of 'true' when the configuration recognizes the word 'unsubscribe' or a similar keyword within inbound email content and applies opt-out logic. It returns a value of 'false' when unsubscribe-keyword detection is not enabled. |
| SupportRemoveKeyword | Bool | False |
Returns a value of 'true' when the configuration supports a remove keyword that instructs the system to remove the subscriber from a mailing list. It returns a value of 'false' when remove-keyword actions are not processed. |
| SupportOptOutKeyword | Bool | False |
Returns a value of 'true' when the configuration recognizes an opt-out keyword and applies the related subscription removal rules. It returns a value of 'false' when opt-out keywords are not evaluated. |
| SupportLeaveKeyword | Bool | False |
Returns a value of 'true' when the configuration recognizes a leave keyword as an instruction to discontinue receiving messages. It returns a value of 'false' when leave-keyword support is not active. |
| SupportMisspelledKeywords | Bool | False |
Returns a value of 'true' when the configuration uses heuristic matching to interpret common misspellings of unsubscribe-related keywords. It returns a value of 'false' when only exact keyword matches are accepted. |
| SendAutoReplies | Bool | False |
Returns a value of 'true' when the reply mail management configuration automatically sends an acknowledgment message to the subscriber who replied. It returns a value of 'false' when no automatic acknowledgment email is sent. |
| AutoReplySubject | String | False |
Defines the subject line of the acknowledgment email that the system sends when automatic replies are enabled within this reply mail management configuration. |
| AutoReplyBody | String | False |
Contains the text or HTML body of the acknowledgment message that is delivered to subscribers when automatic replies are enabled. |
| ForwardingAddress | String | False |
Specifies the mailbox to which inbound subscriber replies are forwarded after reply mail management processing completes unsubscribe logic, keyword interpretation, and automated handling steps. |
| ConversationLifetimeDays | Int | False |
Indicates the number of calendar days that a reply mail management conversation remains active before the system considers it expired and eligible for closure. |
| ConversationLifetimeCycles | Int | False |
Indicates the number of reply cycles (message exchanges) permitted within an active conversation before the system expires the session and applies any associated expiration rules. |
| AnonymousRuleSet_ObjectID | String | True |
The system-controlled text string Id that identifies the rule set that is used to evaluate reply mail interactions when the sender identity cannot be matched or authenticated. |
| AnonymousRuleSet_Name | Int | True |
Provides the name of the rule set that governs processing for anonymous or unidentified reply mail flows. |
| AnonymousRuleSet_CustomerKey | String | True |
The user-supplied unique key that identifies the rule set that is used specifically for anonymous reply mail scenarios. |
| AnonymousAckTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to send acknowledgment messages for anonymous inbound replies. |
| AnonymousAckTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send definition responsible for acknowledgment messaging in anonymous conversation flows. |
| AnonymousAckTriggeredSend_Name | String | True |
Specifies the name that is assigned to the triggered send definition that generates acknowledgment messages in anonymous reply scenarios. |
| AnonymousAckTriggeredSend_TriggeredSendStatus | String | True |
Indicates the operational status of the triggered send definition used to acknowledge anonymous inbound replies. |
| AnonymousForwardTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to forward anonymous inbound replies to the configured forwarding address. |
| AnonymousForwardTriggeredSend_CustomerKey | String | True |
The user-supplied unique key that identifies the triggered send definition responsible for forwarding messages received from anonymous or unidentified senders. |
| AnonymousForwardTriggeredSend_Name | String | True |
Specifies the name assigned to the triggered send definition that forwards anonymous inbound replies. |
| AnonymousForwardTriggeredSend_TriggeredSendStatus | String | True |
Indicates the operational status of the triggered send definition that forwards messages received from anonymous senders. |
| ResponderConversationRuleSet_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the rule set responsible for handling reply mail conversations initiated by a responder rather than by the original message sender. |
| ResponderConversationRuleSet_Name | Int | True |
Specifies the name that is assigned to the rule set that governs how reply mail management processes conversation replies that originate from a responder rather than an initial sender. |
| ResponderConversationRuleSet_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the rule set used for responder-initiated conversation processing. |
| ResponderConversationAckTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to send acknowledgment messages to a responder. |
| ResponderConversationAckTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the acknowledgment triggered send associated with a responder conversation. |
| ResponderConversationAckTriggeredSend_Name | String | True |
Specifies the name assigned to the acknowledgment triggered send definition that responds to messages received from a responder. |
| ResponderConversationAckTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the acknowledgment triggered send that is used in responder conversations. |
| ResponderConversationForwardTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to forward responder messages. |
| ResponderConversationForwardTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send used to forward messages received from a responder. |
| ResponderConversationForwardTriggeredSend_Name | String | True |
Specifies the name that is assigned to the triggered send definition responsible for forwarding responder messages. |
| ResponderConversationForwardTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the triggered send definition that forwards responder replies. |
| InitiatorConversationRuleSet_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the rule set that processes conversations initiated by a subscriber. |
| InitiatorConversationRuleSet_Name | Int | True |
Specifies the name that is assigned to the rule set that governs the handling of conversation replies that originate from an initiating subscriber. |
| InitiatorConversationRuleSet_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the rule set used to process conversation flows started by a subscriber. |
| InitiatorConversationAckTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the acknowledgment triggered send for conversations initiated by a subscriber. |
| InitiatorConversationAckTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send definition used to send acknowledgment responses to initiating subscribers. |
| InitiatorConversationAckTriggeredSend_Name | String | True |
Specifies the name that is assigned to the triggered send definition that provides acknowledgment messaging for subscriber-initiated conversations. |
| InitiatorConversationAckTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the triggered send that provides acknowledgment messages for initiating subscribers. |
| InitiatorConversationForwardTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to forward subscriber-initiated conversations. |
| InitiatorConversationForwardTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send responsible for forwarding messages from an initiating subscriber. |
| InitiatorConversationForwardTriggeredSend_Name | String | True |
Specifies the name assigned to the triggered send definition that forwards messages within subscriber-initiated conversations. |
| InitiatorConversationForwardTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the triggered send that forwards subscriber-initiated conversation messages. |
| ConversationExpirationTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used to notify users when a conversation reaches the configured expiration point. |
| ConversationExpirationTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send used for conversation-expiration notifications. |
| ConversationExpirationTriggeredSend_Name | String | True |
Specifies the name that is assigned to the triggered send definition that handles conversation-expiration messaging. |
| ConversationExpirationTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the triggered send that processes messages related to conversation expiration. |
| MultiUseViolationTriggeredSend_ObjectID | String | True |
Specifies the system-controlled text string Id that identifies the triggered send definition used when the system detects a multi-use violation in reply mail processing. |
| MultiUseViolationTriggeredSend_CustomerKey | String | True |
Specifies the user-supplied unique key that identifies the triggered send that manages multi-use violation notifications. |
| MultiUseViolationTriggeredSend_Name | String | True |
Specifies the name that is assigned to the triggered send definition used for multi-use violation handling. |
| MultiUseViolationTriggeredSend_TriggeredSendStatus | String | True |
Indicates the current operational status of the triggered send definition that responds to multi-use violations. |
| InboundAddressIsOneUse | Bool | False |
Returns a value of 'true' when the inbound reply address is configured for single-use processing, meaning the address is intended for one conversation thread before expiration or rotation. It returns a value of 'false' when the inbound reply address supports multiple uses or ongoing conversation threads. |
Represents email send operations in Salesforce Marketing Cloud. Each record includes aggregate tracking data for sent emails, such as audience size, delivery results, and performance metrics. This table supports query and reporting but does not allow deletes or updates.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Send WHERE Id = 123 SELECT * FROM Send WHERE Id IN (123, 456) SELECT * FROM Send WHERE CreatedDate > '2017/01/25'
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)
| Name | Type | ReadOnly | Description |
| ID [KEY] | Int | False |
Specifies the system-generated identifier (Id) that is used to uniquely identify the send record. This value supports tracking and reporting workflows. |
| PartnerKey | String | False |
Specifies the unique partner-supplied key that is associated with the send record and is accessible only through API integrations. |
| CreatedDate | Datetime | False |
Specifies the date and time when the send record was created. This value is read-only. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the send record was last modified. This value reflects system-managed changes. |
| Client_ID | Int | False |
Specifies the Id of the client that owns or initiates the send operation. |
| Client_PartnerClientKey | String | False |
Specifies the partner-defined client key that is associated with the marketing account and exposed through API workflows. |
| Email_ID | Int | False |
Specifies the Id of the email asset that is used for the send operation. |
| Email_PartnerKey | String | False |
Specifies the unique partner-supplied key that is associated with the email asset and is accessible only through API integrations. |
| SendDate | Datetime | False |
Specifies the date and time when the send action occurred. This value is used for tracking and reporting. |
| FromAddress | String | False |
Specifies the 'From' email address that is associated with the send record. This address reflects the configured sender profile. |
| FromName | String | False |
Specifies the display name that is associated with the sender and shown to recipients. |
| Duplicates | Int | False |
Indicates the number of duplicate email addresses that are detected during the send process. |
| InvalidAddresses | Int | False |
Indicates the number of recipient addresses that are determined to be invalid during the send process. |
| ExistingUndeliverables | Int | False |
Indicates whether prior bounces exist for recipients that are included in the send. |
| ExistingUnsubscribes | Int | False |
Indicates whether prior unsubscribe events are associated with recipients included in the send. |
| HardBounces | Int | False |
Indicates the number of hard bounces that occur as part of the send processing. |
| SoftBounces | Int | False |
Indicates the number of soft bounces that occur during the send. |
| OtherBounces | Int | False |
Specifies the number of bounces classified as 'Other' that occur during the send. |
| ForwardedEmails | Int | False |
Indicates the number of messages that recipients forward to additional recipients. |
| UniqueClicks | Int | False |
Indicates the number of unique click events that are recorded for the message. |
| UniqueOpens | Int | False |
Indicates the number of unique open events that are registered for the message. |
| NumberSent | Int | False |
Indicates the total number of email messages that are sent as part of the send operation. |
| NumberDelivered | Int | False |
Indicates the number of sent messages that are successfully delivered without bouncing. |
| NumberTargeted | Int | False |
Indicates the number of potential recipients that are targeted as part of the send. |
| NumberErrored | Int | False |
Indicates the number of emails that are not sent because an error occurs during message construction or processing. |
| NumberExcluded | Int | False |
Indicates the number of recipients that are excluded from the send because of held, unsubscribed, master unsubscribed, or global unsubscribed status. |
| Unsubscribes | Int | False |
Indicates the number of unsubscribe events that occur as part of the send. |
| MissingAddresses | Int | False |
Specifies the number of records that do not include required address information. |
| Subject | String | False |
Specifies the subject line that is associated with the email message. |
| PreviewURL | String | False |
Specifies the URL that is used to preview the message that is associated with the send. |
| SentDate | Datetime | False |
Specifies the date and time when the send operation took place. This value can match or differ from the scheduled SendDate value that is based on processing time. |
| EmailName | String | False |
Specifies the name of the email asset that is used for the send. |
| Status | String | False |
Specifies the status that is associated with the send record (for example, Completed or InProgress). |
| IsMultipart | Bool | False |
Returns a value of 'true' when the message is sent with Multipart/MIME enabled. It returns a value of 'false' when the message is delivered without Multipart/MIME formatting applied. |
| SendLimit | Int | False |
Indicates the maximum number of messages that the send definition allows within a designated send window. |
| SendWindowOpen | Datetime | False |
Specifies the date and time when the send window begins for the send definition. |
| SendWindowClose | Datetime | False |
Specifies the date and time when the send window ends for the send definition. |
| IsAlwaysOn | Bool | False |
Returns a value of 'true' when the send operation is allowed to proceed while the system is in maintenance mode. It returns a value of 'false' when the operation is restricted during maintenance windows. |
| Additional | String | False |
Specifies the campaign identifier that customers assign to group or categorize the send. |
| BCCEmail | String | False |
Specifies the blind carbon copy (Bcc) email addresses that are configured to receive a copy of the message. |
| EmailSendDefinition_ObjectID | String | False |
Specifies the system-controlled object Id that is associated with the email send definition. |
| EmailSendDefinition_CustomerKey | String | False |
Specifies the customer key that is associated with the email send definition. |
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 |
Specifies the Id of the list that is associated with the send request. |
Represents send classifications in Salesforce Marketing Cloud. A send classification defines the delivery parameters for a message, including CAN-SPAM classification (commercial and transactional or relationship messages), sender profile, and delivery profile. This table helps enforce consistent email compliance and brand policies.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM SendClassification WHERE ObjectID IN ('nzxcaslkjd-123', 456)
SELECT * FROM SendClassification WHERE CreatedDate > '2017/01/25'
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')
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SendClassification WHERE ObjectID = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled identifier (Id) that is assigned to the send classification object. This value is used to reference the object in system workflows and API operations. |
| SendClassificationType | String | False |
Specifies the type that is associated with the send classification. Valid values include 'Operational', which bypasses subscription checks, and 'Marketing', which adheres to subscriber preferences. |
| Name | String | False |
Specifies the name that is assigned to the send classification. This value provides a human-readable label for administrative and API use. |
| Description | String | False |
Provides descriptive information that explains the purpose or configuration of the send classification. This information supports administrative oversight and auditing. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id that is associated with the send classification within its object type. This value is required for external references and API operations. |
| SenderProfile_CustomerKey | String | False |
Specifies the customer key that is associated with the sender profile that is used for 'From Name', 'From Address', and related delivery metadata. |
| SenderProfile_ObjectID | String | False |
Specifies the system-controlled object Id that is assigned to the sender profile that is linked to this send classification. |
| DeliveryProfile_CustomerKey | String | False |
Specifies the customer key that is associated with the delivery profile that defines IP configuration, domain details, and delivery routing rules. |
| DeliveryProfile_ObjectID | String | False |
Specifies the system-controlled object Id that is assigned to the delivery profile that is linked to this send classification. |
| ArchiveEmail | Bool | False |
Returns a value of 'true' when the send classification is configured to archive email messages for compliance or auditing. It returns a value of 'false' when archiving is not applied. |
| Client_ID | Long | False |
Specifies the Id of the client that owns or administers the send classification. |
| Client_PartnerClientKey | String | False |
Specifies the partner-defined client key that is associated with the account and accessible through API integrations. |
| PartnerKey | String | False |
Specifies the unique partner-supplied key that is associated with the send classification and available only through API operations. |
| CreatedDate | Datetime | False |
Specifies the date and time when the send classification object was created. This value is system-generated and read-only. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the send classification object was last modified. This value reflects administrative or automated system updates. |
Stores sender profile configurations in Salesforce Marketing Cloud. A sender profile defines the 'From' name, 'From' email address, and reply handling for outbound messages. This table supports integration with send definitions to maintain consistent sender identity across campaigns.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
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', '[email protected]')
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 = '[email protected]' WHERE ObjectID = 'nzxcaslkjd-123'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SenderProfile WHERE ObjectID = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| Name | String | False |
Specifies the display name that is assigned to the sender profile and shown throughout Email Studio and related send configuration workflows. |
| Description | String | False |
Provides a description that explains the purpose, usage context, or administrative details of the sender profile. |
| FromName | String | False |
Specifies the default From Name that is used in email messages that reference this sender profile. |
| FromAddress | String | False |
Specifies the default 'From Address' value that is associated with this sender profile and applied to outbound email messages. |
| UseDefaultRMMRules | Bool | False |
Returns a value of 'true' when the sender profile uses the default Reply Mail Management (RMM) rules that are configured for the account. It returns a value of 'false' when the profile uses custom RMM rules instead of the account defaults. |
| AutoForwardToEmailAddress | String | True |
Specifies the email address to which automatically forwarded replies should be sent when reply forwarding is enabled for the sender profile. |
| AutoForwardToName | String | True |
Specifies the display name that is used as the To Name on automatically forwarded email messages. |
| DirectForward | Bool | False |
Returns a value of 'true' when the sender profile allows replies to be forwarded directly to the designated forwarding address without RMM intervention. It returns a value of 'false' when replies are processed through RMM logic instead of being forwarded directly. |
| AutoForwardTriggeredSend_ObjectID | String | False |
Specifies the system-controlled object identifier (Id) that represents the triggered send definition that is used for automatic forwarding actions. |
| AutoReply | Bool | False |
Returns a value of 'true' when the sender profile sends an automatic reply message for inbound replies. It returns a value of 'false' when the profile does not send automatic replies. |
| AutoReplyTriggeredSend_ObjectID | String | False |
Specifies the system-controlled object Id of the triggered send definition that is used to generate an automatic reply email. |
| SenderHeaderEmailAddress | String | False |
Specifies the email address that is included in the sender header when outbound messages reference this sender profile. |
| SenderHeaderName | String | False |
Specifies the display name that is included in the sender header when outbound messages reference this sender profile. |
| DataRetentionPeriodLength | String | False |
Specifies the number of time units for which data that relates to the sender profile should be retained as part of data retention and compliance policies. |
| ReplyManagementRuleSet_ObjectID | String | False |
Specifies the system-controlled object Id that identifies the rule set that governs reply mail management behavior for this sender profile. |
| RMMRuleCollection_ObjectID | String | False |
Specifies the system-controlled object Id for the collection of RMM rules that apply to the sender profile. |
| Client_ID | Long | False |
Specifies the Id of the client that owns or manages the sender profile. |
| PartnerKey | String | False |
Specifies the unique partner-provided key that is associated with the sender profile and accessible only through the API. |
| CreatedDate | Datetime | False |
Indicates the date and time when the sender profile was created. This value is system-generated and read-only. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the sender profile was last modified. This value updates when administrative or automated changes occur. |
| ObjectID | String | False |
Specifies the system-controlled object Id that uniquely identifies the sender profile within Marketing Cloud. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the sender profile within its object type. This Id is used for API interactions and cross-object references. |
| Client_CreatedBy | Int | False |
Returns the Id of the user who created the sender profile. |
| Client_ModifiedBy | Int | False |
Returns the Id of the user who last modified the sender profile. |
Represents individual instances of Short Message Service (SMS) triggered sends in Salesforce Marketing Cloud. Each record corresponds to a message sent as part of a triggered send definition. This table does not support deletes or updates to preserve historical send data.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SMSTriggeredSend WHERE ObjectID = 123 SELECT * FROM SMSTriggeredSend WHERE ObjectID IN (123, 456) SELECT * FROM SMSTriggeredSend WHERE CreatedDate > '2017/01/25'
You must specify the following field when inserting to this table: SMSTriggeredSendDefinition_ObjectID.
INSERT INTO SMSTriggeredSend (SMSTriggeredSendDefinition_ObjectID) VALUES (123)
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string that serves as the unique identifier (Id) for the Short Message Service (SMS) triggered-send record. This Id is generated automatically and provides a stable reference for the object. |
| CreatedDate | Datetime | False |
Indicates the date and time of the object's creation. This timestamp is generated by the system to record when the SMS triggered-send record was first added. |
| Client_ID | Int | False |
Specifies the Id of the client. This Id associates the SMS triggered-send record with the correct Marketing Cloud account context. |
| SmsSendId | String | False |
Specifies the Id for a specific SMS send that is associated with the triggered-send process. This Id links the mobile message activity to the corresponding triggered-send definition and execution. |
| SMSTriggeredSendDefinition_ObjectID | String | False |
Specifies the system-controlled text string that is used as the Id of the SMS triggered-send definition. This value identifies the configuration that dictates how the triggered SMS message is constructed and delivered. |
Represents a subscriber in Salesforce Marketing Cloud. Each record identifies an individual who has opted to receive marketing communications via email or Short Message Service (SMS). This table is central to subscriber management, preference handling, and audience segmentation.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Subscriber WHERE Id = 123 SELECT * FROM Subscriber WHERE Id IN (123, 456) SELECT * FROM Subscriber WHERE CreatedDate > '2017/01/25'
You must specify the following fields when inserting to this table: SubscriberKey and EmailAddress.
INSERT INTO Subscriber (SubscriberKey, EmailAddress) VALUES (123, '[email protected]')
You must specify the Id in the WHERE clause when executing an update against this table.
UPDATE Subscriber SET EmailAddress = '[email protected]' WHERE Id = 123
You must specify the Id in the WHERE clause when executing a delete against this table.
DELETE FROM Subscriber WHERE Id = 123
| Name | Type | ReadOnly | Description |
| ID | Int | False |
Specifies the unique identifier (Id) for the subscriber record. This Id distinguishes the subscriber from all other subscriber records within the system. |
| PartnerKey | String | False |
Specifies the unique Id that is provided by a partner system for the subscriber. This partner-supplied value enables cross-system correlation and is accessible only through the API. |
| CreatedDate | Datetime | False |
Indicates the date and time when the subscriber record was created. This timestamp is generated automatically and provides an audit reference for record lifecycle tracking. |
| Client_ID | Int | False |
Specifies the Id of the client that owns the subscriber record. This Id establishes the account context in which the subscriber exists. |
| Client_PartnerClientKey | String | False |
Specifies the user-defined partner key for the client that is associated with the subscriber. This key provides an additional mapping reference for external integrations. |
| EmailAddress | String | False |
Specifies the email address that is associated with the subscriber. This value determines the address used for email sends and subscriber-level communication. |
| SubscriberKey | String | False |
Specifies the unique key that identifies a subscriber across all lists, data extensions, and channels. This key is typically user-defined and ensures consistent subscriber recognition throughout the system. |
| UnsubscribedDate | Datetime | False |
Indicates the date and time when the subscriber unsubscribed from a list or communication stream. This timestamp reflects the moment the subscriber opted out of receiving further messages. |
| Status | String | False |
Defines the current status of the subscriber. This status reflects whether the subscriber is active, bounced, held, unsubscribed, or otherwise restricted from receiving messages. |
| EmailTypePreference | String | False |
Specifies the preferred email format for the subscriber. This value determines whether the subscriber receives messages in HTML, text-only, or multipart format based on their stated preference. |
Represents suppression lists in Salesforce Marketing Cloud. A suppression list defines subscribers who should be excluded from specific sends or publications. Each record can be associated with one or more suppression contexts to enforce message exclusions.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
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'
You must specify the following fields when inserting to this table: Name.
INSERT INTO SuppressionListDefinition (Name) VALUES ('Test')
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'
You must specify the ObjectID in the WHERE clause when executing a delete against this table.
DELETE FROM SuppressionListDefinition WHERE ObjectID = 'nzxcaslkjd-123'
| Name | Type | ReadOnly | Description |
| ObjectID | String | False |
Specifies the system-controlled text string that serves as the unique identifier (Id) for the suppression-list definition. This Id is read-only and is generated internally. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the suppression-list definition. This value provides an external reference that is used for integration, retrieval, and configuration tasks. |
| Name | String | False |
Defines the name that is assigned to the suppression-list definition. This value helps users identify the definition within the user interface and automation workflows. |
| Description | String | False |
Describes the purpose, scope, or functional behavior of the suppression-list definition. This description helps users understand how and when the list should be applied. |
| Client_CreatedBy | Int | False |
Returns the Id of the user who created the suppression-list definition. This value supports auditing and administrative tracking. |
| CreatedDate | Datetime | False |
Indicates the date and time when the suppression-list definition was created. This timestamp supports chronological tracking of configuration changes. |
| Client_ModifiedBy | Int | False |
Returns the Id of the user who most recently modified the suppression-list definition. This value supports administrative oversight and auditing. |
| ModifiedDate | Datetime | False |
Indicates the date and time when the suppression-list definition was last modified. This timestamp reflects the most recent update to its configuration. |
| Category | Long | False |
Specifies the folder Id that is used to organize the suppression-list definition within the account's folder structure. This value supports navigation and access control. |
| Client_ID | Int | False |
Specifies the Id of the client that owns or manages the suppression-list definition. This Id links the definition to the appropriate account. |
| Client_EnterpriseID | Long | False |
Specifies the enterprise-level Id that is associated with the client. This value is reserved for future enterprise-level functionality. |
| SubscriberCount | Long | False |
Indicates the number of subscriber records that are currently stored on the suppression list. This value helps assess the size and impact of the list within send operations. |
Defines triggered send definitions in Salesforce Marketing Cloud. A triggered send definition establishes parameters for automatically sending emails to contacts who meet specified conditions or trigger events. The 'All Subscribers' list permission is required when using the default list for triggered sends.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
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)
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'
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'
| Name | Type | ReadOnly | Description |
| ObjectID [KEY] | String | False |
Specifies the system-controlled text string that serves as the unique identifier (Id) for the triggered-send definition record. |
| PartnerKey | String | False |
Specifies the partner-supplied unique Id that is associated with the triggered-send definition and used exclusively for partner integrations. |
| CreatedDate | Datetime | False |
Specifies the date and time when the triggered-send definition record was created. This value is read-only. |
| ModifiedDate | Datetime | False |
Specifies the date and time when the triggered-send definition record was last modified. This value is read-only. |
| Client_ID | Long | False |
Specifies the Id of the client account that owns the triggered-send definition. |
| CustomerKey | String | False |
Specifies the user-supplied unique Id for the triggered-send definition within the object type. |
| Email_ID | Int | False |
Specifies the Id of the associated email asset that is used when the triggered send is executed. |
| List_ID | Int | False |
Specifies the Id of the subscriber list that is associated with the triggered send. |
| Name | String | False |
Specifies the name that is assigned to the triggered-send definition. |
| Description | String | False |
Provides descriptive information that explains the purpose or configuration of the triggered-send definition. |
| TriggeredSendType | String | False |
[DEPRECATED] Indicates the triggered-send type. |
| TriggeredSendStatus | String | False |
Specifies the status of the triggered send, which indicates whether the definition is active, paused, or otherwise restricted. |
| HeaderContentArea_ID | Int | False |
Specifies the Id of the header content area that is associated with the triggered-send definition. |
| FooterContentArea_ID | Int | False |
Specifies the Id of the footer content area that is associated with the triggered-send definition. |
| SendClassification_ObjectID | String | False |
Specifies the system-controlled text string that serves as the Id of the send classification that is associated with the triggered-send definition. |
| SendClassification_CustomerKey | String | False |
Specifies the customer key (Id) of the send classification that is linked to the triggered-send definition. |
| SenderProfile_CustomerKey | String | False |
Specifies the customer key (Id) of the sender profile that is linked to the triggered-send definition. |
| SenderProfile_ObjectID | String | False |
Specifies the system-controlled text string that serves as the Id of the sender profile that is associated with the triggered-send definition. |
| DeliveryProfile_CustomerKey | String | False |
Specifies the customer key (Id) of the delivery profile that is associated with the triggered-send definition. |
| DeliveryProfile_ObjectID | String | False |
Specifies the system-controlled text string that serves as the identifier (Id) of the delivery profile that is associated with the triggered-send definition. |
| PrivateDomain_ObjectID | String | False |
Specifies the system-controlled text string that serves as the identifier (Id) of the private domain that is configured for the triggered send. |
| PrivateIP_ID | Int | True |
Specifies the read-only identifier (Id) of the private internet protocol (IP) address that is assigned to the triggered send. |
| AutoAddSubscribers | Bool | False |
Returns a value of 'true' when the triggered-send process automatically adds the recipient to a subscriber list. It returns a value of 'false' when the triggered-send process does not add the recipient to a subscriber list. |
| AutoUpdateSubscribers | Bool | False |
Returns a value of 'true' when the triggered-send process updates existing subscriber information during send processing. It returns a value of 'false' when subscriber information is not updated. |
| BatchInterval | Int | False |
[DEPRECATED] Indicates the batch-processing interval for bundled triggered sends. |
| FromName | String | False |
Specifies the display name that is used in the 'From' field of the email message for the triggered send. |
| FromAddress | String | False |
Specifies the email address that is used in the 'From' field when the triggered email is sent. |
| BccEmail | String | False |
Specifies one or more email addresses that receive a blind-carbon copy (Bcc) of the triggered email message. |
| EmailSubject | String | False |
Specifies the subject line that is used for the triggered-send email message. |
| DynamicEmailSubject | String | False |
Specifies the dynamic subject-line content that is rendered at send time based on personalization or AMPscript logic. |
| IsMultipart | Bool | False |
Returns a value of 'true' when the triggered-send email is delivered as a multipart MIME message. It returns a value of 'false' when the email is not delivered in multipart format. |
| IsWrapped | Bool | False |
Returns a value of 'true' when the triggered-send email includes wrapped links that are required for click-tracking. It returns a value of 'false' when link wrapping is not applied. |
| TestEmailAddr | String | False |
Specifies the test email address to which test versions of the triggered-send email can be delivered. |
| AllowedSlots | String | False |
Specifies configuration data that defines delivery slot permissions or restrictions. This field is reserved for future functional expansion. |
| NewSlotTrigger | Int | False |
[DEPRECATED] Indicates the configuration value that was previously used to control slot-trigger behavior for triggered sends. |
| SendLimit | Int | False |
Specifies the maximum number of messages that can be delivered under the triggered-send definition within a defined send window. |
| SendWindowOpen | Datetime | False |
Specifies the date and time when the allowed send window begins for the triggered-send definition. |
| SendWindowClose | Datetime | False |
Specifies the date and time when the allowed send window ends for the triggered-send definition. |
| SuppressTracking | Bool | False |
Returns a value of 'true' when the triggered-send definition suppresses tracking for opens, clicks, and other send events. It returns a value of 'false' when tracking is recorded normally. |
| Keyword | String | False |
Specifies a keyword value that is reserved for future functionality within triggered-send processing. |
| List_PartnerKey | String | False |
Specifies the partner-supplied unique Id that is associated with the referenced list object and available only through partner integrations. |
| Email_PartnerKey | String | False |
Specifies the partner-supplied unique Id that is associated with the referenced email asset and available only through partner integrations. |
| SendClassification_PartnerKey | String | False |
Specifies the partner-supplied unique Id that is associated with the send classification and available only through partner integrations. |
| PrivateDomain_PartnerKey | String | True |
Specifies the partner-supplied unique Id that is associated with the private domain configuration and available only through partner integrations. |
| PrivateIP_PartnerKey | String | True |
Specifies the partner-supplied unique Id that is associated with the private IP address configuration and available only through partner integrations. |
| Client_PartnerClientKey | String | False |
Specifies the user-defined partner key (Id) that is assigned to the client account for integration or tracking purposes. |
| IsPlatformObject | Bool | False |
Returns a value of 'true' when the triggered-send definition is a platform-managed object. It returns a value of 'false' when the triggered-send definition is not classified as a platform object. |
| CategoryID | Int | False |
Specifies the Id of the folder that contains the triggered-send definition within the account's organizational hierarchy. |
Views are similar to tables in the way that data is represented; however, views are read-only.
Queries can be executed against a view as if it were a normal table.
| Name | Description |
| Automation | Defines automations created within Automation Studio in Salesforce Marketing Cloud. Each automation specifies a sequence of scheduled or triggered activities such as imports, sends, or data updates. This view provides visibility into configured automation workflows. |
| BounceEvent | Provides details about email bounce events in Salesforce Marketing Cloud. Each record includes Simple Mail Transfer Protocol (SMTP) codes and diagnostic information related to delivery failures. This view supports deliverability analysis and campaign performance optimization. |
| ClickEvent | Contains tracking data for link click events in Salesforce Marketing Cloud. Each record includes the timestamp, URL identifier (Id), and destination URL for a link that a subscriber clicked in a sent message. This view is essential for analyzing engagement metrics and user interaction behavior. |
| DataExtensionField | Represents individual fields within a data extension in Salesforce Marketing Cloud. Each field defines the data type, length, and attributes of a column in a data extension. This view provides metadata that supports schema validation and data integrity checks. |
| DataExtensionTemplate | Represents data extension templates in Salesforce Marketing Cloud. A template defines the structural blueprint that can be reused to create multiple data extensions with consistent schema design. This view allows administrators to standardize data collection and storage across campaigns. |
| DataFolder | Represents folders within a Salesforce Marketing Cloud account. Each folder organizes related content, data extensions, or automations into a hierarchical structure for easier management and access control. This view supports navigation and organizational reporting across stored assets. |
| DoubleOptInMOKeyword | Defines mobile-originated (MO) keywords used for double opt-in workflows in Salesforce Marketing Cloud. Each record specifies the keyword that allows mobile users to confirm subscriptions through a two-step consent process. This view ensures compliance with opt-in regulations and supports secure subscriber management. |
| FileTriggerTypeLastPull | Provides information about the most recent retrieval of file-trigger activity for each trigger type. This view helps track when a file-based trigger was last evaluated |
| ForwardedEmailEvent | Records events in which a subscriber used the Forward to a Friend feature to share an email with another recipient in Salesforce Marketing Cloud. Each record includes details such as the sender, recipient, and timestamp of the forwarding action. This view supports tracking viral sharing and referral engagement. |
| ForwardedEmailOptInEvent | Specifies opt-in events that occur when a recipient subscribes as a result of receiving a Forward to a Friend email in Salesforce Marketing Cloud. This view helps identify new subscribers who joined through referral-based interactions. |
| HelpMOKeyword | Defines the actions associated with the HELP Short Message Service (SMS) keyword for a Salesforce Marketing Cloud account. The HELP keyword allows subscribers to request information about the sender or message program. This view supports compliance with mobile communication standards. |
| ImportResultsSummary | Provides summary results for import jobs that were initiated from an import definition in Salesforce Marketing Cloud. Each record includes the total rows processed, successful imports, and errors encountered. This retrieve-only view supports reporting and monitoring of data import performance. |
| LinkSend | Provides link-level details for email sends in Salesforce Marketing Cloud. Each record identifies a specific link, its tracking identifier (Id), and its relationship to a send event. This view supports engagement analysis by correlating links to subscriber click behavior. |
| ListSend | Provides retrieve-only properties that describe the lists associated with completed send operations in Salesforce Marketing Cloud. Each record links a send event to one or more lists to support campaign tracking and performance analysis. |
| ListSubscriber | Retrieves subscriber relationships for lists in Salesforce Marketing Cloud. Each record shows which lists a subscriber belongs to or which subscribers are assigned to a list. This view supports subscription management and audience segmentation reporting. |
| MessagingVendorKind | [DEPRECATED] Contains vendor details for Short Message Service (SMS) or voice messaging providers that are integrated with Salesforce Marketing Cloud. Each record identifies a messaging vendor and its communication channel type. |
| NotSentEvent | Contains information about email messages that failed to send in Salesforce Marketing Cloud. Each record includes diagnostic codes and timestamps to support root-cause analysis of delivery failures. |
| OpenEvent | Records open events for email sends in Salesforce Marketing Cloud. Each record includes the timestamp, subscriber key, and send context for an opened message. This view provides key engagement metrics for campaign performance analysis. |
| PrivateIP | Contains details about private IP addresses that are assigned for message sends in Salesforce Marketing Cloud. Each record identifies the dedicated IP address used for outbound email delivery, supporting IP reputation management and sender authentication practices. |
| Publication | Represents publication-level configuration details that support managing how subscriber-facing content is organized and distributed in Salesforce Marketing Cloud. This view provides structural information that describes publication settings, visibility rules, and relationships used in content distribution workflows. |
| PublicationSubscriber | Describes subscribers who are associated with a publication list in Salesforce Marketing Cloud. Each record defines a subscriber's status, preferences, and linkage to a specific publication for audience management and compliance tracking. |
| PublicKeyManagement | Provides information about public encryption keys that are stored in Salesforce Marketing Cloud for use in secure data exchange and authentication workflows. This view helps identify which keys are available for validating signatures, encrypting payloads, or establishing trusted integrations with external systems. |
| ResultItem | Contains the individual result records returned from an asynchronous API call in Salesforce Marketing Cloud. Each record represents the outcome of a processed item, such as a contact import or message send. |
| ResultMessage | Contains summary messages generated from asynchronous API calls in Salesforce Marketing Cloud. Each message provides status information, execution results, or error diagnostics to assist in monitoring API-based processes. |
| Role | Defines user roles and permissions that are assigned within a Salesforce Marketing Cloud account. Each record specifies access levels, feature entitlements, and user group associations. This view supports auditing of security and access configurations. |
| SendEmailMOKeyword | Defines the action that sends a triggered email message in response to a mobile-originated (MO) message in Salesforce Marketing Cloud. This view maps keywords in Short Message Service (SMS) messages to corresponding triggered email sends for integrated cross-channel automation. |
| SendSMSMOKeyword | Defines the actions taken when Salesforce Marketing Cloud receives a specific mobile-originated (MO) keyword. Each record links a keyword to an automation or message send workflow to support two-way Short Message Serviec (SMS) communication. |
| SendSummary | Provides summary information for a completed send event in Salesforce Marketing Cloud. Each record includes key metrics such as total sent, delivered, opened, and bounced messages. This retrieve-only view supports campaign reporting and performance analysis. |
| SentEvent | Contains tracking data for email send events in Salesforce Marketing Cloud. Each record captures subscriber-level delivery results, including send time, recipient address, and message identifier (Id). This view supports detailed tracking and reporting of message performance. |
| SMSMTEvent | Contains information about outbound (mobile-terminated) Short Message Service (SMS) messages that were are to subscribers in Salesforce Marketing Cloud. Each record includes message identifiers (Ids), timestamps, and delivery results for mobile messaging analysis. |
| SMSSharedKeyword | Contains information used to request or manage shared Short Message Service (SMS) keywords in Salesforce Marketing Cloud. Shared keywords allow multiple accounts or business units to use the same keyword within defined boundaries. This view supports keyword governance and provisioning. |
| SMSTriggeredSendDefinition | Defines Short Message Service (SMS) triggered send definitions in Salesforce Marketing Cloud. Each definition includes message templates, target audiences, and sending parameters. This view supports auditing and configuration validation for automated SMS workflows. |
| SubscriberList | Retrieves the lists that are associated with a specific subscriber in Salesforce Marketing Cloud. Each record links a subscriber to one or more lists to support segmentation, subscription tracking, and campaign targeting. |
| SubscriberSendResult | Provides information about message send outcomes at the individual subscriber level. This view helps identify whether a message was delivered, bounced, deferred, or otherwise processed for each subscriber, enabling detailed send-level analysis and troubleshooting. |
| SubscriberStatusEvent | Retrieves information about subscribers, the current subscribers' status and the reasons why the subscribers unsubscribed, if any. |
| SuppressionListContext | Defines the context within which a suppression list can be associated in Salesforce Marketing Cloud. Each context determines the scope of a suppression list, such as a specific business unit, publication, or message type. |
| SurveyEvent | Contains information about survey responses recorded in Salesforce Marketing Cloud. Each record captures the timestamp and context of the response, supporting analysis of audience feedback and engagement. |
| Template | Represents email templates in Salesforce Marketing Cloud. Each record defines the layout, content placeholders, and associated sender settings that are used to build emails. This view helps ensure standardized formatting and brand alignment across campaigns. |
| TimeZone | Lists supported time zones in Salesforce Marketing Cloud. Each record includes the time zone identifier (Id), offset, and regional description. This view supports configuration of time-based automations and send scheduling. |
| TriggeredSendSummary | Provides summary metrics for specific triggered send operations in Salesforce Marketing Cloud. Each record includes counts for messages sent, delivered, and failed, supporting operational and performance analysis. |
| UnsubEvent | Contains data about unsubscription events in Salesforce Marketing Cloud. Each record captures the subscriber, timestamp, and context of the unsubscribe action. This view supports compliance reporting and audience retention analysis. |
| UnsubscribeFromSMSPublicationMOKeyword | Defines the keyword that subscribers can use to unsubscribe from a Short Message Service (SMS) publication list in Salesforce Marketing Cloud. This configuration supports opt-out workflows and compliance with mobile communication regulations. |
Defines automations created within Automation Studio in Salesforce Marketing Cloud. Each automation specifies a sequence of scheduled or triggered activities such as imports, sends, or data updates. This view provides visibility into configured automation workflows.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Automation WHERE ObjectID = 123 SELECT * FROM Automation WHERE ObjectID IN (123, 456) SELECT * FROM Automation WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled, read-only text string that uniquely identifies the automation object. This value remains consistent across API interactions and is used to reference the automation in programmatic workflows. |
| Name | String | Specifies the display name that is assigned to the automation. This value appears in Automation Studio and in API responses. |
| Description | String | Provides a human-readable explanation of the automation's purpose or behavior. This value helps administrators understand how and when the automation is intended to run. |
| Schedule_ID | Int | Specifies the read-only identifier (Id) of the schedule that is associated with the automation. This Id links the automation to its configured recurrence pattern. |
| CustomerKey | String | Specifies the user-supplied unique Id for the automation within its object type. This value enables external systems to reference the automation consistently across environments. |
| Client_ID | Long | Specifies the Id of the client context to which this automation belongs. This value determines the business unit and organizational scope in which the automation executes. |
| IsActive | Bool | Returns a value of 'true' when the automation is active and eligible to run. It returns a value of 'false' when the automation is inactive or paused. |
| CreatedDate | Datetime | Indicates the system-assigned date and time when the automation record was created. This value assists with auditing and lifecycle tracking. |
| Client_CreatedBy | Int | Specifies the Id of the user who created the automation. This value supports administrative traceability. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the automation record was updated. This value reflects configuration changes or status updates. |
| Client_ModifiedBy | Int | Specifies the Id of the user who most recently modified the automation. This value supports auditing of administrative actions. |
| Status | Int | Indicates the current operational status of the automation. This value reflects whether the automation is running, paused, failed, or completed based on Automation Studio processing. |
| Client_EnterpriseID | Long | Specifies an internal enterprise-level Id that is associated with the automation's client context. This value is reserved for system-level configuration and does not participate in standard customer workflows. |
Provides details about email bounce events in Salesforce Marketing Cloud. Each record includes Simple Mail Transfer Protocol (SMTP) codes and diagnostic information related to delivery failures. This view supports deliverability analysis and campaign performance optimization.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM BounceEvent WHERE Id = 123 SELECT * FROM BounceEvent WHERE Id IN (123, 456) SELECT * FROM BounceEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-generated identifier (Id) that uniquely represents the bounce event record within Salesforce Marketing Cloud. This Id is read-only and is used to reference the specific tracking event in reporting and API queries. |
| ObjectID | String | Specifies the system-controlled, read-only text string that uniquely identifies the bounce event object across API operations. This value ensures consistency when events are retrieved, correlated, or audited. |
| PartnerKey | String | Specifies the unique Id that a partner system supplies for the event record. This value is accessible only through the API and supports cross-system mapping and reconciliation. |
| CreatedDate | Datetime | Indicates the date and time when the bounce event record was created. This value supports auditing and the sequencing of tracking events. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the bounce event record was updated. This value reflects system adjustments that occur during tracking reconciliation. |
| Client_ID | Int | Specifies the Id of the business unit that is associated with the bounce event. This value determines the organizational context in which the send and subsequent bounce occurred. |
| SendID | Int | Specifies the Id of the email send operation that is associated with the bounce event. This Id links the bounce to the exact send job that produced the tracking result. |
| SubscriberKey | String | Specifies the unique subscriber key that identifies the recipient whose email message resulted in the bounce. This value connects the event to a specific contact in Salesforce Marketing Cloud. |
| EventDate | Datetime | Indicates the date and time when the bounce tracking event occurred. This value reflects the moment when the receiving mail server returned the bounce response. |
| SMTPCode | String | Specifies the Simple Mail Transfer Protocol (SMTP) response code that is returned by the receiving mail server during the bounce. This code provides technical insight into why delivery failed. |
| BounceCategory | String | Describes the high-level category of the bounce (for example, hard bounce or soft bounce). This value helps classify delivery failures for analytics and remediation. |
| SMTPReason | String | Provides the descriptive SMTP reason text that the receiving mail server returned with the bounce code. This value offers additional diagnostic information for troubleshooting delivery issues. |
| BounceType | String | Indicates a more specific type of bounce, which reflects the detailed nature of the delivery failure. This value assists with tracking, reporting, and automated response handling. |
| EventType | String | Specifies the tracking event type. For bounce events, this value identifies the record as part of bounce-related tracking activity. |
| TriggeredSendDefinitionObjectID | String | Specifies the object Id of the triggered send definition that is associated with the bounce event. This value links the event to a specific triggered send configuration. |
| BatchID | Int | Specifies the batch Id that groups triggered send events together. This value enables systems to correlate the bounce event with the batch of messages delivered during the same triggered send execution. |
Contains tracking data for link click events in Salesforce Marketing Cloud. Each record includes the timestamp, URL identifier (Id), and destination URL for a link that a subscriber clicked in a sent message. This view is essential for analyzing engagement metrics and user interaction behavior.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ClickEvent WHERE Id = 123 SELECT * FROM ClickEvent WHERE Id IN (123, 456) SELECT * FROM ClickEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-generated identifier (Id) that uniquely represents the click event record within Salesforce Marketing Cloud. This Id is read-only and allows tracking systems to reference the specific engagement activity. |
| ObjectID | String | Specifies the system-controlled, read-only text string that uniquely identifies the click event object across API operations. This value ensures consistency when retrieving, correlating, or auditing tracking data. |
| PartnerKey | String | Specifies the unique Id that an external partner system provides for the click event. This value is available only through the API and supports cross-platform reconciliation and event mapping. |
| CreatedDate | Datetime | Indicates the date and time when the click event record was created within the tracking system. This value supports auditing and historical analysis. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the click event record was updated. This value captures system adjustments that occur during processing or data normalization. |
| Client_ID | Int | Specifies the Id of the business unit that is associated with the click event. This value establishes the organizational context for the send and engagement activity. |
| SendID | Int | Specifies the Id of the email send that is associated with the click event. This Id ties the engagement activity to the specific send job that produced the message. |
| SubscriberKey | String | Specifies the unique subscriber key that identifies the contact who generated the click event. This value connects the engagement to a specific Salesforce Marketing Cloud contact record. |
| EventDate | Datetime | Indicates the date and time when the click tracking event occurred. This value reflects the moment when the subscriber clicked a tracked URL in the message. |
| EventType | String | Specifies the type of tracking event. For click events, this value identifies the activity as an interaction with a tracked URL. |
| TriggeredSendDefinitionObjectID | String | Specifies the object Id of the triggered send definition that is associated with the click event. This value links the engagement back to the triggered send configuration. |
| BatchID | Int | Specifies the batch Id that groups triggered send events together. This value allows reporting systems to correlate the click event with other events from the same triggered send execution. |
| URLID | Int | Specifies the Id of the URL that the subscriber clicked. This value maps the engagement to a tracked link in the message. |
| URL | String | Specifies the URL that the subscriber clicked as part of the tracking event. This value enables detailed reporting on link-level engagement. |
Represents individual fields within a data extension in Salesforce Marketing Cloud. Each field defines the data type, length, and attributes of a column in a data extension. This view provides metadata that supports schema validation and data integrity checks.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionField WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled identifier (Id) that uniquely identifies the data extension field object. This value is assigned internally and cannot be modified by users. |
| PartnerKey | String | Specifies the unique partner-provided key that is associated with the data extension field. This value is available only through API interactions. |
| CustomerKey | String | Specifies the user-supplied unique Id that identifies the data extension field within its object type. This value corresponds to the external key that is displayed in the user interface. |
| Name | String | Specifies the name of the data extension field. The name is visible in the user interface and is used to identify the column when interacting with the data extension. |
| DefaultValue | String | Specifies the default value that is assigned to the data extension field when no explicit value is provided during a data operation. |
| MaxLength | Int | Specifies the maximum allowable length for the field's stored value. This constraint is enforced during data writes and updates. |
| IsRequired | Bool | Returns a value of 'true' when the data extension field must contain a value and cannot be null. It returns a value of 'false' when the data extension field can remain empty during data operations. |
| Ordinal | Int | Specifies the position of the data extension field within the field collection. This value determines the ordering when the system processes or displays fields. |
| IsPrimaryKey | Bool | Returns a value of 'true' when the data extension field functions as a primary key for the data extension. It returns a value of 'false' when the data extension field does not participate in primary key enforcement. |
| FieldType | String | Specifies the data type of the data extension field. This value defines how the system stores, validates, and interprets the field's contents. |
| CreatedDate | Datetime | Indicates the date and time when the data extension field was created. This value is system-controlled. |
| ModifiedDate | Datetime | Indicates the date and time when the system last modified the data extension field. This information assists with auditing and lifecycle management. |
| Scale | Int | Specifies the numeric scale that is used for decimal fields. This value determines the number of digits that appear to the right of the decimal point. |
| Client_ID | Int | Specifies the Id of the client that is associated with the data extension field. |
| DataExtension_CustomerKey | String | Specifies the user-supplied unique Id of the data extension to which this field belongs. This value links the field definition to its parent data extension. |
| StorageType | String | Specifies the field's storage behavior. Valid values are Plain, Encrypted, Obfuscated, or Unspecified. These settings determine how the system stores and secures the field's data. |
Represents data extension templates in Salesforce Marketing Cloud. A template defines the structural blueprint that can be reused to create multiple data extensions with consistent schema design. This view allows administrators to standardize data collection and storage across campaigns.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataExtensionTemplate WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled identifier (Id) that uniquely identifies the data extension template object. This value is assigned internally and cannot be modified by users. |
| PartnerKey | String | Specifies the unique partner-provided key that is associated with the data extension template. This value is accessible only through the API. |
| CustomerKey | String | Specifies the user-supplied unique Id that identifies the data extension template within its object type. This value corresponds to the external key displayed in the user interface. |
| Name | String | Specifies the name of the data extension template. The name is used to identify the template in the user interface and during configuration. |
| CreatedDate | Datetime | Indicates the date and time when the data extension template was created. This value is read-only and maintained by the system. |
| ModifiedDate | Datetime | Indicates the date and time when the data extension template was last modified. This information supports auditing, change control, and lifecycle tracking. |
| Client_ID | Int | Specifies the Id of the client that is associated with the data extension template. |
| Description | String | Provides a human-readable explanation of the data extension template. This description helps users understand the template's purpose, usage, and behavior. |
| IsSendable | Bool | Returns a value of 'true' when the data extension template supports message sending operations in Salesforce Marketing Cloud. It returns a value of 'false' when the data extension template cannot be used as a sendable data source. |
| IsTestable | Bool | Returns a value of 'true' when the data extension template can be used in message test sends. It returns a value of 'false' when the data extension template cannot participate in test send workflows. |
| SendableCustomObjectField | String | Specifies the name of the field within the template that represents the sendable custom object field. This field must align with the subscriber Id that is used for message sends. |
| SendableSubscriberField | String | Specifies the name of the field within the template that identifies the subscriber to whom messages are sent. This field corresponds to either the subscriber key or the email address. |
| DataRetentionPeriodLength | String | Specifies the numeric duration of the data retention period that applies to the data extension template. This value defines how long data remains available before retention policies take effect. |
| DataRetentionPeriodUnitOfMeasure | Int | Specifies the unit of time that is associated with the data retention period (for example, days, weeks, or months). This unit works together with the DataRetentionPeriodLength value to determine total retention duration. |
| RowBasedRetention | Bool | Returns a value of 'true' when the system removes data based on the age of individual rows rather than the entire data set. It returns a value of 'false' when retention applies to the entire data extension as a whole. |
| ResetRetentionPeriodOnImport | Bool | Returns a value of 'true' when the system resets the retention period each time new data is imported into the data extension. It returns a value of 'false' when retention timelines continue uninterrupted regardless of imports. |
| DeleteAtEndOfRetentionPeriod | Bool | Returns a value of 'true' when the system deletes data automatically upon the completion of the configured retention period. It returns a value of 'false' when the system retains the data beyond the specified retention duration. |
| RetainUntil | Datetime | Specifies the calendar date and time until which the data will be retained under the active retention policy. This value determines when the final retention threshold is reached. |
Represents folders within a Salesforce Marketing Cloud account. Each folder organizes related content, data extensions, or automations into a hierarchical structure for easier management and access control. This view supports navigation and organizational reporting across stored assets.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DataFolder WHERE Id = 123 SELECT * FROM DataFolder WHERE Id IN (123, 456) SELECT * FROM DataFolder WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-generated identifier (Id) that uniquely identifies the data folder record. This value is read-only and is assigned automatically by the system. |
| Client_ID | Int | Specifies the Id of the client that owns or manages the data folder. This value determines the business context in which the folder exists. |
| ParentFolder_ID | Int | Specifies the Id of the parent data folder that contains this folder. This value establishes the hierarchical structure used to organize folders. |
| ParentFolder_CustomerKey | String | Specifies the user-supplied unique Id that is assigned to the parent folder within its object type. This value is used to reference the parent folder programmatically. |
| ParentFolder_ObjectID | String | Specifies the system-controlled, read-only text string that uniquely identifies the parent folder object. This Id remains consistent across system operations. |
| ParentFolder_Name | String | Specifies the name of the parent data folder. This value helps users understand the folder's placement within the folder hierarchy. |
| ParentFolder_Description | String | Provides descriptive information about the parent data folder. This description helps clarify the folder's purpose, business function, or organizational role. |
| ParentFolder_ContentType | String | Specifies the content type associated with the parent folder, which determines what kinds of assets or objects the folder can contain. |
| ParentFolder_IsActive | Bool | Returns a value of 'true' when the parent data folder is active and available for use. It returns a value of 'false' when the parent data folder is inactive or unavailable for operational tasks. |
| ParentFolder_IsEditable | Bool | Returns a value of 'true' when users can modify properties of the parent folder through the profile center. It returns a value of 'false' when the parent folder's properties are locked and cannot be edited. |
| ParentFolder_AllowChildren | Bool | Returns a value of 'true' when the parent data folder is allowed to contain child folders. It returns a value of 'false' when the parent data folder must remain a leaf folder without subordinate folders. |
| Name | String | Specifies the name of the data folder. The name is used for display, navigation, and organizational purposes across the user interface. |
| Description | String | Provides a human-readable description of the data folder. This description helps users understand the folder's role, purpose, and stored content. |
| ContentType | String | Specifies the content type that is associated with the data folder. The content type determines what types of objects or assets can be stored in this folder. |
| IsActive | Bool | Returns a value of 'true' when the data folder is active and can be accessed or managed. It returns a value of 'false' when the data folder is inactive or restricted by administrative settings. |
| IsEditable | Bool | Returns a value of 'true' when users can modify the data folder's properties through the profile center. It returns a value of 'false' when the folder's properties are fixed and cannot be changed. |
| AllowChildren | Bool | Returns a value of 'true' when the data folder supports the creation of child folders. It returns a value of 'false' when the folder is not permitted to have subordinate folders. |
| CreatedDate | Datetime | Indicates the date and time when the data folder was created. This value is read-only and supports auditing and historical tracking. |
| ModifiedDate | Datetime | Indicates the date and time when the data folder was last modified. This information supports change management and version control. |
| Client_ModifiedBy | Int | Specifies the Id of the user who last modified the data folder. This value supports audit logging and administrative oversight. |
| ObjectID | String | Specifies the system-controlled, read-only text string that uniquely identifies the data folder object. This identifier supports internal system processes and external API references. |
| CustomerKey | String | Specifies the user-supplied unique Id that identifies the data folder within its object type. This value is commonly used for automation, API interactions, and configuration references. |
| Client_EnterpriseID | Long | Specifies the enterprise-level Id that is associated with the client record. |
| Client_CreatedBy | Int | Specifies the Id of the user who created the data folder. This information supports auditing and regulatory compliance. |
Defines mobile-originated (MO) keywords used for double opt-in workflows in Salesforce Marketing Cloud. Each record specifies the keyword that allows mobile users to confirm subscriptions through a two-step consent process. This view ensures compliance with opt-in regulations and supports secure subscriber management.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM DoubleOptInMOKeyword WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | The unique identifier (Id) of the client associated with this mobile-originated (MO) keyword configuration. |
| CreatedDate | Datetime | The read-only date and time when this MO keyword configuration was created. This value is system-controlled. |
| ModifiedDate | Datetime | The date and time when this MO keyword configuration was last modified. This value allows administrators to track update history. |
| CustomerKey | String | The user-supplied unique Id for this MO keyword configuration within its object type. |
| IsDefaultKeyword | Bool | Returns a value of 'true' when this MO keyword configuration functions as the default Short Message System (SMS) keyword handling rule for the account. It returns a value of 'false' when another keyword configuration governs default SMS keyword behavior. |
| DefaultPublication_ID | Int | The read-only Id for the default publication list that is associated with this MO keyword workflow. |
| InvalidPublicationMessage | String | The message that is sent to a subscriber who attempts to subscribe or unsubscribe from a publication list that is not valid for this double opt-in workflow. |
| InvalidResponseMessage | String | The message that is sent to a subscriber who responds with input that is not recognized as a valid action or confirmation during the double opt-in process. |
| MissingPublicationMessage | String | The message that is sent to a subscriber when the system cannot determine which publication list the subscriber intends to join or leave during the double opt-in process. This message prompts the subscriber to specify a valid publication list so the request can continue. |
| NeedPublicationMessage | String | The message that is sent to a subscriber whose response does not indicate which publication list they intend to join or leave. This message prompts the subscriber to specify a valid list. |
| PromptMessage | String | The message that is sent to the subscriber as part of the double opt-in process to request a confirming response. |
| SuccessMessage | String | The SMS message that is sent to the subscriber after a triggered email send succeeds as part of the double opt-in workflow. |
| UnexpectedErrorMessage | String | The message that is sent to the subscriber when an unexpected system error interrupts the double opt-in process. |
| ValidPublications | String | The list of publication identifiers that are permitted for use with this double opt-in configuration. These values determine which lists subscribers can confirm. |
| ValidResponses | String | The set of acceptable subscriber responses that complete the double opt-in process. These values determine how the system interprets subscriber confirmation actions. |
Provides information about the most recent retrieval of file-trigger activity for each trigger type. This view helps track when a file-based trigger was last evaluated
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID = 'nzxcaslkjd-123'
SELECT * FROM FileTriggerTypeLastPull WHERE ObjectID IN ('nzxcaslkjd-123', 'nzxcaslkjd-456')
| Name | Type | Description |
| Client_ID | Long | Specifies the client identifier (Id) that associates the record with the correct Salesforce Marketing Cloud account context. This value ensures that file-trigger pull tracking is scoped to the appropriate business unit or enterprise environment. |
| ObjectID [KEY] | String | Stores the system-controlled text string Id that uniquely identifies this file-trigger pull record. This identifier is read-only and ensures consistency when referencing the record across internal processes and API interactions. |
| ExternalReference | String | Captures an optional external reference value that can link this file-trigger pull record to outside systems, configuration inputs, or workflow components that participate in file-trigger activity. |
| Type | String | Indicates the type that is associated with the file-trigger category. This value helps classify how the trigger source should be interpreted and ensures that pull history is grouped according to its functional role. |
| LastPullDate | Datetime | Indicates the most recent date and time when the system attempted to retrieve or evaluate files for the specified trigger type. This timestamp supports auditing, monitoring, and troubleshooting of file-trigger operations. |
Records events in which a subscriber used the Forward to a Friend feature to share an email with another recipient in Salesforce Marketing Cloud. Each record includes details such as the sender, recipient, and timestamp of the forwarding action. This view supports tracking viral sharing and referral engagement.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailEvent WHERE Id = 123 SELECT * FROM ForwardedEmailEvent WHERE Id IN (123, 456) SELECT * FROM ForwardedEmailEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Stores the read-only identifier (Id) that uniquely identifies this forwarded email event record. This Id is used for tracking, troubleshooting, and referencing individual forwarding actions within Marketing Cloud. |
| ObjectID | String | Stores the system-controlled text string Id that uniquely identifies this event object across Salesforce Marketing Cloud systems. This value ensures consistent referencing in reporting, automation, and API retrieval operations. |
| PartnerKey | String | Contains the partner-supplied unique Id that links this forwarded email event to an external integration. This key provides cross-platform traceability when partner systems participate in email activity processing. |
| CreatedDate | Datetime | Indicates the date and time when the record for the forwarded email event was created. This timestamp supports event auditing and helps reconstruct email activity timelines. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the record for the forwarded email event was updated. This value supports troubleshooting and event reconciliation when forwarding behavior changes. |
| Client_ID | Int | Specifies the client Id that associates the forwarded email event with the correct Salesforce Marketing Cloud account or business unit. This value ensures that tracking data is evaluated within the proper account context. |
| SendID | Int | Specifies the Id of the send operation that originally delivered the email. This value allows downstream reporting and tracking tools to correlate the forwarding event with the specific message send. |
| SubscriberKey | String | Stores the unique subscriber key that is associated with the contact who forwarded the email. This value identifies the individual whose interaction triggered the forwarding event. |
| EventDate | Datetime | Indicates the date and time when the subscriber forwarded the email. This timestamp helps reconstruct subscriber engagement patterns and forwarding chains. |
| EventType | String | Specifies the type of tracking event that is recorded for the forwarded email action. This value helps classification systems distinguish forwarding events from opens, clicks, bounces, or other engagement activities. |
| TriggeredSendDefinitionObjectID | String | Stores the system-controlled text string Id that identifies the triggered send definition that is associated with the forwarded email event. This Id links the activity to the definition that produced the email. |
| BatchID | Int | Specifies the batch Id that is used to group this forwarded email event with related tracking events. This value enables reporting tools to aggregate engagement activity for the same send execution. |
Specifies opt-in events that occur when a recipient subscribes as a result of receiving a Forward to a Friend email in Salesforce Marketing Cloud. This view helps identify new subscribers who joined through referral-based interactions.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ForwardedEmailOptInEvent WHERE Id = 123 SELECT * FROM ForwardedEmailOptInEvent WHERE Id IN (123, 456) SELECT * FROM ForwardedEmailOptInEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Stores the read-only identifier (Id) that uniquely identifies this forwarded email opt-in event record. This Id is used for tracking, auditing, and referencing individual opt-in actions that occur through forwarded email interactions. |
| ObjectID | String | Stores the system-controlled text string Id that uniquely identifies this event object across Salesforce Marketing Cloud systems. This value ensures consistent referencing in reporting, automation, and API-based operations. |
| PartnerKey | String | Contains the partner-defined unique Id that links this forwarded email opt-in event to an external integration. This key supports cross-system traceability when partner platforms participate in opt-in processing. |
| CreatedDate | Datetime | Indicates the date and time when the record for the forwarded email opt-in event was created. This timestamp supports event auditing and helps reconstruct subscriber engagement timelines. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the forwarded email opt-in event record was updated. This value supports troubleshooting and reconciliation activities. |
| Client_ID | Int | Specifies the client Id that associates the forwarded email opt-in event with the appropriate Salesforce Marketing Cloud account or business unit. This association ensures that opt-in activity is evaluated within the correct account context. |
| SendID | Int | Specifies the Id of the send operation that delivered the original email that led to the opt-in. This value allows downstream reporting tools to link the opt-in activity to the specific message send. |
| SubscriberKey | String | Stores the subscriber key that identifies the contact associated with the original forwarded email interaction. This value distinguishes the forwarding contact from the subscriber who opted in. |
| EventDate | Datetime | Indicates the date and time when the forwarded email opt-in event occurred. This information helps reconstruct engagement patterns and opt-in sequences. |
| EventType | String | Specifies the type of tracking event captured for the forwarded email opt-in action. This classification allows reporting tools to differentiate opt-ins from other engagement events such as opens, clicks, or bounces. |
| TriggeredSendDefinitionObjectID | String | Stores the system-controlled text string Id that identifies the triggered send definition that is associated with this opt-in event. This Id links the activity back to the triggered send configuration that produced the email. |
| BatchID | Int | Specifies the batch Id used to group this forwarded email opt-in event with other related tracking events. This grouping supports aggregated reporting for a specific send execution. |
| OptInSubscriberKey | String | Stores the subscriber key of the individual who opted in through the forwarded email process. This value identifies the newly opted-in subscriber and differentiates this contact from the subscriber who performed the forwarding action. |
Defines the actions associated with the HELP Short Message Service (SMS) keyword for a Salesforce Marketing Cloud account. The HELP keyword allows subscribers to request information about the sender or message program. This view supports compliance with mobile communication standards.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM HelpMOKeyword WHERE Client_ID = 123 SELECT * FROM HelpMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM HelpMOKeyword WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | Specifies the client identifier (Id) that associates the HELP mobile-originated (MO) keyword configuration with the correct Salesforce Marketing Cloud account or business unit. This value ensures that keyword behaviors are evaluated within the proper account context. |
| CreatedDate | Datetime | Indicates the read-only date and time when the HELP MO keyword configuration was created. This timestamp supports auditing and historical tracking of keyword setup activity. |
| ModifiedDate | Datetime | Indicates the most recent date and time when the HELP MO keyword configuration was updated. This information helps administrators track changes made to keyword behavior or messaging. |
| CustomerKey | String | Stores the user-supplied unique Id for this HELP MO keyword configuration. This value corresponds to the external key that is assigned within the user interface and supports consistent referencing in API operations. |
| IsDefaultKeyword | Bool | Returns a value of 'true' when the system should treat this HELP keyword configuration as the default option in cases where no other keyword rules apply. It returns a value of 'false' when another keyword configuration is explicitly selected or available. |
| MoreChoicesPrompt | String | Contains the text that informs the mobile message sender that additional choices or menu options are available as part of a HELP keyword response. This content supports guided navigation through multi-option HELP sequences. |
| DefaultHelpMessage | String | Stores the default HELP message text that is delivered to subscribers who request HELP through an MO message. This value ensures that a consistent and compliant HELP response is sent when no custom messaging is configured. |
| MenuText | String | Defines the text used to present multiple selectable options in response to a HELP MO request. This text is used when HELP actions include menu-style interactions for subscribers. |
| FriendlyName | String | Contains the user-friendly display name for the HELP MO keyword. This value provides an easily recognizable reference for administrators configuring or reviewing keyword behavior. |
Provides summary results for import jobs that were initiated from an import definition in Salesforce Marketing Cloud. Each record includes the total rows processed, successful imports, and errors encountered. This retrieve-only view supports reporting and monitoring of data import performance.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ImportResultsSummary WHERE Id = 123 SELECT * FROM ImportResultsSummary WHERE Id IN (123, 456) SELECT * FROM ImportResultsSummary WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled text string identifier (Id) that is assigned to this import-results summary object. |
| ID | Int | Returns the read-only Id that uniquely identifies this summary record. |
| Client_ID | Long | Specifies the Id of the client that is associated with this import-results summary. |
| ImportDefinitionCustomerKey | String | Specifies the customer key that is associated with the import definition that produced these results. |
| TaskResultID | Int | Returns the task result Id that is associated with this summary of import results. |
| ImportStatus | String | Specifies the status of the import operation that generated this summary. |
| StartDate | String | Indicates the start date for the time range that is used to retrieve import-result information. |
| EndDate | String | Specifies the end date for the time range that is used to retrieve import-result information. |
| DestinationID | String | Specifies the Id of the list or data extension that received the imported records. |
| NumberSuccessful | Int | Indicates the number of records that were successfully imported during the operation. |
| NumberDuplicated | Int | Indicates the number of duplicated records that were encountered during the import operation. |
| NumberErrors | Int | Indicates the number of records that resulted in errors during the import process. |
| TotalRows | Int | Indicates the total number of rows included in this import-results summary. |
| ImportType | String | Specifies the type of import that was performed. |
Provides link-level details for email sends in Salesforce Marketing Cloud. Each record identifies a specific link, its tracking identifier (Id), and its relationship to a send event. This view supports engagement analysis by correlating links to subscriber click behavior.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM LinkSend WHERE Id = 123 SELECT * FROM LinkSend WHERE Id IN (123, 456) SELECT * FROM LinkSend WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies this link-send record. |
| SendID | Int | Specifies the Id of the send operation that is associated with the link activity. |
| PartnerKey | String | Specifies the unique identifier that is provided by a partner for this object when accessed through the API. |
| Client_ID | Int | Specifies the Id of the client that is associated with this link-send record. |
| Client_PartnerClientKey | String | Specifies the partner-defined client key that is associated with the account. |
| Link_ID | Int | Specifies the Id of the link referenced in the context of the send. |
| Link_PartnerKey | String | Specifies the unique identifier that is provided by a partner for the link object when accessed through the API. |
| Link_TotalClicks | Int | Indicates the total number of clicks that are recorded for the link across all recipients. |
| Link_UniqueClicks | Int | Indicates the number of unique recipients who clicked the link at least once. |
| Link_URL | String | Specifies the URL that is associated with the tracked link in the send. |
| Link_Alias | String | Specifies the descriptive name that is assigned to the link within the message. |
Provides retrieve-only properties that describe the lists associated with completed send operations in Salesforce Marketing Cloud. Each record links a send event to one or more lists to support campaign tracking and performance analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSend WHERE Id = 123 SELECT * FROM ListSend WHERE Id IN (123, 456) SELECT * FROM ListSend WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies the list-send record. |
| PartnerKey | String | Specifies the unique Id that is provided by a partner for the list-send record when accessed through the API. |
| Client_ID | Int | Specifies the Id of the client that owns or manages the send activity. |
| SendID | Int | Specifies the Id of the specific send operation associated with this record. |
| List_ID | Int | Specifies the read-only Id of the list that is associated with the send. |
| List_ListName | String | Specifies the name of the list that was used as the audience for the send. |
| Duplicates | Int | Specifies the number of duplicate email addresses that were detected across the lists included in the send. This value only appears when the send targets multiple lists. |
| InvalidAddresses | Int | Specifies the number of email addresses that were identified as invalid during the send process. |
| ExistingUndeliverables | Int | Specifies the number of email addresses that were already marked as undeliverable before the send occurred. |
| ExistingUnsubscribes | Int | Specifies the number of email addresses that were already unsubscribed before the send occurred. |
| HardBounces | Int | Specifies the number of hard bounces that occurred during the send. A hard bounce indicates a permanent delivery failure. |
| SoftBounces | Int | Specifies the number of soft bounces that occurred during the send. A soft bounce indicates a temporary or intermittent delivery failure. |
| OtherBounces | Int | Specifies the number of bounces that were classified as Other-type bounces during the send. |
| ForwardedEmails | Int | Specifies the number of forwarded email events that were recorded for the send. |
| UniqueClicks | Int | Specifies the number of unique contacts who clicked at least one tracked link within the message. |
| UniqueOpens | Int | Specifies the number of unique contacts who opened the message at least once as part of this send. |
| NumberSent | Int | Specifies the total number of emails that were sent during the send action. This value includes messages that later resulted in bounces. |
| NumberDelivered | Int | Specifies the number of sent emails that were successfully delivered and did not bounce. |
| Unsubscribes | Int | Specifies the number of unsubscribe events that occurred as a result of this send. |
| MissingAddresses | Int | Specifies the number of records in the send that did not contain a valid email address. |
| PreviewURL | String | Specifies the URL that can be used to preview the message associated with the send. |
Retrieves subscriber relationships for lists in Salesforce Marketing Cloud. Each record shows which lists a subscriber belongs to or which subscribers are assigned to a list. This view supports subscription management and audience segmentation reporting.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ListSubscriber WHERE Id = 123 SELECT * FROM ListSubscriber WHERE Id IN (123, 456) SELECT * FROM ListSubscriber WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies the list-subscriber record. |
| ObjectID | String | Specifies the system-controlled text string that the platform generates to identify this list-subscriber record. |
| SubscriberKey | String | Specifies the unique subscriber key that identifies the individual subscriber associated with the list entry. |
| CreatedDate | Datetime | Specifies the read-only date and time when the list-subscriber record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the list-subscriber record was last modified. |
| Client_ID | Int | Specifies the Id of the client that owns or manages the subscriber and list association. |
| Client_PartnerClientKey | String | Specifies the user-defined partner key that is associated with the client for integration or partner tracking. |
| ListID | Int | Specifies the Id of the list on which the subscriber resides. |
| Status | String | Specifies the current subscription status for the subscriber on the list (for example, 'Active', 'Unsubscribed', or 'Held'). |
| UnsubscribedDate | Datetime | Specifies the date and time when the subscriber unsubscribed from the list. |
[DEPRECATED] Contains vendor details for Short Message Service (SMS) or voice messaging providers that are integrated with Salesforce Marketing Cloud. Each record identifies a messaging vendor and its communication channel type.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM MessagingVendorKind WHERE Id = 123 SELECT * FROM MessagingVendorKind WHERE Id IN (123, 456) SELECT * FROM MessagingVendorKind WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies the messaging-vendor kind record. |
| Vendor | String | [DEPRECATED] Provides the legacy vendor name that was historically associated with a messaging-vendor configuration. |
| Kind | String | [DEPRECATED] Provides the legacy classification or type that was historically applied to the messaging-vendor record. |
| IsUsernameRequired | Bool | [DEPRECATED] Returns a value of 'true' when the legacy messaging-vendor configuration requires a username for authentication. It returns a value of 'false' when a username ks not required. |
| IsPasswordRequired | Bool | [DEPRECATED] Returns a value of 'true' when the legacy messaging-vendor configuration required a password for authentication. It returns a value of 'false' when a password was not required. |
| IsProfileRequired | Bool | [DEPRECATED] Returns a value of 'true' when the legacy messaging-vendor configuration required an associated user profile. It returns a value of 'false' when no profile was required. |
| CreatedDate | Datetime | Specifies the date and time when the messaging-vendor kind record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the messaging-vendor kind record was last modified. |
Contains information about email messages that failed to send in Salesforce Marketing Cloud. Each record includes diagnostic codes and timestamps to support root-cause analysis of delivery failures.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM NotSentEvent WHERE SendID = 123 SELECT * FROM NotSentEvent WHERE SendID IN (123, 456) SELECT * FROM NotSentEvent WHERE CreatedDate > '2024/01/25'
| Name | Type | Description |
| SendID | Int | Specifies the identifier (Id) of the specific send that is associated with the not-sent event. |
| SubscriberKey | String | Specifies the value that identifies the subscriber that is associated with the not-sent event within Salesforce Salesforce Marketing Cloud. |
| EventDate | Datetime | Indicates the date and time when the not-sent tracking event occurred. |
| Client_ID | Int | Specifies the Id of the client that is associated with the event. |
| EventType | String | Specifies the classification of the tracking event that captures why the message was not sent. |
| BatchID | Int | Specifies the batch Id that groups the event with related triggered-send activity. |
| TriggeredSendDefinitionObjectID | String | Specifies the system-generated object Id that is used to associate the event with its corresponding triggered send definition. |
| ListID | Int | Specifies the list Id that identifies the list to which the subscriber belonged at the time of the not-sent event. |
| PartnerKey | String | Specifies the partner-provided unique Id used by external systems to reference the event through the API. |
| SubscriberID | Int | Specifies the Id that uniquely identifies the subscriber within Marketing Cloud. |
Records open events for email sends in Salesforce Marketing Cloud. Each record includes the timestamp, subscriber key, and send context for an opened message. This view provides key engagement metrics for campaign performance analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM OpenEvent WHERE Id = 123 SELECT * FROM OpenEvent WHERE Id IN (123, 456) SELECT * FROM OpenEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies the open-event record. |
| ObjectID [KEY] | String | Specifies the system-controlled, read-only text string that serves as the unique object Id for the open-event record. |
| PartnerKey | String | Specifies the partner-supplied unique Id that external systems use to reference the event through the API. |
| CreatedDate | Datetime | Indicates the date and time when the open-event record was created. |
| ModifiedDate | Datetime | Indicates the date and time when information about the open-event record was last modified. |
| ClientID [KEY] | Int | Specifies the Id of the client that is associated with the open-event record. |
| SendID | Int | Specifies the Id of the specific send that is associated with the open event. |
| SubscriberKey | String | Specifies the value that identifies the subscriber who generated the open event. |
| EventDate | Datetime | Indicates the date and time when the open tracking event occurred. |
| EventType | String | Specifies the category of tracking event recorded for the open action. |
| TriggeredSendDefinitionObjectID | String | Specifies the system-generated object Id that links the open event to its associated triggered send definition. |
| BatchID | Int | Specifies the batch Id that groups the open event with related triggered-send activity. |
Contains details about private IP addresses that are assigned for message sends in Salesforce Marketing Cloud. Each record identifies the dedicated IP address used for outbound email delivery, supporting IP reputation management and sender authentication practices.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PrivateIP WHERE Id = 123 SELECT * FROM PrivateIP WHERE Id IN (123, 456) SELECT * FROM PrivateIP WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the read-only identifier (Id) that uniquely identifies the private internet protocol (IP) record. |
| PartnerKey | String | Specifies the partner-provided unique Id that external systems use to reference the private IP record through the API. |
| CreatedDate | Datetime | Indicates the date and time when the private IP record was created. |
| Client_ID | Int | Specifies the Id of the client that is associated with the private IP record. |
| Name | String | Specifies the name assigned to the private IP record for organizational or administrative reference. |
| Description | String | Provides descriptive information that explains the purpose, configuration, or operational role of the private IP record. |
| IsActive | Bool | Returns a value of 'true' when the private IP address is active and available for use in send operations or delivery configurations. It returns a value of 'false' when the private IP address is inactive, retired, or restricted by administrative controls. |
| OrdinalID | String | Specifies the positional Id that indicates where this private IP record appears within an ordered sequence of related configuration items. |
| IPAddress | String | Specifies the private IP address that is used for message delivery, authentication, or domain alignment within Marketing Cloud. |
| Client_PartnerClientKey | String | Specifies the partner-supplied client key that external systems use to correlate the private IP record with partner-side account identifiers. |
Represents publication-level configuration details that support managing how subscriber-facing content is organized and distributed in Salesforce Marketing Cloud. This view provides structural information that describes publication settings, visibility rules, and relationships used in content distribution workflows.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM Publication WHERE Id = 123 SELECT * FROM Publication WHERE Id IN (123, 456) SELECT * FROM Publication WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-defined identifier (Id) that uniquely identifies the publication within the account. |
| PartnerKey | String | Provides a unique Id that is supplied by an external partner system and is available only through API access. This value enables system-to-system correlation when multiple platforms exchange publication metadata. |
| CreatedDate | Datetime | Specifies the read-only date and time when the publication was initially created. |
| ModifiedDate | Datetime | Specifies the date and time when the publication record was most recently modified. |
| Client_ID | Int | Specifies the Id of the client account that owns or manages the publication. |
| Client_PartnerClientKey | String | Specifies the partner-supplied key that associates the publication with a specific client context for integration or reporting purposes. |
| Name | String | Specifies the user-defined name of the publication. The name appears in configuration tools and API responses to help users identify the publication. |
| Category | Int | Specifies the Id of the folder in which the publication is stored. This categorization helps organize publication assets within the account's folder hierarchy. |
Describes subscribers who are associated with a publication list in Salesforce Marketing Cloud. Each record defines a subscriber's status, preferences, and linkage to a specific publication for audience management and compliance tracking.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| Publication_ID | Int | Specifies the system-defined identifier (Id) that uniquely identifies the publication associated with the subscriber. |
| Publication_PartnerKey | String | Specifies the partner-supplied unique Id that external systems use to correlate publication records during API-driven integrations. |
| Publication_CreatedDate | Datetime | Specifies the read-only date and time when the publication that is associated with this subscriber was created. |
| Publication_ModifiedDate | Datetime | Specifies the date and time when the publication record associated with this subscriber was most recently modified. |
| Publication_Client_ID | Int | Specifies the Id of the client account that owns the publication that is associated with this subscriber. |
| Publication_Client_PartnerClientKey | String | Specifies the partner-defined key that associates the publication with a specific client context for integration or reporting purposes. |
| Client_ID | Int | Specifies the Id of the client account that owns or manages the subscriber record. |
| Client_PartnerClientKey | String | The partner-defined key that links the subscriber record to an external client integration context. |
| Publication_Name | String | Specifies the user-defined name of the publication to which the subscriber is linked. |
| Publication_Category | Int | Specifies the Id of the folder in which the publication is organized, which helps categorize publication assets within the account's folder hierarchy. |
| Subscriber_ID | Int | Specifies the system-defined Id that uniquely identifies the subscriber record. |
| Subscriber_SubscriberKey | String | The subscriber key that uniquely identifies the individual subscriber across Salesforce Marketing Cloud channels. |
| Subscriber_PrimarySMSAddress_AddressType | String | Provides the type of Short Message Service (SMS) address that is associated with the subscriber's primary mobile messaging profile, such as a short code or long code. |
| Subscriber_PrimarySMSAddress_Address | String | Specifies the mobile number or code value that is used as the subscriber's primary SMS address for publication-based messaging. |
| Subscriber_PrimarySMSAddress_Carrier | String | Specifies the mobile carrier that is associated with the subscriber's primary SMS address. This information can be used for routing, reporting, or compliance checks. |
| Subscriber_PrimarySMSPublicationStatus | String | Specifies the subscriber's SMS publication status, which indicates whether the subscriber is opted in, opted out, pending confirmation, or restricted from receiving publication messages. |
Provides information about public encryption keys that are stored in Salesforce Marketing Cloud for use in secure data exchange and authentication workflows. This view helps identify which keys are available for validating signatures, encrypting payloads, or establishing trusted integrations with external systems.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM PublicKeyManagement WHERE Id = 123 SELECT * FROM PublicKeyManagement WHERE Id IN (123, 456) SELECT * FROM PublicKeyManagement WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-defined identifier (Id) that uniquely identifies the public key record within the account. |
| Client_ID | Long | Specifies the Id of the client account that owns or manages the public key. |
| Name | String | Provides the descriptive name that is assigned to the public key entry. This name helps administrators recognize the appropriate key for encryption, validation, or integration tasks. |
| PartnerKey | String | Specifies the partner-supplied unique Id that external systems use to correlate the key record during API-based integrations. |
| Key | String | Specifies the stored public key material that is used for encryption, signature verification, or secure message exchange within supported Salesforce Marketing Cloud workflows. |
| CreatedDate | Datetime | Specifies the read-only date and time when the public key record was initially created. |
| ModifiedDate | Datetime | Specifies the date and time when the public key record was most recently modified. |
Contains the individual result records returned from an asynchronous API call in Salesforce Marketing Cloud. Each record represents the outcome of a processed item, such as a contact import or message send.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID = 123 SELECT * FROM ResultItem WHERE AsyncAPIRequestQueueID IN (123, 456) SELECT * FROM ResultItem WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| AsyncAPIRequestQueueID | Int | Specifies the identifier (Id) of the asynchronous API request queue that stores and tracks queued API operations. |
| RequestID | String | Specifies the unique Id of the initial asynchronous API call that initiated the request. |
| ConversationID | String | Specifies the unique Id that groups together multiple asynchronous API calls that must be processed as a single logical unit. |
| CorrelationID | String | Identifies the correlation key that links related objects and operations across multiple asynchronous requests. |
| Client_ID | Int | Indicates the Id of the client that is associated with the asynchronous API request. |
| CreatedDate | Datetime | Indicates the date and time when the result item was created as part of asynchronous API processing. |
| StatusCode | String | Defines the status code returned for the asynchronous API request. |
| StatusMessage | String | Describes the detailed status of the asynchronous API call, including success, warnings, or errors. |
| OrdinalID | Int | Specifies the system-controlled, read-only ordinal Id that represents the position of the result item within a sequence. |
| ErrorCode | Int | Identifies the numeric error code that is returned when the asynchronous API request encounters a failure condition. |
| RequestType | String | Indicates whether the API request was processed as a synchronous or asynchronous operation. |
| RequestObjectType | String | Defines the type of object that is involved in the API request, such as an email, data extension, or triggered send. |
| ResultType | Int | Indicates whether the returned result originated from synchronous or asynchronous API processing. |
| Client_PartnerClientKey | String | Specifies the user-defined partner client key that is assigned to the account for partner-level correlation and tracking. |
Contains summary messages generated from asynchronous API calls in Salesforce Marketing Cloud. Each message provides status information, execution results, or error diagnostics to assist in monitoring API-based processes.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM ResultMessage WHERE RequestID = 123 SELECT * FROM ResultMessage WHERE RequestID IN (123, 456) SELECT * FROM ResultMessage WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| RequestID | String | Specifies the unique identifier (Id) of the initial asynchronous API call that initiated the overall request workflow. |
| ConversationID | String | Specifies the Id that represents the conversation context for the asynchronous API call. All related requests that must be processed as a single unit share this Id. |
| Client_ID | Int | Specifies the Id of the client that is associated with the asynchronous API operation. |
| CreatedDate | Datetime | Indicates the date and time when the result message object was created. |
| OverallStatusCode | String | Defines the overall status returned for the asynchronous API conversation. |
| StatusCode | String | Indicates the status returned for the individual asynchronous API request. |
| StatusMessage | String | Provides a descriptive message that explains the status of the asynchronous API call. |
| ErrorCode | Int | Identifies the error that is associated with the asynchronous API request by using a numeric code. |
| RequestType | String | Defines whether the request that is represented by the result message is processed through synchronous or asynchronous API behavior. |
| ResultType | String | Indicates whether the result that is returned by the system originated from synchronous or asynchronous API processing. |
| ResultDetailXML | String | Contains detailed result information for the request in XML format, enabling structured inspection of outcomes. |
| Client_PartnerClientKey | String | Specifies the user-defined partner key that is associated with the client. |
Defines user roles and permissions that are assigned within a Salesforce Marketing Cloud account. Each record specifies access levels, feature entitlements, and user group associations. This view supports auditing of security and access configurations.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled identifier (Id) that is used to uniquely identify the role object. This value is read-only. |
| CustomerKey | String | Specifies the user-supplied unique Id for the role object within the broader object type. This value is typically assigned through the user interface or an API workflow. |
| Name | String | Specifies the name of the role. This name is displayed in administrative tools and user-permissions settings. |
| Description | String | Provides descriptive information that is used to document the role's purpose, functional scope, or administrative use. |
| IsPrivate | Bool | Returns a value of 'true' when the role is a private role that is defined by a specific Salesforce Marketing Cloud account rather than by the platform. It returns a value of 'false' when the role is a standard role that is available across accounts. |
| IsSystemDefined | Bool | Returns a value of 'true' when the role is a system-defined role that is created and maintained by the Salesforce Marketing Cloud application. It returns a value of 'false' when the role is a custom role that is created and managed by an administrator. |
| Client_EnterpriseID | Long | Specifies the enterprise-level Id that is associated with the client in multi-business-unit environments. This value is reserved for future use. |
| Client_ID | Int | Specifies the Id of the client that owns or manages the role record. |
| Client_CreatedBy | Int | Specifies the Id of the user that is responsible for creating the role object. |
| CreatedDate | Datetime | Specifies the date and time when the role object was created. This value is read-only. |
| Client_ModifiedBy | Int | Specifies the Id of the user that is responsible for modifying the role object. |
| ModifiedDate | Datetime | Indicates the date and time when the role object was last modified. |
| PermissionSets | String | Specifies the permission sets that are applied to the role. Each permission set groups related capabilities that can be assigned collectively. |
| Permissions | String | Specifies the array of individual permissions that are associated with the role. Each permission defines a distinct operational capability within Salesforce Marketing Cloud. |
Defines the action that sends a triggered email message in response to a mobile-originated (MO) message in Salesforce Marketing Cloud. This view maps keywords in Short Message Service (SMS) messages to corresponding triggered email sends for integrated cross-channel automation.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendEmailMOKeyword WHERE Client_ID = 123 SELECT * FROM SendEmailMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM SendEmailMOKeyword WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | Specifies the identifier (Id) of the client that owns or administers the mobile-originated (MO) keyword configuration. |
| CreatedDate | Datetime | Specifies the date and time when the MO keyword configuration object was created. This value is system-generated and read-only. |
| ModifiedDate | Datetime | Indicates the date and time when the MO keyword configuration object was last modified. This value reflects administrative or automated updates. |
| CustomerKey | String | Specifies the user-supplied unique Id for the MO keyword configuration within its object type. This Id is required for API access and cross-object references. |
| NextState_CustomerKey | String | Specifies the customer key that is associated with the next workflow state that is executed after this keyword is processed. |
| IsDefaultKeyword | Bool | Returns a value of 'true' when the system defaults to this SMS keyword action because no other keyword options are available. It returns a value of 'false' when the system does not treat this configuration as the default keyword action. |
| SuccessMessage | String | Specifies the Short Message Service (SMS) message that is sent to the mobile user when a triggered email send succeeds as a result of the keyword action. This message confirms that the requested email operation was successful. |
| MissingEmailMessage | String | Specifies the SMS message that is sent when an MO keyword submission does not include a valid email address. This message prompts the user to provide correct information. |
| FailureMessage | String | Specifies the SMS message that is sent to the mobile user when the system attempts but fails to send the triggered email that is associated with the keyword action. This message informs the user of the failure. |
| TriggeredSend_CustomerKey | String | Specifies the customer key that is associated with the triggered send definition that is executed when this keyword is received. |
Defines the actions taken when Salesforce Marketing Cloud receives a specific mobile-originated (MO) keyword. Each record links a keyword to an automation or message send workflow to support two-way Short Message Serviec (SMS) communication.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSMSMOKeyword WHERE Client_ID = 123 SELECT * FROM SendSMSMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM SendSMSMOKeyword WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | Specifies the Id of the client that owns or manages the Short Message Service (SMS) keyword configuration. |
| CreatedDate | Datetime | Indicates the system-generated date and time when the SMS MO keyword record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the SMS MO keyword record was last modified as part of administrative or automated updates. |
| NextMOKeyword_CustomerKey | String | Specifies the customer key that identifies the next mobile-originated (MO) keyword to use in an SMS conversation flow. This value defines the follow-up keyword that is referenced when the current keyword workflow transitions to another processing state. |
| CustomerKey | String | Specifies the user-supplied unique Id for the SMS MO keyword configuration within its object type. This Id is used for API interactions and cross-object references. |
| ObjectID [KEY] | String | Specifies the system-controlled object Id that uniquely identifies the SMS MO keyword record within Marketing Cloud. |
| IsDefaultKeyword | Bool | Returns a value of 'true' when the account defaults to this SMS keyword action because no other applicable keyword options are available. It returns a value of 'false' when another keyword action is selected or explicitly configured for the incoming message. |
| Message | String | Specifies the message content that is returned to the subscriber as part of the SMS MO keyword response workflow. |
| ScriptErrorMessage | String | Specifies the message that is delivered to the subscriber when an error occurs while processing the SMS MO keyword conversation. This message provides fallback guidance when scripted logic cannot be executed. |
Provides summary information for a completed send event in Salesforce Marketing Cloud. Each record includes key metrics such as total sent, delivered, opened, and bounced messages. This retrieve-only view supports campaign reporting and performance analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SendSummary WHERE Client_ID = 123 SELECT * FROM SendSummary WHERE Client_ID IN (123, 456) SELECT * FROM SendSummary WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | Specifies the identifier (Id) of the client that owns or operates the send activity. |
| AccountID | Int | Specifies the unique Id for the account that is associated with the send summary record. This Id is used to link sending activity back to the originating account. |
| SendID | Int | Specifies the Id that identifies the specific send operation for which summary information is being reported. |
| DeliveredTime | String | Indicates the time at which the message that is associated with the send was delivered to the destination system or provider. |
| CreatedDate | Datetime | Indicates the system-generated date and time when the send summary record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the send summary record was last modified as part of reporting or administrative updates. |
| CustomerKey | String | Specifies the user-supplied unique Id that is assigned to this send summary object within its object type. |
| PartnerKey | String | Specifies the partner-supplied unique Id that is associated with this send summary record and is available only through API access. |
| AccountName | String | Specifies the name of the account that is associated with the send operation. |
| AccountEmail | String | Specifies the email address that is associated with the account and that is used for reporting, administrative notices, or message attribution. |
| IsTestAccount | Bool | Returns a value of 'true' when the account is configured as a test account for validation or non-production sending scenarios. It returns a value of 'false' when the account operates as a standard production environment. |
| TotalSent | Int | Indicates the total number of messages that were sent as part of the send operation. |
| Transactional | Int | Indicates the number of transactional messages that were included in the send operation. |
| NonTransactional | Int | Specifies the number of marketing or non-transactional messages that were included as part of the send operation. |
Contains tracking data for email send events in Salesforce Marketing Cloud. Each record captures subscriber-level delivery results, including send time, recipient address, and message identifier (Id). This view supports detailed tracking and reporting of message performance.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SentEvent WHERE Client_ID = 123 SELECT * FROM SentEvent WHERE Client_ID IN (123, 456) SELECT * FROM SentEvent WHERE EventDate > '2024/01/25'
| Name | Type | Description |
| SendID | Int | Specifies the unique identifier (Id) for the specific send operation that generated the sent event record. This Id enables reporting systems to associate the event with the correct outbound message. |
| SubscriberKey | String | Specifies the subscriber key that identifies the individual subscriber for whom the sent event was recorded. This value is used to correlate the event with subscriber-level activity. |
| EventDate | Datetime | Indicates the date and time when the sent event occurred as part of tracking and delivery reporting. |
| Client_ID | Int | Specifies the Id of the client that owns or administers the send and its associated event data. |
| EventType | String | Specifies the type of tracking event that is associated with the send, such as a system-generated representation of a successful send action. |
| BatchID | Int | Specifies the Id of the batch that groups related triggered send events for collective reporting and processing. |
| TriggeredSendDefinitionObjectID | String | Specifies the system-controlled Id that is associated with the triggered send definition used to generate the event. |
| ListID | Int | Specifies the Id of the subscriber list to which the subscriber belongs at the time of the send operation. |
| PartnerKey | String | Specifies the partner-assigned unique Id that is associated with the event record and available only through API access. |
| SubscriberID | Int | Specifies the Id of the subscriber that is associated with the sent event. |
Contains information about outbound (mobile-terminated) Short Message Service (SMS) messages that were are to subscribers in Salesforce Marketing Cloud. Each record includes message identifiers (Ids), timestamps, and delivery results for mobile messaging analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled text string that serves as the unique identifier (Id) for the event record that is generated when a Short Message Service (SMS) message is delivered to a mobile device as part of a mobile-terminated (MT) interaction. This Id ensures that the platform can reliably reference and track the event. |
| EventDate | Datetime | Indicates the date and time when the mobile-terminated SMS tracking event occurred. |
| Client_ID | Long | Specifies the Id of the client that owns or administers the SMS configuration associated with this event. |
| MOCode | String | Specifies the mobile-originated (MO) code that is associated with the MO or MT tracking event. This value identifies the keyword or short code path that triggered the interaction. |
| SMSTriggeredSend_SMSSendId | String | Specifies the Id of the specific SMS send operation that is associated with the triggered send event. |
| SMSTriggeredSend_SMSTriggeredSendDefinition_ObjectID | String | Specifies the system-controlled text string identifier that is associated with the triggered send definition used for this SMS event. |
| SMSTriggeredSend_SMSTriggeredSendDefinition_CustomerKey | String | Specifies the user-supplied unique identifier for the triggered send definition that governs how the SMS message was generated and delivered. |
| Subscriber_ID | Int | Specifies the Id of the subscriber for whom the SMS tracking event was recorded. |
| Subscriber_SubscriberKey | String | Specifies the subscriber key that identifies the individual subscriber associated with the SMS event. |
| Subscriber_PrimarySMSAddress_Address | String | Specifies the primary SMS address that is associated with the subscriber's profile and used for message delivery. |
| Carrier | String | Specifies the mobile carrier that is associated with the subscriber's SMS address and used to route the message through the appropriate network. |
Defines Short Message Service (SMS) triggered send definitions in Salesforce Marketing Cloud. Each definition includes message templates, target audiences, and sending parameters. This view supports auditing and configuration validation for automated SMS workflows.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled, read-only text string that serves as the unique identifier (Id) for the Short Message Service (SMS) triggered-send definition. This Id is generated automatically and is used to reference the definition within the system. |
| CustomerKey | String | Specifies the user-supplied unique Id for the triggered-send definition within its object type. This Id enables consistent identification across API operations and user interface components. |
| Client_ID | Long | Specifies the Id of the client. This Id associates the triggered-send definition with the correct Marketing Cloud account context. |
| Name | String | Specifies the name of the triggered-send definition. This value is displayed in the user interface and is used to distinguish this definition from other definitions. |
| Description | String | Describes and provides detailed information regarding the triggered-send definition. This text helps users understand the purpose, configuration, and functional context of the definition. |
| Publication_ID | Int | Specifies the read-only Id of the publication that is associated with the triggered-send definition. This Id links the definition to the appropriate SMS program or publication list. |
| CreatedDate | Datetime | Indicates the read-only date and time of the object's creation. This timestamp is generated automatically when the triggered-send definition is added to the system. |
| ModifiedDate | Datetime | Indicates the last time the triggered-send definition was modified. This timestamp reflects the most recent administrative or configuration update. |
| Content_ID | Int | Specifies the read-only Id of the content asset that is associated with the triggered-send definition. This Id identifies the SMS message content that is used during the triggered-send process. |
| SendToList | Bool | Returns a value of 'true' when the SMS triggered send is configured to send to a list instead of an individual subscriber. It returns a value of 'false' when the send is directed to a single subscriber rather than a list. |
| DataExtension_ObjectID | String | Specifies the system-controlled, read-only text string that serves as the Id of the data extension used as the target for the triggered send. This Id identifies the data source that supplies subscriber data for the send operation. |
| IsPlatformObject | Bool | Returns a value of 'true' when the triggered-send definition represents a platform-level object that is used across multiple account contexts. It returns a value of 'false' when the object is scoped only to the local business unit or account. |
Retrieves the lists that are associated with a specific subscriber in Salesforce Marketing Cloud. Each record links a subscriber to one or more lists to support segmentation, subscription tracking, and campaign targeting.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberList WHERE Id = 123 SELECT * FROM SubscriberList WHERE Id IN (123, 456) SELECT * FROM SubscriberList WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ListSubID | Long | Specifies the unique identifier (Id) for the subscriber-list association record. This Id identifies the specific linkage between a subscriber and a list. |
| ID [KEY] | Int | Specifies the Id for the list-subscriber record. This Id uniquely identifies the object within the Marketing Cloud environment. |
| PartnerKey | String | Specifies the partner-supplied key that is associated with the object as part of an external integration. This key is accessible only through the API. |
| CreatedDate | Datetime | Specifies the date and time when the list-subscriber record was created. This value is read only and is set automatically by the system. |
| Subscriber_UnsubscribedDate | Datetime | Specifies the date and time when the subscriber unsubscribed from the associated list. This value allows downstream processes to evaluate historical opt-out activity. |
| Client_ID | Int | Specifies the Id of the client account that owns the list-subscriber record. This Id determines the account context in which the object exists and is managed. |
| Status | String | Specifies the status that is associated with the list-subscriber relationship (for example, Active, Unsubscribed, or Held). This value reflects how the subscriber is treated for future sends. |
| List_ID | Int | Specifies the Id of the list to which the subscriber is associated. This Id identifies the specific list that defines the audience membership. |
| List_ListName | String | Specifies the name of the list that is associated with the subscriber. This value is used for identification, reporting, and user-interface display. |
| Subscriber_Status | String | Specifies the status that is associated with the subscriber within the context of this list. This value can differ from the subscriber's global status. |
| Subscriber_CreatedDate | Datetime | Specifies the date and time when the subscriber record was created in the system. This value provides historical context for segmentation and reporting. |
| Subscriber_ID | Int | Specifies the Id of the subscriber. This Id uniquely identifies the subscriber object within the Salesforce Marketing Cloud account. |
| Subscriber_EmailAddress | String | Specifies the email address that is associated with the subscriber. This address represents the primary communication channel for email sends. |
| Subscriber_SubscriberKey | String | Specifies the subscriber key that uniquely identifies a subscriber across multiple lists, business units, and data sources. This key is required for all send-related operations. |
| Subscriber_PartnerKey | String | Specifies the partner-provided key for the subscriber, which is used for external system correlation. This key is accessible only through the API. |
Provides information about message send outcomes at the individual subscriber level. This view helps identify whether a message was delivered, bounced, deferred, or otherwise processed for each subscriber, enabling detailed send-level analysis and troubleshooting.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SubscriberSendResult WHERE Id = 123 SELECT * FROM SubscriberSendResult WHERE Id IN (123, 456) SELECT * FROM SubscriberSendResult WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Send_ID | Int | Specifies the unique identifier (Id) for the send that is associated with the subscriber's result record. This Id is read only and is managed by the system. |
| ID [KEY] | Int | Specifies the Id for the subscriber send-result record. This Id uniquely identifies the result object within the account and is read only. |
| Email_ID | Int | Specifies the Id of the email message that is associated with the subscriber's send result. This Id allows reporting systems to join send-result data with email-definition data. |
| Email_Name | String | Specifies the name of the email message that is associated with the subscriber's send result. This value provides user-friendly identification for reporting and auditing. |
| Subject | String | Specifies the subject line that is associated with the message that was sent to the subscriber. This value reflects the rendered subject at the time of send. |
| FromName | String | Specifies the 'From Name' value that is associated with the email message. This value reflects the branding that is applied at the time of send. |
| FromAddress | String | Specifies the 'From Address' value that is associated with the email message. This address represents the sending mailbox that is visible to the subscriber. |
| SentDate | Datetime | Specifies the date and time when the email message was sent to the subscriber. This timestamp is generated by the sending engine. |
| OpenDate | Datetime | Specifies the date and time when the subscriber opened the message. This value contributes to open-rate reporting and engagement analysis. |
| ClickDate | Datetime | Specifies the date and time when the subscriber clicked a link within the message. This value contributes to click-through tracking and engagement reporting. |
| Subscriber_Partnerkey | String | Specifies the partner-provided key that is associated with the subscriber for integration and correlation with external systems. This key is accessible only via the API. |
| Subscriber_EmailAddress | String | Specifies the email address of the subscriber who received the message. This address serves as the primary identifier for email delivery. |
| Subscriber_PartnerType | String | Specifies the partner-defined subscriber classification that is used for third-party correlation and integration workflows. |
| UnsubscribeDate | Datetime | Specifies the date and time when the subscriber unsubscribed as a result of the send. This value supports compliance reporting and audience-health analysis. |
| LastOpenDate | Int | Specifies the date the subscriber last opened the message, expressed as an integer timestamp. This value reflects the most recent engagement event. |
| LastClickDate | Int | Specifies the date the subscriber last clicked a link within the message, expressed as an integer timestamp. This value reflects the most recent click-through event. |
| BounceDate | Datetime | Specifies the date and time when the subscriber's email address generated a bounce for this send. This value supports deliverability reporting. |
| EventDate | Int | Specifies the date of the event that is associated with the send result, expressed as an integer timestamp for system processing. |
| TotalClicks | Int | Specifies the total number of clicks that are generated by the subscriber for the message. This value includes repeated clicks on the same link. |
| UniqueClicks | Int | Specifies the number of unique clicks that are performed by the subscriber for the message. This value counts each link only once per subscriber. |
| EmailAddress | Int | Specifies the 'From' address that is associated with the email message. This value is provided as an Id for reporting consistency. |
| Subscriber_ID | Int | Specifies the Id of the subscriber that is associated with the send result. This Id uniquely identifies the subscriber within the account and is read only. |
| SubscriberTypeID | Int | Specifies the Id that represents the subscriber type. This Id classifies subscriber records for system-level processing. |
| Subscriber_SubscriberKey | String | Specifies the subscriber key that uniquely identifies the subscriber across lists, business units, and data sources. |
| Send_PartnerKey | String | Specifies the partner-provided key that is associated with the send. This key is used for external correlation and is accessible only via the API. |
| PartnerKey | String | Specifies the partner-provided key that is associated with the send-result object. This key supports external system mapping and is accessible only via the API. |
| Client_ID | Int | Specifies the Id of the client account that owns the send-result record. This Id determines the account context for processing and reporting. |
| OtherBounces | Int | Specifies the number of bounces that are classified as Other-type bounces for the message. This value reflects bounce categories that do not fall into soft or hard classifications. |
| SoftBounces | Int | Specifies the number of soft bounces that are associated with the send. Soft bounces occur when temporary delivery issues prevent successful delivery. |
| HardBounces | Int | Specifies the number of hard bounces that are associated with the send. Hard bounces occur when permanent delivery issues prevent email acceptance. |
Retrieves information about subscribers, the current subscribers' status and the reasons why the subscribers unsubscribed, if any.
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled text string that serves as the unique identifier (Id) for the subscriber-status event record. This Id is read-only and is generated internally. |
| SubscriberID | Long | Specifies the Id that is assigned to the subscriber within the Salesforce Marketing Cloud account context. This Id is used to link the status event to the corresponding subscriber record. |
| Client_ID | Long | Specifies the Id of the client that owns or manages the subscriber associated with this status event. The system uses this Id to ensure that status tracking aligns to the correct account. |
| CurrentStatus | String | Defines the subscriber status that is currently active at the time the event was recorded. This value reflects the most recent state (for example, Active, Bounced, or Unsubscribed. |
| PreviousStatus | String | Defines the subscriber status that was in effect immediately prior to the status change represented by this event. This value provides historical context for understanding lifecycle transitions. |
| CreatedDate | Datetime | Indicates the date and time when the subscriber-status event was created within the system. This value establishes the chronological sequence of the subscriber's status changes. |
| SubscriberKey | String | Specifies the subscriber key that uniquely identifies the subscriber across lists, sends, and data extensions. This value is used for tracking, segmentation, and auditing. |
| ReasonUnsub | String | Specifies the explanation that describes why the subscriber unsubscribed from a list or communication source. This value can represent a system-detected reason or a subscriber-provided reason. |
Defines the context within which a suppression list can be associated in Salesforce Marketing Cloud. Each context determines the scope of a suppression list, such as a specific business unit, publication, or message type.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SuppressionListContext WHERE Id = 123 SELECT * FROM SuppressionListContext WHERE Id IN (123, 456) SELECT * FROM SuppressionListContext WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled text string that serves as the unique identifier (Id) for the suppression-list context record. This Id is read-only and is generated internally. |
| Definition_ObjectID | String | Specifies the system-controlled text string that serves as the Id of the suppression-list definition that is associated with this context. This Id is read-only and is generated internally. |
| Definition_Name | String | Defines the name that is assigned to the suppression-list definition that is associated with this context. This value helps identify the definition within configuration workflows. |
| Definition_CustomerKey | String | Specifies the user-supplied unique Id for the suppression-list definition that is associated with this context. This value provides an external reference for integration, retrieval, or configuration tasks. |
| Definition_Category | Long | Identifies the folder category in which the suppression-list definition is stored. This value supports organization, access control, and hierarchical navigation. |
| Definition_Description | String | Describes the purpose, scope, or functional details of the suppression-list definition that is associated with this context. This description helps users understand how the definition is intended to be used. |
| Context | String | Specifies the context that is assigned to the suppression-list definition, such as its usage scenario or scope of application. This value determines when and where the suppression list is applied. |
| SendClassification_ObjectID | String | Specifies the system-controlled text string that serves as the Id of the send classification that is associated with the suppression-list context. This Id is read-only and is generated internally. |
| Send_ID | Int | Specifies the Id of the send to which this suppression-list context applies. This Id is read-only and is used to link the context to a specific send record. |
| SenderProfile_ObjectID | String | Specifies the system-controlled text string that serves as the Id of the sender profile associated with this suppression-list context. This Id is read-only and is generated internally. |
| SendClassificationType | String | Defines the type of the associated send classification that is used with this suppression-list context. Valid values include 'Operational' and 'Marketing', which determine how the suppression rules are enforced. |
| Client_CreatedBy | Int | Returns the Id of the user who created the suppression-list context record. This Id supports auditing and administrative tracking. |
| CreatedDate | Datetime | Indicates the date and time when the suppression-list context record was created. This value provides chronological tracking for configuration changes. |
| Client_ModifiedBy | Int | Returns the Id of the user who most recently modified the suppression-list context record. This Id supports auditing and administrative oversight. |
| ModifiedDate | Datetime | Indicates the date and time when the suppression-list context record was last modified. This timestamp reflects the most recent update to configuration details. |
| Client_ID | Long | Specifies the Id of the client that owns or manages the suppression-list context. This Id links the context to the correct account. |
| Client_EnterpriseID | Long | Specifies the enterprise-level Id that is associated with the client. |
| AppliesToAllSends | Bool | Returns a value of 'true' when the suppression-list context applies to all transactional and marketing sends for the client. It returns a value of 'false' when the suppression-list context applies only to specific sends or classifications. |
Contains information about survey responses recorded in Salesforce Marketing Cloud. Each record captures the timestamp and context of the response, supporting analysis of audience feedback and engagement.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM SurveyEvent WHERE Id = 123 SELECT * FROM SurveyEvent WHERE Id IN (123, 456) SELECT * FROM SurveyEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID [KEY] | Int | Specifies the system-generated unique identifier (Id) for the survey event. This Id is read-only and is assigned automatically by the system. |
| ObjectID | String | Specifies the system-controlled text string that serves as the unique Id for the survey-event object. This Id is read-only and is generated internally. |
| PartnerKey | String | Specifies the unique partner-assigned Id for the survey event. This value is accessible only through the API and is used for external system correlation. |
| CreatedDate | Datetime | Indicates the date and time when the survey event was created. This timestamp is read-only and is generated automatically. |
| ModifiedDate | Datetime | Indicates the date and time when the survey-event record was last modified. This timestamp supports auditing and administrative review. |
| Client_ID | Int | Specifies the Id of the client that owns or manages the survey event. This Id links the record to the appropriate account. |
| SendID | Int | Specifies the Id of the send that is associated with the survey event. This Id links the event back to the originating message send operation. |
| SubscriberKey | String | Specifies the unique subscriber Id that is associated with the event. This value identifies which subscriber provided the survey response. |
| EventDate | Datetime | Indicates the date and time when the survey event occurred. This timestamp reflects when the subscriber interacted with the survey content. |
| EventType | String | Defines the type of tracking event that is associated with the survey interaction. This value helps categorize the event within reporting. |
| TriggeredSendDefinitionObjectID | String | Specifies the system-controlled Id of the triggered send definition that is associated with the survey event. This Id provides linkage to automation and send configuration. |
| BatchID | Int | Specifies the batch Id that groups the survey event with related send-tracking events. This value supports processing and reporting alignment. |
| Question | String | Specifies the survey question presented to the subscriber as part of the tracked interaction. This value reflects the exact question text. |
| Answer | String | Specifies the answer that the subscriber provided in response to the survey question. This value captures the subscriber's submitted input. |
Represents email templates in Salesforce Marketing Cloud. Each record defines the layout, content placeholders, and associated sender settings that are used to build emails. This view helps ensure standardized formatting and brand alignment across campaigns.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| ObjectID | String | The system-generated text value that uniquely identifies this template object within Salesforce Marketing Cloud. |
| ID [KEY] | Int | The unique identifier (Id) for the record. This value is system-generated and cannot be modified. |
| Client_ID | Int | The Id that identifies the client account that owns or manages this template. |
| TemplateName | String | The name that identifies the template within the Salesforce Marketing Cloud application. This value helps administrators and content builders locate and reuse the template in email creation workflows. |
| LayoutHTML | String | The HTML markup that defines the structural layout, content regions, and visual framework of the template. This value allows designers to control formatting, placement of elements, and rendering behavior across email clients. |
| BackgroundColor | String | The color value that determines the background color applied to the template. This value influences visual branding and readability for the rendered email. |
| BorderColor | String | The color value that determines the border color that surrounds the template or its content regions. This value helps maintain consistent formatting and visual structure. |
| BorderWidth | Int | The numeric value that defines the width, in pixels, of the borders that appear around the template. This value controls how prominently the border is displayed in the final email design. |
| Cellpadding | Int | The numeric value that defines the internal padding, in pixels, within each table cell in the template layout. This value controls spacing between cell edges and content. |
| Cellspacing | Int | The numeric value that defines the spacing, in pixels, between individual table cells within the template layout. This value influences how tightly or loosely the table structure appears. |
| Width | Int | The numeric value that specifies the full pixel width of the template. This value determines how the template renders across various email clients and viewing panes. |
| Align | String | The alignment setting that determines how content within the template is positioned horizontally. This value influences layout presentation when the email is rendered. |
| ActiveFlag | Int | The numeric value that indicates whether the template is available for selection and use within the Salesforce Marketing Cloud account. A value of '1' typically indicates that the template is active. |
| CategoryID | Int | The Id that identifies the content validation category assigned to the email message that uses this template. This value allows systems to track the validation state for compliance and deliverability checks. |
| CategoryType | String | The value that identifies the type of categorization that links related objects across multiple requests. This value supports grouping, auditing, and coordinated processing of template-related operations. |
| OwnerID | Int | The Id that identifies the business unit (also known as the Member Identification value) that created the template within an Enterprise 2.0 account structure. This value supports security and content access controls. |
| HeaderContent_ID | Int | The Id that identifies the header content that is associated with the template. This value links the template to reusable content blocks. |
| HeaderContent_ObjectID | String | The system-generated text value that identifies the object that stores the header content associated with this template. |
| Layout_ID | Int | The Id that identifies the layout configuration that is assigned to the template. This value determines the structural framework used for rendering content. |
| Layout_LayoutName | String | The name of the layout that defines the structural arrangement and formatting rules used by the template. |
| CustomerKey | String | The user-supplied Id that uniquely identifies the template within the object type. This value supports custom integrations, automation, and cross-environment migrations. |
| TemplateSubject | String | The subject line text that the template applies to emails that are created from it. This value provides a default that helps standardize branding and communication patterns. |
| IsTemplateSubjectLocked | Bool | Returns a value of 'true' when the subject defined in the header content cannot be modified by emails that use this template. It returns a value of 'false' when the subject can be changed during email creation. |
Lists supported time zones in Salesforce Marketing Cloud. Each record includes the time zone identifier (Id), offset, and regional description. This view supports configuration of time-based automations and send scheduling.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM TimeZone
| Name | Type | Description |
| ID [KEY] | Int | The unique identifier (Id) for the timezone record. This value is system-generated and uniquely identifies the timezone entry within the schema. |
| Name | String | The descriptive name of the timezone, such as a standard region or offset label. This value helps users and systems reference the appropriate timezone for scheduling, localization, and data processing activities. |
Provides summary metrics for specific triggered send operations in Salesforce Marketing Cloud. Each record includes counts for messages sent, delivered, and failed, supporting operational and performance analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
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'
| Name | Type | Description |
| ObjectID [KEY] | String | Specifies the system-controlled text string that serves as the unique identifier (Id) for the triggered-send summary record. |
| Client_ID | Long | Specifies the Id of the client account that is associated with the triggered-send summary. |
| Client_PartnerClientKey | String | Specifies the partner-provided unique key that is associated with the client account and used only within partner integrations. |
| CustomerKey | String | Specifies the user-supplied unique Id for the triggered-send summary object. |
| PartnerKey | String | Specifies the partner-provided unique Id for the triggered-send summary object and available only through partner integrations. |
| Sent | Long | Indicates the total number of triggered-send messages that were successfully sent. |
| NotSentDueToOptOut | Long | Indicates the number of triggered-send messages that were not delivered because the subscribers opted out of receiving communications. |
| NotSentDueToUndeliverable | Long | Indicates the number of triggered-send messages that were not delivered because the destination addresses were undeliverable. |
| Bounces | Long | Indicates the total number of bounce events that resulted from the triggered send. |
| Opens | Long | Indicates the total number of opens recorded across all messages in the triggered send. |
| UniqueOpens | Long | Indicates the number of distinct subscribers who opened at least one message within the triggered send. |
| Clicks | Long | Indicates the total number of click interactions recorded for the triggered send. |
| UniqueClicks | Long | Indicates the number of distinct subscribers who clicked at least one link within the triggered send. |
| OptOuts | Long | Indicates the number of subscribers who opted out of receiving future messages after receiving the triggered send. |
| SurveyResponses | Long | Indicates the number of responses submitted to any survey questions included in the triggered send. |
| FTAFRequests | Long | Indicates the number of Forward To A Friend (FTAF) request actions that were initiated from within the triggered send. |
| FTAFEmailsSent | Long | Indicates the number of Forward To A Friend (FTAF) emails that were sent as a result of subscriber requests. |
| FTAFOptIns | Long | Indicates the number of subscribers who opted in to future communications as a result of a Forward To A Friend (FTAF) action. |
| Conversions | Long | Indicates the total number of conversions that resulted from the triggered send. |
| UniqueConversions | Long | Indicates the number of distinct subscribers who completed a conversion action that is associated with the triggered send. |
| InProcess | Long | [DEPRECATED] Indicates the number of triggered-send messages that are currently in progress. |
| NotSentDueToError | Long | Indicates the number of triggered-send messages that were not delivered because an error occurred during processing. |
| RowObjectID | String | Specifies the row-level unique Id for the triggered-send summary record. |
| TriggeredSendDefinition_ObjectID | String | Specifies the system-controlled unique Id of the triggered-send definition that is associated with the summarized results. |
| Queued | Long | Indicates the number of triggered-send messages that are queued and awaiting processing. |
Contains data about unsubscription events in Salesforce Marketing Cloud. Each record captures the subscriber, timestamp, and context of the unsubscribe action. This view supports compliance reporting and audience retention analysis.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubEvent WHERE Id = 123 SELECT * FROM UnsubEvent WHERE Id IN (123, 456) SELECT * FROM UnsubEvent WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| ID | Int | Specifies the read-only unique identifier (Id) for the unsubscribe event record. |
| ObjectID | String | Specifies the system-controlled text string that serves as the unique Id for the unsubscribe event object. |
| PartnerKey | String | Specifies the partner-provided unique Id for the unsubscribe event object that is available only through partner integrations. |
| CreatedDate | Datetime | Specifies the read-only date and time when the unsubscribe event record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the unsubscribe event record was last modified. |
| Client_ID | Int | Specifies the Id of the client account that is associated with the unsubscribe event. |
| SendID | Int | Specifies the Id of the send operation that is associated with the unsubscribe event. |
| SubscriberKey | String | Specifies the user-supplied subscriber key that identifies the subscriber who performed the unsubscription. |
| EventDate | Datetime | Specifies the date and time when the unsubscribe tracking event occurred. |
| EventType | String | Specifies the type of tracking event that is associated with the unsubscribe action. |
| TriggeredSendDefinitionObjectID | String | Specifies the system-controlled Id of the triggered-send definition that is associated with the unsubscribe event. |
| BatchID | Int | Specifies the batch Id that ties the unsubscribe event to a related group of triggered-send events. |
| List_ID | Int | Specifies the Id of the list that is associated with the unsubscription action. |
| List_Type | String | Specifies the type of list that is associated with the unsubscription event. Valid values include 'Public', 'Private', 'Salesforce', 'GlobalUnsubscribe', and 'Master'. |
| List_ListClassification | String | Specifies the classification that is applied to the list that is associated with the unsubscription event. |
| IsMasterUnsubscribed | Bool | Indicates whether the subscriber performed a master unsubscribe action. It returns a value of 'false' when the subscriber did not perform a master unsubscribe. |
Defines the keyword that subscribers can use to unsubscribe from a Short Message Service (SMS) publication list in Salesforce Marketing Cloud. This configuration supports opt-out workflows and compliance with mobile communication regulations.
The Cloud 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 Cloud processes other filters client-side within the Cloud.
For example, the following (but not only) queries are processed server side:
SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID = 123 SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE Client_ID IN (123, 456) SELECT * FROM UnsubscribeFromSMSPublicationMOKeyword WHERE CreatedDate > '2017/01/25'
| Name | Type | Description |
| Client_ID | Int | Specifies the identifier (Id) of the client account that is associated with the keyword configuration for mobile-originated (MO) messages in the Short Message Service (SMS) system. |
| CreatedDate | Datetime | Specifies the read-only date and time when the SMS MO keyword configuration record was created. |
| ModifiedDate | Datetime | Indicates the date and time when the SMS MO keyword configuration record was last modified. |
| CustomerKey | String | Specifies the user-supplied unique Id for the SMS MO keyword configuration. |
| NextMOKeyword_CustomerKey | String | Specifies the customer key of the next MO keyword that is used to continue an SMS conversation flow. |
| IsDefaultKeyword | Bool | Indicates whether the account defaults to this SMS keyword action when no other keyword-specific option is available. It returns a value of 'false' when the account does not default to this SMS keyword action. |
| AllUnsubSuccessMessage | String | Contains the message that is sent to the subscriber when they successfully unsubscribe from all SMS publication lists. |
| InvalidPublicationMessage | String | Specifies the message that is sent when a subscriber attempts to subscribe to or unsubscribe from a publication list that does not exist or cannot be identified. |
| SingleUnsubSuccessMessage | String | Contains the message that is sent to the subscriber when they successfully unsubscribe from a single SMS publication list. |
Stored procedures are function-like interfaces that extend the functionality of the Cloud beyond simple SELECT/INSERT/UPDATE/DELETE operations with Salesforce Marketing Cloud.
Stored procedures accept a list of parameters, perform their intended function, and then return any relevant response data from Salesforce Marketing Cloud, along with an indication of whether the procedure succeeded or failed.
| Name | Description |
| CreateTriggeredSend | Creates a triggered send object in Salesforce Marketing Cloud. A triggered send represents a specific instance of an automated email send that is initiated by an API event or system trigger. This procedure allows real-time delivery of personalized messages. |
Creates a triggered send object in Salesforce Marketing Cloud. A triggered send represents a specific instance of an automated email send that is initiated by an API event or system trigger. This procedure allows real-time delivery of personalized messages.
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', '[email protected]')
INSERT INTO Subscribers#TEMP (SubscriberKey, EmailAddress) VALUES ('21621cc5-d12e-46d0-bf09-a429da29ef1a', '[email protected]')
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')
After creating at least one subscriber item, you can execute the stored procedure.
EXECUTE CreateTriggeredSend Owner_ClientId = '7307527', Owner_FromName = 'From_Name', Owner_FromAddress = '[email protected]', TriggeredSendDefinitionCustomerKey = '27775'
| Name | Type | Required | Description |
| TriggeredSendDefinitionCustomerKey | String | True | Specifies the external key that identifies the triggered send definition that is associated with the triggered send operation. This value determines which configured definition the system should use when creating the triggered send object. |
| Owner_ClientId | String | False | Specifies the identifier (Id) of the account that owns the triggered send. This value determines the business unit context in which the triggered send is created and executed. |
| Owner_FromAddress | String | False | Specifies the email address that appears in the 'From' field of the triggered send. This value establishes the sender identity shown to recipients. |
| Owner_FromName | String | False | Specifies the 'From Name' value that is associated with the triggered send. This value provides the display name that accompanies the 'From' address in outbound messages. |
| Name | Type | Description |
| Success | Boolean | Returns a value of 'true' when the triggered send object is created successfully. It returns a value of 'false' when the creation request encounters an error or fails validation. |
You can query the system tables described in this section to access schema information, information on data source functionality, and batch operation statistics.
The following tables return database metadata for Salesforce Marketing Cloud:
The following tables return information about how to connect to and query the data source:
The following table returns query statistics for data modification queries, including batch operations::
Lists the available databases.
The following query retrieves all databases determined by the connection string:
SELECT * FROM sys_catalogs
| Name | Type | Description |
| CatalogName | String | The database name. |
Lists the available schemas.
The following query retrieves all available schemas:
SELECT * FROM sys_schemas
| Name | Type | Description |
| CatalogName | String | The database name. |
| SchemaName | String | The schema name. |
Lists the available tables.
The following query retrieves the available tables and views:
SELECT * FROM sys_tables
| 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. |
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'
| 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. |
| IsReadOnly | Boolean | Whether the column is read-only. |
| IsKey | Boolean | Indicates whether a field returned from sys_tablecolumns is the primary key of the table. |
| ColumnType | String | The role or classification of the column in the schema. Possible values include SYSTEM, LINKEDCOLUMN, NAVIGATIONKEY, REFERENCECOLUMN, and NAVIGATIONPARENTCOLUMN. |
Lists the available stored procedures.
The following query retrieves the available stored procedures:
SELECT * FROM sys_procedures
| Name | Type | Description |
| CatalogName | String | The database containing the stored procedure. |
| SchemaName | String | The schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure. |
| Description | String | A description of the stored procedure. |
| ProcedureType | String | The type of the procedure, such as PROCEDURE or FUNCTION. |
Describes stored procedure parameters.
The following query returns information about all of the input parameters for the SelectEntries stored procedure:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND Direction = 1 OR Direction = 2
To include result set columns in addition to the parameters, set the IncludeResultColumns pseudo column to True:
SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'SelectEntries' AND IncludeResultColumns='True'
| Name | Type | Description |
| CatalogName | String | The name of the database containing the stored procedure. |
| SchemaName | String | The name of the schema containing the stored procedure. |
| ProcedureName | String | The name of the stored procedure containing the parameter. |
| ColumnName | String | The name of the stored procedure parameter. |
| Direction | Int32 | An integer corresponding to the type of the parameter: input (1), input/output (2), or output(4). input/output type parameters can be both input and output parameters. |
| DataType | Int32 | An integer indicating the data type. This value is determined at run time based on the environment. |
| DataTypeName | String | The name of the data type. |
| NumericPrecision | Int32 | The maximum precision for numeric data. The column length in characters for character and date-time data. |
| Length | Int32 | The number of characters allowed for character data. The number of digits allowed for numeric data. |
| NumericScale | Int32 | The number of digits to the right of the decimal point in numeric data. |
| IsNullable | Boolean | Whether the parameter can contain null. |
| IsRequired | Boolean | Whether the parameter is required for execution of the procedure. |
| IsArray | Boolean | Whether the parameter is an array. |
| Description | String | The description of the parameter. |
| Ordinal | Int32 | The index of the parameter. |
| Values | String | The values you can set in this parameter are limited to those shown in this column. Possible values are comma-separated. |
| SupportsStreams | Boolean | Whether the parameter represents a file that you can pass as either a file path or a stream. |
| IsPath | Boolean | Whether the parameter is a target path for a schema creation operation. |
| Default | String | The value used for this parameter when no value is specified. |
| SpecificName | String | A label that, when multiple stored procedures have the same name, uniquely identifies each identically-named stored procedure. If there's only one procedure with a given name, its name is simply reflected here. |
| IsCDataProvided | Boolean | Whether the procedure is added/implemented by CData, as opposed to being a native Salesforce Marketing Cloud procedure. |
| Name | Type | Description |
| IncludeResultColumns | Boolean | Whether the output should include columns from the result set in addition to parameters. Defaults to False. |
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'
| 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. |
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'
| 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. |
Describes the primary keys.
The following query retrieves the primary keys from all tables and views:
SELECT * FROM sys_primarykeys
| 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. |
| KeySeq | String | The sequence number of the primary key. |
| KeyName | String | The name of the primary key. |
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'
| 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. |
Returns information on the available connection properties and those set in the connection string.
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 <> ''
| 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. |
Describes the SELECT query processing that the Cloud can offload to the data source.
See SQL Compliance for SQL syntax details.
Below is an example data set of SQL capabilities. 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 |
| OJ_CAPABILITIES | The supported varieties of outer joins supported. | NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS |
| OUTER_JOINS | Whether outer joins are supported. | YES, NO |
| SUBQUERIES | Whether subqueries are supported, and, if so, the degree of support. | NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED |
| 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 CData Data Sync version needed to access this driver. | Standard, Starter, Professional, Enterprise |
| DATASYNCCATEGORY | The CData 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.
| 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. |
Returns information about attempted modifications.
The following query retrieves the Ids of the modified rows in a batch operation:
SELECT * FROM sys_identity
| 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. |
Describes the available system information.
The following query retrieves all columns:
SELECT * FROM sys_information
| Name | Type | Description |
| Product | String | The name of the product. |
| Version | String | The version number of the product. |
| Datasource | String | The name of the datasource the product connects to. |
| NodeId | String | The unique identifier of the machine where the product is installed. |
| HelpURL | String | The URL to the product's help documentation. |
| License | String | The license information for the product. (If this information is not available, the field may be left blank or marked as 'N/A'.) |
| Location | String | The file path location where the product's library is stored. |
| Environment | String | The version of the environment or rumtine the product is currently running under. |
| DataSyncVersion | String | The tier of CData Sync required to use this connector. |
| DataSyncCategory | String | The category of CData Sync functionality (e.g., Source, Destination). |
The connection string 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 in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Establishing a Connection.
| Property | Description |
| AuthScheme | Specifies the authentication method that provider uses to connect to Salesforce Marketing Cloud. |
| UseLegacyAuthentication | Specifies whether provider uses the legacy REST authentication method when connecting to Salesforce Marketing Cloud. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Subdomain | The subdomain of the Salesforce Marketing Cloud API. |
| UseAsyncBatch | Specifies whether provider uses the asynchronous SOAP API for batch insert, update, or delete operations. |
| WaitForBulkResults | Specifies whether provider waits for bulk results when using the asynchronous API. |
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies a space-separated list of OAuth scopes that provider requests for accessing data in Salesforce Marketing Cloud. |
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Specifies the API schema that provider uses to connect to Salesforce Marketing Cloud. |
| Property | Description |
| AccountId | Specifies the account identifier, or Member ID (MID), of the target business unit. |
| DisplayChildDataExtensions | Specifies whether provider displays data extensions from child accounts. |
| Instance | [DEPRECATED] The instance of the Salesforce Marketing Cloud API used. |
| ListDataExtensions | Specifies whether provider lists data extensions as tables. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Salesforce Marketing Cloud. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryAllAccounts | Specifies whether provider queries event data across all accounts, including the parent and all child accounts. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| TimeZone | Specifies the server time zone as a UTC offset. The value must use the format +/-hh:mm, for example: +00:00. |
This section provides a complete list of the Authentication properties you can configure in the connection string for this provider.
| Property | Description |
| AuthScheme | Specifies the authentication method that provider uses to connect to Salesforce Marketing Cloud. |
| UseLegacyAuthentication | Specifies whether provider uses the legacy REST authentication method when connecting to Salesforce Marketing Cloud. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| Subdomain | The subdomain of the Salesforce Marketing Cloud API. |
| UseAsyncBatch | Specifies whether provider uses the asynchronous SOAP API for batch insert, update, or delete operations. |
| WaitForBulkResults | Specifies whether provider waits for bulk results when using the asynchronous API. |
Specifies the authentication method that provider uses to connect to Salesforce Marketing Cloud.
string
"Basic"
The following values are supported:
Specifies whether provider uses the legacy REST authentication method when connecting to Salesforce Marketing Cloud.
bool
false
Use this property only when connecting to a package that relies on legacy authentication.
When set to true, the connection uses the legacy REST authentication flow required by older Marketing Cloud packages.
When set to false, the connection uses the current authentication flow.
This property is useful when maintaining compatibility with older integrations that have not been updated to the latest REST authentication model.
Specifies the authenticating user's user ID.
string
""
The authenticating server requires both User and Password to validate the user's identity.
Specifies the authenticating user's password.
string
""
The authenticating server requires both User and Password to validate the user's identity.
The subdomain of the Salesforce Marketing Cloud API.
string
""
The subdomain identifies your specific Marketing Cloud environment and is required to construct the correct authentication and API endpoints.
You can obtain the subdomain from your Marketing Cloud package settings:
This property is useful for constructing the correct authentication and API endpoints for your Marketing Cloud environment.
Specifies whether provider uses the asynchronous SOAP API for batch insert, update, or delete operations.
bool
true
When set to true, batch operations requests are sent using the asynchronous SOAP API. The request returns immediately, and Salesforce processes the operation in the background.
When set to false, batch operations are performed using the synchronous SOAP API, and the request waits for the operation to complete.
You can query the LastResultInfo#TEMP table to view information about the jobs and batches created during asynchronous operations.
This property is useful when you want to avoid long-running synchronous operations or need to monitor batch processing separately.
Specifies whether provider waits for bulk results when using the asynchronous API.
bool
false
This property is active only when UseAsyncBatch is set to true.
When set to true, the Cloud waits for asynchronous bulk insert operations to finish. Full status information is returned, including row-level IDs, statuses, and error messages.
When set to false, bulk insert requests return as soon as they are submitted. This results in faster execution, but only limited status information is available.
This property is useful when you need detailed results for asynchronous bulk operations, such as row-level success and error reporting.
This section provides a complete list of the OAuth properties you can configure in the connection string for this provider.
| Property | Description |
| OAuthClientId | Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication. |
| OAuthClientSecret | Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.). |
| Scope | Specifies a space-separated list of OAuth scopes that provider requests for accessing data in Salesforce Marketing Cloud. |
Specifies the client ID (also known as the consumer key) assigned to your custom OAuth application. This ID is required to identify the application to the OAuth authorization server during authentication.
string
""
This property is required in two cases:
(When the driver provides embedded OAuth credentials, this value may already be provided by the Cloud and thus not require manual entry.)
OAuthClientId is generally used alongside other OAuth-related properties such as OAuthClientSecret and OAuthSettingsLocation when configuring an authenticated connection.
OAuthClientId is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can usually find this value in your identity provider’s application registration settings. Look for a field labeled Client ID, Application ID, or Consumer Key.
While the client ID is not considered a confidential value like a client secret, it is still part of your application's identity and should be handled carefully. Avoid exposing it in public repositories or shared configuration files.
For more information on how this property is used when configuring a connection, see Establishing a Connection.
Specifies the client secret assigned to your custom OAuth application. This confidential value is used to authenticate the application to the OAuth authorization server. (Custom OAuth applications only.).
string
""
This property (sometimes called the application secret or consumer secret) is required when using a custom OAuth application in any flow that requires secure client authentication, such as web-based OAuth, service-based connections, or certificate-based authorization flows. It is not required when using an embedded OAuth application.
The client secret is used during the token exchange step of the OAuth flow, when the driver requests an access token from the authorization server. If this value is missing or incorrect, authentication fails with either an invalid_client or an unauthorized_client error.
OAuthClientSecret is one of the key connection parameters that need to be set before users can authenticate via OAuth. You can obtain this value from your identity provider when registering the OAuth application.
Notes:
For more information on how this property is used when configuring a connection, see Establishing a Connection
Specifies a space-separated list of OAuth scopes that provider requests for accessing data in Salesforce Marketing Cloud.
string
""
Set this property to request specific OAuth scopes during authentication. The value must be a space-separated list of supported permissions.
When this property is not set, the issued token includes the default scopes assigned to the API integration in Installed Packages.
This property is useful when you need to request additional permissions beyond those configured in the installed package or tailor the access level for specific operations.
This section provides a complete list of the SSL properties you can configure in the connection string for this provider.
| Property | Description |
| SSLServerCert | Specifies the certificate to be accepted from the server when connecting using TLS/SSL. |
Specifies the certificate to be accepted from the server when connecting using TLS/SSL.
string
""
If you are using a TLS/SSL connection, use this property to specify the TLS/SSL certificate to be accepted from the server. If you specify a value for this property, all other certificates that are not trusted by the machine are 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 |
Note: It is possible to use '*' to signify that all certificates should be accepted, but due to security concerns this is not recommended.
This section provides a complete list of the Logging properties you can configure in the connection string for this provider.
| Property | Description |
| Verbosity | Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5. |
Specifies the verbosity level of the log file, which controls the amount of detail logged. Supported values range from 1 to 5.
string
"1"
This property defines the level of detail the Cloud includes in the log file. Higher verbosity levels increase the detail of the logged information, but may also result in larger log files and slower performance due to the additional data being captured.
The default verbosity level is 1, which is recommended for regular operation. Higher verbosity levels are primarily intended for debugging purposes. For more information on each level, refer to Logging.
When combined with the LogModules property, Verbosity can refine logging to specific categories of information.
This section provides a complete list of the Schema properties you can configure in the connection string for this provider.
| Property | Description |
| BrowsableSchemas | Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC . |
| Schema | Specifies the API schema that provider uses to connect to Salesforce Marketing Cloud. |
Optional setting that restricts the schemas reported to a subset of all available schemas. For example, BrowsableSchemas=SchemaA,SchemaB,SchemaC .
string
""
Listing all available database schemas can take extra time, thus degrading performance. Providing a list of schemas in the connection string saves time and improves performance.
Specifies the API schema that provider uses to connect to Salesforce Marketing Cloud.
string
"SOAP"
Use this property when you need to choose between REST and SOAP endpoints based on the operations your integration requires.
The following values are supported:
This section provides a complete list of the Miscellaneous properties you can configure in the connection string for this provider.
| Property | Description |
| AccountId | Specifies the account identifier, or Member ID (MID), of the target business unit. |
| DisplayChildDataExtensions | Specifies whether provider displays data extensions from child accounts. |
| Instance | [DEPRECATED] The instance of the Salesforce Marketing Cloud API used. |
| ListDataExtensions | Specifies whether provider lists data extensions as tables. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Pagesize | Specifies the maximum number of records per page the provider returns when requesting data from Salesforce Marketing Cloud. |
| PseudoColumns | Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'. |
| QueryAllAccounts | Specifies whether provider queries event data across all accounts, including the parent and all child accounts. |
| ThrowsKeyNotFound | Specifies whether or not throws an exception if there is no rows updated. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| TimeZone | Specifies the server time zone as a UTC offset. The value must use the format +/-hh:mm, for example: +00:00. |
Specifies the account identifier, or Member ID (MID), of the target business unit.
string
""
Set this property to switch the OAuth context to a specific business unit. When a value is provided, the specified AccountId is used only during the OAuth flow.
When this property is not set, the returned access token is created in the context of the business unit that created the integration.
This property is not supported for legacy packages.
Specifies whether provider displays data extensions from child accounts.
bool
false
When set to true, child-account data extensions are included in the list of available objects.
When set to false, only parent and shared data extensions are displayed.
This property is useful when you need to query or browse data extensions that belong to linked child accounts.
Note: Support for stack-specific endpoints has been removed.
[DEPRECATED] The instance of the Salesforce Marketing Cloud API used.
string
"s7"
The Salesforce Marketing Cloud instance used by default is s7. To determine your instance, follow the steps below:
Specifies whether provider lists data extensions as tables.
bool
true
When set to true, data extensions are included as tables in the available objects.
When set to false, data extensions are not listed as tables.
This property is useful when you want to control whether data extensions appear in schema browsing and metadata operations.
Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY.
int
-1
The default value for this property, -1, means that no row limit is enforced unless the query explicitly includes a LIMIT clause. (When a query includes a LIMIT clause, the value specified in the query takes precedence over the MaxRows setting.)
Setting MaxRows to a whole number greater than 0 ensures that queries do not return excessively large result sets by default.
This property is useful for optimizing performance and preventing excessive resource consumption when executing queries that could otherwise return very large datasets.
Specifies the maximum number of records per page the provider returns when requesting data from Salesforce Marketing Cloud.
int
-1
When processing a query, instead of requesting all of the queried data at once from Salesforce Marketing Cloud, the Cloud can request the queried data in pieces called pages.
This connection property determines the maximum number of results that the Cloud requests per page.
Note: Setting large page sizes may improve overall query execution time, but doing so causes the Cloud to use more memory when executing queries and risks triggering a timeout.
Specifies the pseudocolumns to expose as table columns, expressed as a string in the format 'TableName=ColumnName;TableName=ColumnName'.
string
""
This property allows you to define which pseudocolumns the Cloud exposes as table columns.
To specify individual pseudocolumns, use the following format:
Table1=Column1;Table1=Column2;Table2=Column3
To include all pseudocolumns for all tables use:
*=*
Specifies whether provider queries event data across all accounts, including the parent and all child accounts.
bool
false
This property is available only when using the SOAP schema.
When set to true, queries return event data from the parent account and all child accounts.
When set to false, queries are limited to the current account.
This property is useful when you need a consolidated view of event data across an entire Marketing Cloud account hierarchy.
Specifies whether or not throws an exception if there is no rows updated.
bool
false
Specifies whether or not throws an exception if there is no rows updated.
Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error.
int
60
The timeout applies to each individual communication with the server rather than the entire query or operation. For example, a query could continue running beyond 60 seconds if each paging call completes within the timeout limit.
Timeout is set to 60 seconds by default. To disable timeouts, set this property to 0.
Disabling the timeout allows operations to run indefinitely until they succeed or fail due to other conditions such as server-side timeouts, network interruptions, or resource limits on the server.
Note: Use this property cautiously to avoid long-running operations that could degrade performance or result in unresponsive behavior.
Specifies the server time zone as a UTC offset. The value must use the format +/-hh:mm, for example: +00:00.
string
"-06:00"
Set this property to the time zone that Cloud should use when interpreting or formatting date and time values.
If your Marketing Cloud representative has disabled the Incoming Date Normalization feature, set this property to the account time zone instead of the server time zone.
This property is useful when you need consistent time handling across environments or when date normalization settings differ for your account.
LZMA from 7Zip LZMA SDK
LZMA SDK is placed in the public domain.
Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.
LZMA2 from XZ SDK
Version 1.9 and older are in the public domain.
Xamarin.Forms
Xamarin SDK
The MIT License (MIT)
Copyright (c) .NET Foundation Contributors
All rights reserved.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
NSIS 3.10
Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.
1. DEFINITIONS
"Contribution" means:
a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:
i) changes to the Program, and
ii) additions to the Program;
where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.
"Contributor" means any person or entity that distributes the Program.
"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.
"Program" means the Contributions distributed in accordance with this Agreement.
"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.
2. GRANT OF RIGHTS
a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.
b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.
c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.
d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.
3. REQUIREMENTS
A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:
a) it complies with the terms and conditions of this Agreement; and
b) its license agreement:
i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;
ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;
iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and
iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.
When the Program is made available in source code form:
a) it must be made available under this Agreement; and
b) a copy of this Agreement must be included with each copy of the Program.
Contributors may not remove or alter any copyright notices contained within the Program.
Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.
4. COMMERCIAL DISTRIBUTION
Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.
For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.
5. NO WARRANTY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.
6. DISCLAIMER OF LIABILITY
EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
7. GENERAL
If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.
If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.
All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.
Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.
This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.