Stored Procedures
Stored procedures are function-like interfaces that extend the functionality of the connector 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.
CData Python Connector for Salesforce Marketing Cloud Stored Procedures
| 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. |
| GetOAuthAccessToken | Gets an authentication token from SalesforceMarketingCloud. |
| GetOAuthAuthorizationURL | Gets the authorization URL that must be opened separately by the user to grant access to your application. Only needed when developing Web apps. |
| GetRefreshListStatus | Retrieves the 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. |
| RefreshOAuthAccessToken | Refreshes the OAuth access token used for authentication with SalesforceMarketingCloud. |
| 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. |