Salesforce Marketing Cloud Component
Manage assets, contacts, journeys, campaigns, transactional messaging, data extensions, automations, and event notifications in Salesforce Marketing Cloud.
Component key: salesforce-marketing-cloud
Description
Salesforce Marketing Cloud is a digital marketing platform for managing customer journeys, email campaigns, SMS messaging, and marketing automation. This component enables integration with the Marketing Cloud REST API for managing assets, contacts, journeys, campaigns, transactional messaging, data extensions, automations, and event notifications.
API Documentation
This component was built using the Salesforce Marketing Cloud REST API Documentation
Connections
OAuth 2.0
key: sfmcOAuth2AuthorizationCodeThis connection uses the OAuth 2.0 Authorization Code flow to authenticate with Salesforce Marketing Cloud. It is designed for user-context integrations and supports refresh tokens for persistent access.
Prerequisites
- In Marketing Cloud, navigate to Setup > Apps > Installed Packages
- Create a new package or select an existing one
- Add an API Integration component with the Web App integration type
- Note the Client ID, Client Secret, and the Subdomain
Configure the Connection
Create a connection of type OAuth 2.0 and enter:
| Field | Description |
|---|---|
| Subdomain | The Marketing Cloud subdomain (28-character string starting with 'mc'). Found in the API Integration component details. |
| Client ID | The Client ID from the installed package's API Integration component. |
| Client Secret | The Client Secret from the installed package's API Integration component. |
| Scopes | Space-separated OAuth scopes. Include offline to enable persistent refresh tokens. |
| Input | Notes | Example |
|---|---|---|
| Authorize URL | The OAuth 2.0 Authorization URL for Marketing Cloud. | https://{{#subdomain}}.auth.marketingcloudapis.com/v2/authorize |
| Client ID | Client ID from Setup > Apps > Installed Packages > API Integration component. | |
| Client Secret | Client Secret from Setup > Apps > Installed Packages > API Integration component. | |
| Scopes | Space-separated OAuth 2.0 permission scopes. Include 'offline' to enable persistent refresh tokens. Remove scopes for features you do not use. | offline journeys_read data_extensions_read data_extensions_write email_read email_send |
| Subdomain | The Marketing Cloud subdomain (28-character string starting with 'mc'). Found in Setup > Apps > Installed Packages > API Integration component. | mc563885gzs27c5t9-63k636ttgm |
| Token URL | The OAuth 2.0 Token URL for Marketing Cloud. | https://{{#subdomain}}.auth.marketingcloudapis.com/v2/token |
OAuth 2.0 Client Credentials
key: sfmcOAuth2ClientCredentialsThis connection uses the OAuth 2.0 Client Credentials flow for server-to-server integrations with Salesforce Marketing Cloud. No user interaction is required.
Prerequisites
- In Marketing Cloud, navigate to Setup > Apps > Installed Packages
- Create a new package or select an existing one
- Add an API Integration component with the Server-to-Server integration type
- Note the Client ID, Client Secret, and the Subdomain
Configure the Connection
Create a connection of type OAuth 2.0 Client Credentials and enter:
| Field | Description |
|---|---|
| Subdomain | The Marketing Cloud subdomain (28-character string starting with 'mc'). Found in the API Integration component details. |
| Client ID | The Client ID from the installed package's API Integration component. |
| Client Secret | The Client Secret from the installed package's API Integration component. |
| Scopes | Space-separated OAuth scopes. Maximum 125 characters. |
| Input | Notes | Example |
|---|---|---|
| Client ID | Client ID from Setup > Apps > Installed Packages > API Integration component. | |
| Client Secret | Client Secret from Setup > Apps > Installed Packages > API Integration component. | |
| Scopes | Space-separated OAuth 2.0 permission scopes. Remove scopes for features you do not use. | journeys_read data_extensions_read data_extensions_write email_read email_send |
| Subdomain | The Marketing Cloud subdomain (28-character string starting with 'mc'). Found in Setup > Apps > Installed Packages > API Integration component. | mc563885gzs27c5t9-63k636ttgm |
| Token URL | The OAuth 2.0 Token URL for Marketing Cloud. | https://{{#subdomain}}.auth.marketingcloudapis.com/v2/token |
Triggers
ENS Webhook
Receive event notifications from Salesforce Marketing Cloud Event Notification Service (ENS). Requires manual setup of ENS callback and subscription using the provided actions. | key: ensWebhook
| Input | Notes | Example |
|---|---|---|
| Signature Key | The base64-encoded signature key provided when creating the ENS callback. Copy this value exactly as returned by Salesforce. Used to validate webhook signatures for security. | SmWButn7JlKSZghyaKgNSc8OQy6V3U9L8I2g8lqsWFs= |
Salesforce Marketing Cloud Event Notification Service (ENS) delivers real-time event notifications for transactional email, SMS, and engagement activities. ENS sends event batches as HTTP POST requests to registered callback endpoints.
Before events are delivered, a callback endpoint must be registered and verified using the Create ENS Callback and Verify ENS Callback actions. Subscriptions are then created to specify which event categories the callback should receive.
How It Works
- Register a callback endpoint using the Create ENS Callback action, providing the flow's webhook URL.
- When ENS sends the verification request to your webhook URL, this trigger automatically captures the verification key.
- Use the Verify ENS Callback action with the verification key returned by this trigger to complete verification.
- Create one or more event subscriptions using the Create ENS Subscription action, selecting the event categories to monitor.
- ENS sends event batches as POST requests to the registered callback URL when matching events occur.
This trigger:
- Automatically handles ENS verification requests by capturing and returning the verification key
- Validates HMAC-SHA256 signatures on incoming events when a signature key is provided
- Extracts and returns event payloads for downstream processing
Configuration
Configure the following inputs:
- Signature Key (optional): The signature key provided when creating the ENS callback. Used to validate webhook signatures for enhanced security. If not provided, signature validation is skipped.
Event Types
Transactional Email Events
| Event | Description |
|---|---|
TransactionalSendEvents.EmailSent | A transactional email was successfully sent |
TransactionalSendEvents.EmailNotSent | A transactional email failed to send |
TransactionalSendEvents.EmailBounced | A transactional email bounced |
Engagement Events
| Event | Description |
|---|---|
EngagementEvents.EmailOpen | A recipient opened an email |
EngagementEvents.EmailClick | A recipient clicked a link in an email |
EngagementEvents.EmailUnsubscribe | A recipient unsubscribed from an email |
Transactional SMS Events
| Event | Description |
|---|---|
TransactionalSendEvents.SmsSent | A transactional SMS was successfully sent |
TransactionalSendEvents.SmsNotSent | A transactional SMS failed to send |
TransactionalSendEvents.SmsTransient | A transactional SMS is in a transient delivery state |
TransactionalSendEvents.SmsDelivered | A transactional SMS was delivered to the recipient |
TransactionalSendEvents.SmsBounced | A transactional SMS bounced |
Automation Events
| Event | Description |
|---|---|
SendEvents.AutomationInstanceStarted | An automation instance started running |
SendEvents.AutomationInstanceCompleted | An automation instance completed successfully |
SendEvents.AutomationInstanceStopped | An automation instance was stopped |
SendEvents.AutomationInstanceErrored | An automation instance encountered an error |
SendEvents.AutomationInstanceSkipped | An automation instance was skipped |
Refer to the ENS documentation for the complete and up-to-date list of supported event categories.
Returned Data
The trigger extracts the event payload from the incoming request body. ENS delivers events in batches, so the payload typically contains an array of event objects.
Example Payload
[
{
"eventCategoryType": "TransactionalSendEvents.EmailSent",
"timestampUTC": "2024-02-01T15:30:00.000Z",
"definitionKey": "welcome-email-def",
"requestId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"compositeId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890.1",
"info": {
"messageKey": "d4e5f6a7-b8c9-0123-defa-345678901234",
"contactKey": "subscriber-001",
"to": "john.doe@example.com",
"statusCode": 200,
"statusMessage": "OK"
}
},
{
"eventCategoryType": "TransactionalSendEvents.EmailBounced",
"timestampUTC": "2024-02-01T15:31:00.000Z",
"definitionKey": "welcome-email-def",
"requestId": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
"compositeId": "b2c3d4e5-f6a7-8901-bcde-f12345678901.1",
"info": {
"messageKey": "e5f6a7b8-c9d0-1234-efab-456789012345",
"contactKey": "subscriber-002",
"to": "jane.smith@example.com",
"statusCode": 550,
"statusMessage": "Mailbox not found",
"bounceCode": "1",
"bounceMessage": "Address does not exist"
}
}
]
Notes
- Verification Process: When a callback is first created, ENS sends a verification request containing a
callbackIdandverificationKeyin the request body. This trigger automatically captures and returns these values for use with the Verify ENS Callback action. - Signature Validation: ENS event payloads include an HMAC-SHA256 signature in the
X-SFMC-ENS-SignatureorX-SFMC-HMAC-SHA256header. When you provide the signature key (returned during callback creation), this trigger automatically validates the signature to ensure events originate from Salesforce Marketing Cloud. - Batch Delivery: Events are delivered in batches. The maxBatchSize parameter configured during callback registration controls the maximum number of events per delivery.
- Retry Policy: If event delivery fails, ENS retries delivery according to its built-in retry policy. Refer to the ENS documentation for retry behavior details.
- No Lifecycle Support: This trigger does not support automatic webhook lifecycle management because ENS requires a two-step verification process where the verification key is sent asynchronously to the callback URL. The webhook must be running and accessible to receive and respond to the verification request.
Data Sources
Select Asset
Select a Content Builder asset from a dropdown menu. | key: selectAsset | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Test",
"key": "151239"
},
{
"label": "Welcome Email Template",
"key": "263847"
}
]
}
Select Automation
Select an automation from a dropdown menu. | key: selectAutomation | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Daily Data Sync",
"key": "6b6ec44f-aaf1-4d3d-9f05-074a0328a9ee"
},
{
"label": "Weekly Report Export",
"key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]
}
Select Campaign
Select a campaign from a dropdown menu. | key: selectCampaign | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "New campaign",
"key": "145"
},
{
"label": "Summer Sale",
"key": "267"
}
]
}
Select Category
Select a Content Builder category (folder) from a dropdown menu. | key: selectCategory | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Content Builder",
"key": "54975"
},
{
"label": "Marketing Emails",
"key": "337349"
}
]
}
Select Data Extension
Select a data extension from a dropdown menu. | key: selectDataExtension | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Contact_Salesforce",
"key": "36e73253-16a9-ee11-ac6c-0abc489251b9"
},
{
"label": "Email_Subscribers",
"key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]
}
Select Email Definition
Select a transactional email definition from a dropdown menu. | key: selectEmailDefinition | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Welcome Email",
"key": "welcome-email-def"
},
{
"label": "Order Confirmation",
"key": "order-confirmation-def"
}
]
}
Select ENS Callback
Select an Event Notification Service callback from a dropdown menu. | key: selectCallback | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Example Callback",
"key": "14e2ee5b-8c01-4f9d-916d-29e329945619"
},
{
"label": "Production Webhook",
"key": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d"
}
]
}
Select ENS Subscription
Select an Event Notification Service subscription from a dropdown menu. | key: selectSubscription | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Email Events Subscription",
"key": "6807835e-a82f-498e-a0b9-55d6bde4814d"
},
{
"label": "SMS Events Subscription",
"key": "d89c87c4-70f8-43d6-be1e-f01dce97fe4c"
}
]
}
Select Journey
Select a journey (interaction) from a dropdown menu. | key: selectJourney | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Welcome Series",
"key": "69dd5e94-d963-4508-861b-8f818d6da93a"
},
{
"label": "Re-engagement Campaign",
"key": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"
}
]
}
Select SMS Definition
Select a transactional SMS definition from a dropdown menu. | key: selectSmsDefinition | type: picklist
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"result": [
{
"label": "Order Confirmation SMS",
"key": "order-confirmation-sms"
},
{
"label": "Verification Code",
"key": "verification-code-sms"
}
]
}
Actions
Async Upsert Data Extension Rows
Asynchronously insert or update multiple rows in a data extension. | key: asyncUpsertRows
| Input | Notes | Example |
|---|---|---|
| Batch Rows | An array of row objects to upsert asynchronously. Each object's keys should match data extension column names. | |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Data Extension Key | The external key (customer key) of the data extension. Found in the data extension properties. | my-data-extension-key |
{
"data": {
"requestId": "3ba0103a-fd9b-438a-8568-88c5720d77f4",
"resultMessages": []
}
}
Create Asset
Create a new Content Builder asset. | key: createAsset
| Input | Notes | Example |
|---|---|---|
| Content | The HTML or text content of the asset. | |
| Asset Description | Optional description providing details about the asset's purpose and usage. | HTML email template for new subscriber welcome series |
| Extra Body | Additional properties to include in the asset creation or update request. | |
| Asset Name | The display name shown for the asset in Content Builder. | Welcome Email Template |
| Asset Type ID | The numeric asset type identifier (e.g., 208 for HTML email, 196 for text-only email). | 208 |
| Category ID | The ID of the Content Builder folder/category for the asset. | 98765 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": 151239,
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"objectID": "087946b9-6c2a-4862-85e8-98c4f53b923e",
"contentType": "application/vnd.etmc.email.Message; kind=textOnly",
"assetType": {
"id": 209,
"name": "textonlyemail",
"displayName": "Text Only Email"
},
"name": "Test",
"description": "",
"owner": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"createdDate": "2026-02-16T16:46:01.383-06:00",
"createdBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"modifiedDate": "2026-02-16T16:46:16.753-06:00",
"modifiedBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"enterpriseId": 100012041,
"memberId": 100012041,
"status": {
"id": 1,
"name": "Draft"
},
"thumbnail": {
"thumbnailUrl": "/v1/assets/151239/thumbnail"
},
"category": {
"id": 54975,
"name": "Content Builder",
"parentId": 0
},
"views": {
"subjectline": {
"contentType": "application/vnd.etmc.email.View; kind=subjectline",
"thumbnail": {},
"content": "Subject",
"meta": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"text": {
"thumbnail": {},
"content": "Test",
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"subscriptioncenter": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"forwardText": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
}
},
"availableViews": [
"subjectline",
"text",
"subscriptioncenter",
"forwardText"
],
"data": {
"email": {
"options": {
"characterEncoding": "utf-8"
},
"legacy": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
}
}
},
"legacyData": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
},
"modelVersion": 2
}
}
Create Automation
Create a new automation in Automation Studio. | key: createAutomation
| Input | Notes | Example |
|---|---|---|
| Automation Description | A description of the automation. | Syncs data from external source daily |
| Extra Body | Additional properties to include in the automation request body (e.g., steps, schedule). | |
| Automation Name | The display name for the automation. | Daily Data Sync |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": "6b6ec44f-aaf1-4d3d-9f05-074a0328a9ee",
"name": "Example-Automation-24",
"description": "This automation processes data for analysis and scoring purposes.",
"key": "example-automation-24",
"typeId": 1,
"type": "scheduled",
"statusId": 6,
"status": "Scheduled",
"categoryId": 305349,
"lastRunTime": "2026-02-16T21:14:03.26",
"lastRunInstanceId": "684531f1-a97b-42bd-b252-ffbeb1c633ab",
"schedule": {
"id": "ef2a92b6-28d2-4fae-a2ee-c750154116fe",
"typeId": 2,
"startDate": "2022-11-22T21:14:08.603",
"endDate": "2052-11-20T21:14:08",
"scheduledTime": "2026-02-17T21:14:00",
"rangeTypeId": 0,
"occurrences": 10957,
"pattern": "<Pattern><PatternType>0</PatternType><HourInterval>24</HourInterval></Pattern>",
"icalRecur": "FREQ=HOURLY;COUNT=10957;INTERVAL=24",
"timezoneName": "Central Standard Time (no DST)",
"scheduleStatus": "active",
"timezoneId": 1
},
"steps": [
{
"id": "9e3db705-cd20-42f1-8b57-4955198e2a4f",
"name": "Automation Task for DFU ELT Activities",
"description": "Auto generated step task",
"step": 1,
"activities": [
{
"id": "5826c92e-6a12-410e-b9dc-b90379d20809",
"name": "Extract-Upload Example_Predictive_Scores into S3",
"activityObjectId": "53963411-9619-41a8-a958-d33b785f6a89",
"objectTypeId": 425,
"displayOrder": 1
},
{
"id": "879cf9f8-3810-4467-801a-f4a5b2bb6793",
"name": "Extract-Upload Example_DataExtension into S3",
"activityObjectId": "21e6bf87-f552-43ff-ac1e-88e58cf8a72f",
"objectTypeId": 425,
"displayOrder": 2
}
]
}
]
}
}
Create Campaign
Create a new campaign in Marketing Cloud. | key: createCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign Code | An optional campaign code for tracking. | SUMMER2024 |
| Color | The display color for the campaign in the Marketing Cloud UI (hex format). | #FF5733 |
| Campaign Description | Optional description providing details about the campaign's purpose and content. | Promotional campaign for summer sale event |
| Extra Body | Additional properties to include in the campaign request body. | |
| Campaign Name | The display name for the campaign shown in Marketing Cloud. | Summer Sale 2024 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"createdDate": "2026-02-13T18:52:46",
"modifiedDate": "2026-02-16T22:11:05",
"id": "145",
"name": "Example Marketing Campaign",
"description": "Example campaign for product launch",
"campaignCode": "EXAMPLE2024",
"color": "ffc7c7",
"favorite": false
}
}
Create Category
Create a new Content Builder category (folder). | key: createCategory
| Input | Notes | Example |
|---|---|---|
| Category Name | The display name for the Content Builder folder/category. | Email Templates |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Parent Category ID | The ID of the parent category. Omit to create a top-level category. | 12345 |
{
"data": {
"id": 337349,
"description": "",
"enterpriseId": 100012041,
"memberId": 100012041,
"name": "Example Category",
"parentId": 54975,
"categoryType": "asset"
}
}
Create Contact
Create a new contact in Marketing Cloud. | key: createContact
| Input | Notes | Example |
|---|---|---|
| Attribute Sets | An array of attribute set objects containing contact data to create or update. | |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Key | The unique identifier (subscriber key) for the contact in Marketing Cloud. | contact-abc-123 |
{
"data": {
"contactID": 123456790,
"contactKey": "subscriber-002",
"contactStatus": "active",
"isNewContactKey": true,
"modifiedDate": "2024-02-01T10:30:00.000Z"
}
}
Create Data Extension
Create a new data extension with the specified fields and configuration. | key: createDataExtension
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fields | An array of field definitions for the data extension. Each field must include name and fieldType. | |
| Data Extension Key | A unique external key for the data extension. Used to reference it in API calls. | my-data-extension-key |
| Data Extension Name | The display name for the data extension. | Customer_Data |
| Is Sendable | Whether this data extension can be used as a sendable data source for email sends. | false |
{
"data": {
"id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"name": "Customer_Data",
"key": "customer-data-key",
"description": "",
"isActive": true,
"isSendable": false,
"isTestable": true,
"fieldCount": 3
}
}
Create Email Definition
Create a new transactional email send definition. | key: createEmailDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Content Customer Key | The customer key of the Content Builder asset to use as email content. | my-email-asset-key |
| Definition Description | A description of the transactional email definition. | Sends a welcome email to new subscribers |
| Extra Body | Additional properties to include in the email definition creation request. | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
| Definition Name | The display name for the transactional email definition. | Welcome Email |
{
"data": {
"requestId": "c537a3f4-ea8c-40b3-81bb-41a91666c82a",
"name": "Example Email Definition",
"definitionKey": "welcome-email-def",
"definitionId": "856cf449-8f0b-f111-a5c3-48df37deb009",
"description": "Example transactional email definition",
"classification": "Default Transactional",
"status": "New",
"createdDate": "2026-02-16T17:29:00",
"modifiedDate": "2026-02-16T17:29:00",
"content": {
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739"
},
"subscriptions": {
"list": "All Subscribers - Example",
"autoAddSubscriber": true,
"updateSubscriber": true
},
"options": {
"trackLinks": true,
"isReconcilable": false
},
"journey": {}
}
}
Create ENS Callback
Register a new Event Notification Service (ENS) callback endpoint. | key: createCallback
| Input | Notes | Example |
|---|---|---|
| Callback Name | A descriptive name for the ENS callback endpoint registration. | My Integration Webhook |
| Callback URL | The URL where Marketing Cloud will send event notifications. | https://hooks.example.com/sfmc/events |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Max Batch Size | The maximum number of events to include in a single callback batch (1-100). Defaults to 100. | 100 |
{
"data": [
{
"callbackName": "Example Callback 1",
"callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
"url": "https://example.com/",
"signatureKey": "V27FXfqI3DnhfQW1bhFDeJixpt8eDAY5R24UJI3cK6M=",
"maxBatchSize": 1000
}
]
}
Create ENS Subscription
Create a new Event Notification Service (ENS) subscription for specific event types. | key: createSubscription
| Input | Notes | Example |
|---|---|---|
| Callback ID | The unique identifier of the ENS callback registration. | cb-12345-abcde |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Event Types | The event types to subscribe to. Select one or more Marketing Cloud event categories. | |
| Subscription Name | A descriptive name for the ENS event subscription. | Email Events Subscription |
{
"data": [
{
"callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
"callbackName": "Example Callback 1",
"subscriptionName": "Example Subscription 1",
"eventCategoryTypes": [
"TransactionalSendEvents.EmailNotSent",
"TransactionalSendEvents.EmailSent"
],
"subscriptionId": "d89c87c4-70f8-43d6-be1e-f01dce97fe4c",
"filters": [
"definitionKey=12345"
],
"status": "active"
}
]
}
Create Journey
Create a new journey (interaction) in Marketing Cloud. | key: createJourney
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Journey Description | A description of this journey. | Onboarding journey for new customers |
| Extra Body | Additional properties to include in the request body. | |
| Journey Key | The customer key as a GUID (UUID) to be used while referencing this journey. | journey-welcome-series-2024 |
| Journey Name | The name of this journey. | Welcome Series Journey |
| Workflow API Version | The Journey Spec version to use for this journey. Possible values: 0.5, 1.0. | 1.0 |
{
"data": {
"id": "69dd5e94-d963-4508-861b-8f818d6da93a",
"key": "281ba2ad-c597-4740-54f6-3cc41f629caa",
"name": "Example Journey",
"lastPublishedDate": "2020-04-30T03:54:50",
"description": "",
"version": 1,
"workflowApiVersion": 1,
"createdDate": "2020-04-30T03:54:17.993",
"modifiedDate": "2020-04-30T03:54:50.667",
"activities": [
{
"id": "6a630227-757b-449e-9ecb-e8ef0946b714",
"key": "REST-1",
"name": "",
"description": "",
"type": "REST",
"outcomes": [
{
"key": "12974ba8-e3e7-407f-91ec-ee93bae7dad4",
"next": "WAITBYDURATION-1",
"arguments": {},
"metaData": {
"invalid": false
}
}
],
"arguments": {
"executionMode": "{{Context.ExecutionMode}}",
"definitionId": "{{Context.DefinitionId}}",
"activityId": "{{Activity.Id}}",
"contactKey": "{{Context.ContactKey}}",
"execute": {
"inArguments": [
{
"emailAddress": "{{Contact.Attribute.EmailAddress}}",
"api_key": "example-api-key-123",
"title": "Example Title",
"description": "Example Description",
"image_url": "https://example.com/images/example-image.jpeg",
"push_url": "https://example.com/webhook/"
}
],
"outArguments": [],
"url": "https://example.com/api/activity/execute",
"verb": "POST",
"body": "",
"header": "",
"format": "json",
"timeout": 90000
},
"testExecute": "",
"startActivityKey": "{{Context.StartActivityKey}}",
"definitionInstanceId": "{{Context.DefinitionInstanceId}}",
"requestObjectId": "{{Context.RequestObjectId}}"
},
"configurationArguments": {
"applicationExtensionKey": "f10680af-8b0b-492c-8417-56a158edc788",
"applicationExtensionId": "b053f0cd-2e41-446c-9150-d34733ee446a",
"save": {
"url": "https://example.com/api/activity/save",
"verb": "POST",
"body": ""
},
"testSave": "",
"publish": {
"url": "https://example.com/api/activity/publish",
"verb": "POST",
"body": ""
},
"testPublish": "",
"unpublish": "",
"stop": "",
"testStop": "",
"testUnpublish": "",
"partnerActivityId": "",
"validate": {
"url": "https://example.com/api/activity/validate",
"verb": "POST",
"body": ""
},
"testValidate": "",
"outArgumentSchema": "",
"executeSchema": ""
},
"metaData": {
"icon": "https://example.com/images/icon.png",
"iconSmall": "https://example.com/images/iconSmall.png",
"category": "message",
"isConfigured": true,
"statsContactIcon": "",
"original_icon": "images/icon.png",
"original_iconSmall": "images/iconSmall.png"
}
}
],
"triggers": [
{
"id": "1f9e7189-0fd9-49de-9a4d-1d45bfa8647d",
"key": "TRIGGER",
"name": "TRIGGER",
"description": "",
"type": "EmailAudience",
"outcomes": [],
"arguments": {
"startActivityKey": "{{Context.StartActivityKey}}",
"dequeueReason": "{{Context.DequeueReason}}",
"lastExecutedActivityKey": "{{Context.LastExecutedActivityKey}}",
"filterResult": "true"
},
"configurationArguments": {
"schemaVersionId": 0,
"criteria": "",
"filterDefinitionId": "00000000-0000-0000-0000-000000000000"
},
"metaData": {
"sourceInteractionId": "00000000-0000-0000-0000-000000000000",
"eventDefinitionId": "4b3fe563-edc3-4b89-a1b1-d3f2b2821f06",
"eventDefinitionKey": "DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c",
"chainType": "None",
"configurationRequired": false,
"iconUrl": "/images/icon-data-extension.svg",
"title": "Data Extension",
"entrySourceGroupConfigUrl": "jb:///data/entry/audience/entrysourcegroupconfig.json"
}
}
],
"goals": [],
"exits": [],
"notifiers": [],
"stats": {
"currentPopulation": 0,
"cumulativePopulation": 0,
"metGoal": 0,
"metExitCriteria": 0,
"goalPerformance": 0
},
"entryMode": "MultipleEntries",
"definitionType": "Multistep",
"channel": "",
"defaults": {
"email": [
"{{Event.DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c.\"EmailAddress\"}}"
],
"properties": {
"analyticsTracking": {
"enabled": false,
"analyticsType": "google",
"urlDomainsToTrack": []
}
}
},
"metaData": {},
"executionMode": "Production",
"categoryId": 2929,
"status": "Published",
"definitionId": "69dd5e94-d963-4508-861b-8f818d6da93a",
"scheduledStatus": "Draft",
"campaigns": []
}
}
Create SMS Definition
Create a new transactional SMS send definition. | key: createSmsDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Description | A description of the transactional SMS definition. | Sends order confirmation via SMS |
| Extra Body | Additional properties to include in the SMS definition creation request. | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
| Definition Name | The display name for the transactional SMS definition. | Order Confirmation SMS |
{
"data": {
"requestId": "582bec09-6d04-4222-bbba-cea616495596",
"name": "Example SMS Definition",
"definitionKey": "example-sms-def",
"description": "Example SMS transactional definition",
"status": "Active",
"createdDate": "2024-07-10T04:20:00",
"modifiedDate": "2024-07-10T04:20:00",
"content": {
"message": "Your verification code is: {{code}}"
},
"subscriptions": {
"shortCode": "12345",
"countryCode": "US",
"autoAddSubscriber": true,
"updateSubscriber": true,
"keyword": "EXAMPLE"
},
"options": {
"urlShortenerOptions": {
"isLinkShorteningEnabled": true,
"isSubscriberTrackingEnabled": true,
"shortenerType": "SFMC"
},
"smsMessageRegulatoryAuthorityTemplateId": "example-template-id-123"
}
}
}
Delete Asset
Delete a Content Builder asset by ID. | key: deleteAsset
| Input | Notes | Example |
|---|---|---|
| Asset ID | The unique identifier for the Content Builder asset in Marketing Cloud. | 12345 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"success": true,
"id": "12345",
"message": "Asset deleted successfully"
}
}
Delete Campaign
Delete a campaign by ID. | key: deleteCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign ID | The unique identifier for the campaign in Marketing Cloud. | 12345 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": null
}
Delete Category
Delete a Content Builder category (folder) by ID. | key: deleteCategory
| Input | Notes | Example |
|---|---|---|
| Category ID | The unique identifier of the Content Builder category (folder). | 54975 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": null
}
Delete Contact
Delete one or more contacts by contact key. This operation is asynchronous and may take time to complete. Returns an operation ID for status tracking. | key: deleteContact
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Keys | One or more contact keys (subscriber keys) to delete. Deletion is asynchronous and may take time to complete. | contact-abc-123 |
{
"data": {
"operationID": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
"operationInitiated": true
}
}
Delete Email Definition
Delete a transactional email send definition by key. Deleted definitions are archived and cannot be restored. | key: deleteEmailDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
{
"data": {
"requestId": "c537a3f4-ea8c-40b3-81bb-41a91666c82a",
"deletedDefinitionKey": "welcome-email-def"
}
}
Delete ENS Callback
Delete an ENS callback endpoint registration. | key: deleteCallback
| Input | Notes | Example |
|---|---|---|
| Callback ID | The unique identifier of the ENS callback registration. | cb-12345-abcde |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"success": true,
"callbackId": "c3d4e5f6-a7b8-9012-cdef-234567890123",
"message": "Callback deleted successfully"
}
}
Delete ENS Subscription
Delete an ENS event subscription. | key: deleteSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Subscription ID | The unique identifier of the ENS event subscription. | sub-12345-abcde |
{
"data": {
"success": true,
"subscriptionId": "a7b8c9d0-e1f2-3456-abcd-678901234567",
"message": "Subscription deleted successfully"
}
}
Delete Journey
Delete a journey (interaction) by ID. Deletes all versions of the journey. This action cannot be undone. | key: deleteJourney
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Journey ID | The unique identifier of the journey (interaction). | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
{
"data": null
}
Delete SMS Definition
Delete a transactional SMS send definition by key. Deleted definitions are archived and the key can be reused. | key: deleteSmsDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
{
"data": {
"requestId": "582bec09-6d04-4222-bbba-cea616495596",
"deletedDefinitionKey": "example-sms-def"
}
}
Execute Automation Activities
Execute automation activities by running all activities once. | key: executeAutomationActivities
| Input | Notes | Example |
|---|---|---|
| Automation ID | The unique identifier for the automation in Marketing Cloud. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": "Automation Started Successfully"
}
Exit Contact from Journey
Remove a contact from a running journey by contact key and definition key. Can remove from specific versions or all versions. | key: exitContactFromJourney
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Key | The contact key of the contact to exit from the journey. | contact-abc-123 |
| Definition Key | Customer Key that uniquely identifies the journey. This key is the same for all versions of the journey. | journey-welcome-series-2024 |
| Versions | One or more versions of a journey from which to remove a contact. Comma-separated list (e.g., '1,2,3'). If not specified, removes from all versions. | 1,2 |
{
"data": {
"errors": []
}
}
Fire Entry Event
Fire a journey entry event to inject a contact into a journey. | key: fireEntryEvent
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Key | The contact key (subscriber key) of the contact entering the journey. | contact-abc-123 |
| Event Data | Additional data to pass to the journey entry event as key-value pairs. | |
| Event Definition Key | The event definition key for the journey entry event. Found in the journey's entry source configuration. | APIEvent-abc123-def456 |
{
"data": {
"eventInstanceId": "d4e5f6a7-b8c9-0123-defa-345678901234"
}
}
Get Asset
Retrieve a Content Builder asset by ID. | key: getAsset
| Input | Notes | Example |
|---|---|---|
| Asset ID | The unique identifier for the Content Builder asset in Marketing Cloud. | 12345 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": 151239,
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"objectID": "087946b9-6c2a-4862-85e8-98c4f53b923e",
"contentType": "application/vnd.etmc.email.Message; kind=textOnly",
"assetType": {
"id": 209,
"name": "textonlyemail",
"displayName": "Text Only Email"
},
"name": "Test",
"description": "",
"owner": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"createdDate": "2026-02-16T16:46:01.383-06:00",
"createdBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"modifiedDate": "2026-02-16T16:46:16.753-06:00",
"modifiedBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"enterpriseId": 100012041,
"memberId": 100012041,
"status": {
"id": 1,
"name": "Draft"
},
"thumbnail": {
"thumbnailUrl": "/v1/assets/151239/thumbnail"
},
"category": {
"id": 54975,
"name": "Content Builder",
"parentId": 0
},
"views": {
"subjectline": {
"contentType": "application/vnd.etmc.email.View; kind=subjectline",
"thumbnail": {},
"content": "Subject",
"meta": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"text": {
"thumbnail": {},
"content": "Test",
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"subscriptioncenter": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"forwardText": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
}
},
"availableViews": [
"subjectline",
"text",
"subscriptioncenter",
"forwardText"
],
"data": {
"email": {
"options": {
"characterEncoding": "utf-8"
},
"legacy": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
}
}
},
"legacyData": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
},
"modelVersion": 2
}
}
Get Automation
Retrieve an Automation Studio automation by ID. | key: getAutomation
| Input | Notes | Example |
|---|---|---|
| Automation ID | The unique identifier for the automation in Marketing Cloud. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": "6b6ec44f-aaf1-4d3d-9f05-074a0328a9ee",
"name": "Example-Automation-24",
"description": "This automation processes data for analysis and scoring purposes.",
"key": "example-automation-24",
"typeId": 1,
"type": "scheduled",
"statusId": 6,
"status": "Scheduled",
"categoryId": 305349,
"lastRunTime": "2026-02-16T21:14:03.26",
"lastRunInstanceId": "684531f1-a97b-42bd-b252-ffbeb1c633ab",
"schedule": {
"id": "ef2a92b6-28d2-4fae-a2ee-c750154116fe",
"typeId": 2,
"startDate": "2022-11-22T21:14:08.603",
"endDate": "2052-11-20T21:14:08",
"scheduledTime": "2026-02-17T21:14:00",
"rangeTypeId": 0,
"occurrences": 10957,
"pattern": "<Pattern><PatternType>0</PatternType><HourInterval>24</HourInterval></Pattern>",
"icalRecur": "FREQ=HOURLY;COUNT=10957;INTERVAL=24",
"timezoneName": "Central Standard Time (no DST)",
"scheduleStatus": "active",
"timezoneId": 1
},
"steps": [
{
"id": "9e3db705-cd20-42f1-8b57-4955198e2a4f",
"name": "Automation Task for DFU ELT Activities",
"description": "Auto generated step task",
"step": 1,
"activities": [
{
"id": "5826c92e-6a12-410e-b9dc-b90379d20809",
"name": "Extract-Upload Example_Predictive_Scores into S3",
"activityObjectId": "53963411-9619-41a8-a958-d33b785f6a89",
"objectTypeId": 425,
"displayOrder": 1
},
{
"id": "879cf9f8-3810-4467-801a-f4a5b2bb6793",
"name": "Extract-Upload Example_DataExtension into S3",
"activityObjectId": "21e6bf87-f552-43ff-ac1e-88e58cf8a72f",
"objectTypeId": 425,
"displayOrder": 2
}
]
}
]
}
}
Get Campaign
Retrieve a campaign by ID. | key: getCampaign
| Input | Notes | Example |
|---|---|---|
| Campaign ID | The unique identifier for the campaign in Marketing Cloud. | 12345 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"createdDate": "2026-02-13T18:52:46",
"modifiedDate": "2026-02-16T22:11:05",
"id": "145",
"name": "Example Marketing Campaign",
"description": "Example campaign for product launch",
"campaignCode": "EXAMPLE2024",
"color": "ffc7c7",
"favorite": false
}
}
Get Category
Retrieve a single Content Builder category (folder) by its ID. | key: getCategory
| Input | Notes | Example |
|---|---|---|
| Category ID | The unique identifier of the Content Builder category (folder). | 54975 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": 54975,
"description": "The root folder for assets",
"enterpriseId": 10001,
"memberId": 10001,
"name": "Content Builder",
"parentId": 0,
"categoryType": "asset"
}
}
Get Contact
Retrieve a contact by contact key. | key: getContact
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Key | The unique identifier (subscriber key) for the contact in Marketing Cloud. | contact-abc-123 |
{
"data": {
"contactID": 123456789,
"contactType": "Default",
"contactKey": "user@example.com",
"contactStatus": "Active",
"modifiedDate": "2024-02-08T06:35:03.6"
}
}
Get Contact Schema
Retrieve the contact schema definition, including attribute sets and field definitions. | key: getContactSchema
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"item": {
"schemaID": "470d62a6-cd47-e811-80ce-1402ec819e1d",
"enterpriseID": 10001,
"availableBusinessUnits": [
10001
],
"version": 123,
"isModelOwner": true,
"schemaType": "Contacts",
"links": {
"attributeGroups": {
"href": "/v1//attributeGroups"
},
"attributeSetDefinitions": {
"href": "/v1//attributeSetDefinitions"
}
},
"objectState": "Created"
},
"links": {
"schema": {
"href": "/v1/schema"
}
},
"requestServiceMessageID": "bc7d6a11-5b3d-4863-b8e5-6d6a18d36982",
"responseDateTime": "2026-02-16T20:30:00.7390062-06:00",
"resultMessages": [],
"serviceMessageID": "960ce7b7-ed05-4889-b83e-f4d1ff528134"
}
}
Get Data Extension Fields
Retrieve a list of fields in a data extension. | key: getDataExtensionFields
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Data Extension ID | The unique ID of the data extension. | abc123de-f456-7890-abcd-ef1234567890 |
{
"data": {
"id": "f9e59b85-f353-ee11-ba4e-d4f5ef3d54c9",
"fields": [
{
"name": "MemberId",
"id": "fd526c4d-d5c5-4601-9849-53839857960c",
"type": "Number",
"maskType": "None",
"storageType": "Plain",
"description": "",
"ordinal": 0,
"isNullable": false,
"isPrimaryKey": true,
"isTemplateField": false,
"isInheritable": false,
"isOverridable": false,
"isHidden": false,
"isReadOnly": false,
"mustOverride": false
}
],
"fieldCount": 1
}
}
Get Email Definition
Retrieve a transactional email send definition by key. | key: getEmailDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
{
"data": {
"requestId": "c537a3f4-ea8c-40b3-81bb-41a91666c82a",
"name": "Example Email Definition",
"definitionKey": "welcome-email-def",
"definitionId": "856cf449-8f0b-f111-a5c3-48df37deb009",
"description": "Example transactional email definition",
"classification": "Default Transactional",
"status": "New",
"createdDate": "2026-02-16T17:29:00",
"modifiedDate": "2026-02-16T17:29:00",
"content": {
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739"
},
"subscriptions": {
"list": "All Subscribers - Example",
"autoAddSubscriber": true,
"updateSubscriber": true
},
"options": {
"trackLinks": true,
"isReconcilable": false
},
"journey": {}
}
}
Get Email Send Status
Retrieve the delivery status of a sent transactional email. | key: getEmailSendStatus
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Message Key | The message key returned from a send email request. | msg-abc-123 |
{
"data": {
"requestId": "30486456-ed41-46ba-96eb-06c4ff3b95d9",
"eventCategoryType": "TransactionalSendEvents.EmailNotSent",
"timestamp": "2025-07-24T06:26:58.463",
"compositeId": "56941A9F-3A8F-E811-80E0-1402EC6B9529.4647028.622338.1.318768528",
"info": {
"messageKey": "9a-zUvWf3UKxLpwwIrqTmQ",
"contactKey": "ec25a8c8-6d4e-42f0-84c3-4ea23564cbe5",
"to": "recipient@example.com"
},
"statusCode": 16,
"statusMessage": "InvalidAttributeValue"
}
}
Get ENS Subscription
Retrieve an Event Notification Service (ENS) subscription by ID. | key: getSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Subscription ID | The unique identifier of the ENS event subscription. | sub-12345-abcde |
{
"data": {
"callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
"callbackName": "cb1",
"url": "https://example.com/",
"maxBatchSize": 1000,
"subscriptionName": "Example Subscription Name",
"eventCategoryTypes": [
"TransactionalSendEvents.EmailNotSent",
"TransactionalSendEvents.EmailSent"
],
"subscriptionId": "d89c87c4-70f8-43d6-be1e-f01dce97fe4c",
"filters": [
"definitionKey=12345"
],
"status": "active",
"statusReason": "none"
}
}
Get Journey
Retrieve a journey (interaction) by ID. | key: getJourney
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Journey ID | The unique identifier of the journey (interaction). | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| Version | The version number of the journey. Defaults to the latest version. | 1 |
{
"data": {
"id": "69dd5e94-d963-4508-861b-8f818d6da93a",
"key": "281ba2ad-c597-4740-54f6-3cc41f629caa",
"name": "Example Journey",
"lastPublishedDate": "2020-04-30T03:54:50",
"description": "",
"version": 1,
"workflowApiVersion": 1,
"createdDate": "2020-04-30T03:54:17.993",
"modifiedDate": "2020-04-30T03:54:50.667",
"activities": [
{
"id": "6a630227-757b-449e-9ecb-e8ef0946b714",
"key": "REST-1",
"name": "",
"description": "",
"type": "REST",
"outcomes": [
{
"key": "12974ba8-e3e7-407f-91ec-ee93bae7dad4",
"next": "WAITBYDURATION-1",
"arguments": {},
"metaData": {
"invalid": false
}
}
],
"arguments": {
"executionMode": "{{Context.ExecutionMode}}",
"definitionId": "{{Context.DefinitionId}}",
"activityId": "{{Activity.Id}}",
"contactKey": "{{Context.ContactKey}}",
"execute": {
"inArguments": [
{
"emailAddress": "{{Contact.Attribute.EmailAddress}}",
"api_key": "example-api-key-123",
"title": "Example Title",
"description": "Example Description",
"image_url": "https://example.com/images/example-image.jpeg",
"push_url": "https://example.com/webhook/"
}
],
"outArguments": [],
"url": "https://example.com/api/activity/execute",
"verb": "POST",
"body": "",
"header": "",
"format": "json",
"timeout": 90000
},
"testExecute": "",
"startActivityKey": "{{Context.StartActivityKey}}",
"definitionInstanceId": "{{Context.DefinitionInstanceId}}",
"requestObjectId": "{{Context.RequestObjectId}}"
},
"configurationArguments": {
"applicationExtensionKey": "f10680af-8b0b-492c-8417-56a158edc788",
"applicationExtensionId": "b053f0cd-2e41-446c-9150-d34733ee446a",
"save": {
"url": "https://example.com/api/activity/save",
"verb": "POST",
"body": ""
},
"testSave": "",
"publish": {
"url": "https://example.com/api/activity/publish",
"verb": "POST",
"body": ""
},
"testPublish": "",
"unpublish": "",
"stop": "",
"testStop": "",
"testUnpublish": "",
"partnerActivityId": "",
"validate": {
"url": "https://example.com/api/activity/validate",
"verb": "POST",
"body": ""
},
"testValidate": "",
"outArgumentSchema": "",
"executeSchema": ""
},
"metaData": {
"icon": "https://example.com/images/icon.png",
"iconSmall": "https://example.com/images/iconSmall.png",
"category": "message",
"isConfigured": true,
"statsContactIcon": "",
"original_icon": "images/icon.png",
"original_iconSmall": "images/iconSmall.png"
}
}
],
"triggers": [
{
"id": "1f9e7189-0fd9-49de-9a4d-1d45bfa8647d",
"key": "TRIGGER",
"name": "TRIGGER",
"description": "",
"type": "EmailAudience",
"outcomes": [],
"arguments": {
"startActivityKey": "{{Context.StartActivityKey}}",
"dequeueReason": "{{Context.DequeueReason}}",
"lastExecutedActivityKey": "{{Context.LastExecutedActivityKey}}",
"filterResult": "true"
},
"configurationArguments": {
"schemaVersionId": 0,
"criteria": "",
"filterDefinitionId": "00000000-0000-0000-0000-000000000000"
},
"metaData": {
"sourceInteractionId": "00000000-0000-0000-0000-000000000000",
"eventDefinitionId": "4b3fe563-edc3-4b89-a1b1-d3f2b2821f06",
"eventDefinitionKey": "DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c",
"chainType": "None",
"configurationRequired": false,
"iconUrl": "/images/icon-data-extension.svg",
"title": "Data Extension",
"entrySourceGroupConfigUrl": "jb:///data/entry/audience/entrysourcegroupconfig.json"
}
}
],
"goals": [],
"exits": [],
"notifiers": [],
"stats": {
"currentPopulation": 0,
"cumulativePopulation": 0,
"metGoal": 0,
"metExitCriteria": 0,
"goalPerformance": 0
},
"entryMode": "MultipleEntries",
"definitionType": "Multistep",
"channel": "",
"defaults": {
"email": [
"{{Event.DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c.\"EmailAddress\"}}"
],
"properties": {
"analyticsTracking": {
"enabled": false,
"analyticsType": "google",
"urlDomainsToTrack": []
}
}
},
"metaData": {},
"executionMode": "Production",
"categoryId": 2929,
"status": "Published",
"definitionId": "69dd5e94-d963-4508-861b-8f818d6da93a",
"scheduledStatus": "Draft",
"campaigns": []
}
}
Get SMS Definition
Retrieve a transactional SMS send definition by key. | key: getSmsDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
{
"data": {
"requestId": "582bec09-6d04-4222-bbba-cea616495596",
"name": "Example SMS Definition",
"definitionKey": "example-sms-def",
"description": "Example SMS transactional definition",
"status": "Active",
"createdDate": "2024-07-10T04:20:00",
"modifiedDate": "2024-07-10T04:20:00",
"content": {
"message": "Your verification code is: {{code}}"
},
"subscriptions": {
"shortCode": "12345",
"countryCode": "US",
"autoAddSubscriber": true,
"updateSubscriber": true,
"keyword": "EXAMPLE"
},
"options": {
"urlShortenerOptions": {
"isLinkShorteningEnabled": true,
"isSubscriberTrackingEnabled": true,
"shortenerType": "SFMC"
},
"smsMessageRegulatoryAuthorityTemplateId": "example-template-id-123"
}
}
}
List Assets
List Content Builder assets with optional pagination. | key: listAssets
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"count": 22,
"page": 1,
"pageSize": 1,
"links": {},
"items": [
{
"id": 151239,
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"objectID": "087946b9-6c2a-4862-85e8-98c4f53b923e",
"contentType": "application/vnd.etmc.email.Message; kind=textOnly",
"assetType": {
"id": 209,
"name": "textonlyemail",
"displayName": "Text Only Email"
},
"name": "Test",
"description": "",
"owner": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"createdDate": "2026-02-16T16:46:01.383-06:00",
"createdBy": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"modifiedDate": "2026-02-16T16:46:16.753-06:00",
"modifiedBy": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"enterpriseId": 100012041,
"memberId": 100012041,
"status": {
"id": 1,
"name": "Draft"
},
"thumbnail": {
"thumbnailUrl": "/v1/assets/151239/thumbnail"
},
"category": {
"id": 54975,
"name": "Content Builder",
"parentId": 0
},
"views": {
"subjectline": {
"contentType": "application/vnd.etmc.email.View; kind=subjectline",
"content": "Subject",
"meta": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"text": {
"content": "Test",
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"subscriptioncenter": {
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"forwardText": {
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
}
},
"availableViews": [
"subjectline",
"text",
"subscriptioncenter",
"forwardText"
],
"data": {
"email": {
"options": {
"characterEncoding": "utf-8"
},
"legacy": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
}
}
},
"legacyData": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
},
"modelVersion": 2
}
]
}
}
List Automations
List Automation Studio automations with optional pagination. | key: listAutomations
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"page": 1,
"pageSize": 1,
"count": 53,
"items": [
{
"id": "6b6ec44f-aaf1-4d3d-9f05-074a0328a9ee",
"name": "Example-Automation-24",
"description": "This automation sends CURRENT data to the Data Scientists for scoring and is an important componentof the Einstein Engagement Scoring application.",
"key": "example-automation-24",
"typeId": 1,
"type": "scheduled",
"statusId": 6,
"status": "Scheduled",
"categoryId": 305349,
"lastRunTime": "2026-02-16T21:14:03.26",
"lastRunInstanceId": "684531f1-a97b-42bd-b252-ffbeb1c633ab",
"schedule": {
"id": "ef2a92b6-28d2-4fae-a2ee-c750154116fe",
"typeId": 2,
"startDate": "2022-11-22T21:14:08.603",
"endDate": "2052-11-20T21:14:08",
"scheduledTime": "2026-02-17T21:14:00",
"rangeTypeId": 0,
"occurrences": 10957,
"pattern": "<Pattern><PatternType>0</PatternType><HourInterval>24</HourInterval></Pattern>",
"icalRecur": "FREQ=HOURLY;COUNT=10957;INTERVAL=24",
"timezoneName": "Central Standard Time (no DST)",
"scheduleStatus": "active",
"timezoneId": 1
}
}
]
}
}
List Campaigns
List campaigns with optional pagination. | key: listCampaigns
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"count": 12,
"page": 1,
"pageSize": 1,
"links": {
"self": {
"href": "/v1/campaigns?$page=1&$pagesize=1"
},
"next": {
"href": "/v1/campaigns?$page=2&$pagesize=1"
}
},
"items": [
{
"createdDate": "2026-02-13T18:52:46",
"modifiedDate": "2026-02-13T18:52:46",
"id": "145",
"name": "New campaign",
"description": "New",
"campaignCode": "SUMMER",
"color": "ffc7c7",
"favorite": false
}
]
}
}
List Categories
List Content Builder categories (folders). | key: listCategories
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"count": 1,
"page": 1,
"pageSize": 50,
"links": {},
"items": [
{
"id": 54975,
"description": "The root folder for assets",
"enterpriseId": 10001,
"memberId": 10001,
"name": "Content Builder",
"parentId": 0,
"categoryType": "asset"
}
]
}
}
List Data Extensions
Retrieve a list of data extensions that match a search string, with optional pagination. | key: listDataExtensions
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
| Search String | A string to search for in the name of the custom object. | Contacts |
{
"data": {
"count": 1,
"page": 1,
"pageSize": 25,
"links": {},
"items": [
{
"id": "36e73253-16a9-ee11-ac6c-0abc489251b9",
"name": "facb9d48d7c44486a7b0715ef0b2f7a2",
"key": "facb9d48d7c44486a7b0715ef0b2f7a2",
"description": "",
"isActive": true,
"isSendable": true,
"sendableCustomObjectField": "SubscriberKey",
"sendableSubscriberField": "_SubscriberKey",
"isTestable": true,
"categoryId": 152631,
"ownerId": 712000003,
"isObjectDeletable": true,
"isFieldAdditionAllowed": true,
"isFieldModificationAllowed": true,
"createdDate": "2024-01-01T20:26:31.07",
"createdById": 712000003,
"createdByName": "TestUser",
"modifiedDate": "2024-01-01T20:26:31.07",
"modifiedById": 712000003,
"modifiedByName": "TestUser",
"ownerName": "TestUser",
"partnerApiObjectTypeId": 310,
"partnerApiObjectTypeName": "DataExtension",
"rowCount": 100000,
"dataRetentionProperties": {
"isDeleteAtEndOfRetentionPeriod": false,
"isRowBasedRetention": false,
"isResetRetentionPeriodOnImport": false
},
"fieldCount": 5
}
]
}
}
List Email Definitions
List transactional email send definitions with optional pagination. | key: listEmailDefinitions
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"requestId": "92639bbb-7161-4c27-a08b-e5baf6fdef50",
"definitions": [
{
"name": "Example Email Definition",
"definitionKey": "test-email-def",
"status": "New",
"createdDate": "2026-02-16T17:31:00",
"modifiedDate": "2026-02-16T17:31:00"
}
],
"count": 1,
"page": 1,
"pageSize": 50
}
}
List ENS Callbacks
List registered Event Notification Service (ENS) callback endpoints. | key: listCallbacks
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": [
{
"callbackId": "14e2ee5b-8c01-4f9d-916d-29e329945619",
"callbackName": "Example Callback",
"url": "https://webhook.example.com/callback/example-endpoint",
"maxBatchSize": 1000,
"status": "verified",
"statusReason": ""
}
]
}
List ENS Subscriptions
List Event Notification Service (ENS) event subscriptions. | key: listSubscriptions
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": [
{
"callbackId": "14e2ee5b-8c01-4f9d-916d-29e329945619",
"callbackName": "Example Callback",
"url": "https://webhook.example.com/callback/example-endpoint",
"maxBatchSize": 1000,
"subscriptionId": "6807835e-a82f-498e-a0b9-55d6bde4814d",
"subscriptionName": "Example Subscription",
"eventCategoryTypes": [
"TransactionalSendEvents.EmailSent"
],
"filters": [
""
],
"status": "active",
"statusReason": ""
}
]
}
List Journeys
List journeys (interactions) with optional filtering. | key: listJourneys
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Name Filter | Filter journeys by name (partial match). | Welcome |
| Status | Filter journeys by status. | |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"count": 1,
"page": 1,
"pageSize": 50,
"links": {},
"items": [
{
"id": "69dd5e94-d963-4508-861b-8f818d6da93a",
"key": "281ba2ad-c597-4740-54f6-3cc41f629caa",
"name": "Example Journey",
"lastPublishedDate": "2020-04-30T03:54:50",
"description": "",
"version": 1,
"workflowApiVersion": 1,
"createdDate": "2020-04-30T03:54:17.993",
"modifiedDate": "2020-04-30T03:54:50.667",
"goals": [],
"exits": [],
"notifiers": [],
"stats": {
"currentPopulation": 0,
"cumulativePopulation": 0,
"metGoal": 0,
"metExitCriteria": 0,
"goalPerformance": 0
},
"entryMode": "MultipleEntries",
"definitionType": "Multistep",
"channel": "",
"defaults": {
"email": [
"{{Event.DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c.\"EmailAddress\"}}"
],
"properties": {
"analyticsTracking": {
"enabled": false,
"analyticsType": "google",
"urlDomainsToTrack": []
}
}
},
"metaData": {},
"executionMode": "Production",
"categoryId": 2929,
"status": "Published",
"definitionId": "69dd5e94-d963-4508-861b-8f818d6da93a",
"scheduledStatus": "Draft",
"campaigns": []
}
]
}
}
List SMS Definitions
List transactional SMS send definitions with optional pagination. | key: listSmsDefinitions
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Fetch All | When true, automatically fetches all pages of results using pagination. | false |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"requestId": "ba9633fa-5c8d-4c42-8efa-a16412ac0c53",
"definitions": [
{
"definitionKey": "example-sms-def",
"status": "Active",
"name": "Example SMS Definition",
"createdDate": "2018-07-18T19:52:00",
"modifiedDate": "2018-07-18T19:52:00"
}
],
"count": 1,
"page": 1,
"pageSize": 10
}
}
Query Assets
Search Content Builder assets using the query API with filters and sorting. | key: queryAssets
| Input | Notes | Example |
|---|---|---|
| Fields | Comma-separated list of fields to include in the response. Reduces payload size. | id,name,assetType,category |
| Query | A query filter object for searching assets. Uses the Content Builder query syntax. | |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Page | The page number to retrieve (starts at 1). | 1 |
| Page Size | The maximum number of results returned per page. The allowed maximum depends on the endpoint. A Page value must be provided for this parameter to take effect. | 50 |
{
"data": {
"count": 22,
"page": 1,
"pageSize": 1,
"links": {},
"items": [
{
"id": 151239,
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"objectID": "087946b9-6c2a-4862-85e8-98c4f53b923e",
"contentType": "application/vnd.etmc.email.Message; kind=textOnly",
"assetType": {
"id": 209,
"name": "textonlyemail",
"displayName": "Text Only Email"
},
"name": "Test",
"description": "",
"owner": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"createdDate": "2026-02-16T16:46:01.383-06:00",
"createdBy": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"modifiedDate": "2026-02-16T16:46:16.753-06:00",
"modifiedBy": {
"id": 715698780,
"email": "example@email.com",
"name": "example@email.com",
"userId": "715698780"
},
"enterpriseId": 100012041,
"memberId": 100012041,
"status": {
"id": 1,
"name": "Draft"
},
"thumbnail": {
"thumbnailUrl": "/v1/assets/151239/thumbnail"
},
"category": {
"id": 54975,
"name": "Content Builder",
"parentId": 0
},
"views": {
"subjectline": {
"contentType": "application/vnd.etmc.email.View; kind=subjectline",
"content": "Subject",
"meta": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"text": {
"content": "Test",
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"subscriptioncenter": {
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"forwardText": {
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
}
},
"availableViews": [
"subjectline",
"text",
"subscriptioncenter",
"forwardText"
],
"data": {
"email": {
"options": {
"characterEncoding": "utf-8"
},
"legacy": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
}
}
},
"legacyData": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
},
"modelVersion": 2
}
]
}
}
Raw Request
Send a raw HTTP request to the Salesforce Marketing Cloud REST API. | key: rawRequest
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Data | The HTTP body payload to send to the URL. | {"exampleKey": "Example Data"} |
| File Data | File Data to be sent as a multipart form upload. | [{key: "example.txt", value: "My File Contents"}] |
| File Data File Names | File names to apply to the file data inputs. Keys must match the file data keys above. | |
| Form Data | The Form Data to be sent as a multipart form upload. | [{"key": "Example Key", "value": new Buffer("Hello World")}] |
| Header | A list of headers to send with the request. | User-Agent: curl/7.64.1 |
| Max Retry Count | The maximum number of retries to attempt. Specify 0 for no retries. | 0 |
| Method | The HTTP method to use. | |
| Query Parameter | A list of query parameters to send with the request. This is the portion at the end of the URL similar to ?key1=value1&key2=value2. | |
| Response Type | The type of data you expect in the response. You can request json, text, or binary data. | json |
| Retry On All Errors | If true, retries on all erroneous responses regardless of type. This is helpful when retrying after HTTP 429 or other 3xx or 4xx errors. Otherwise, only retries on HTTP 5xx and network errors. | false |
| Retry Delay (ms) | The delay in milliseconds between retries. This is used when 'Use Exponential Backoff' is disabled. | 0 |
| Timeout | The maximum time that a client will await a response to its request | 2000 |
| URL | Input the path only (/interaction/v1/interactions). The base URL is already included (https://{your_subdomain}.rest.marketingcloudapis.com/). For example, to connect to https://{your_subdomain}.rest.marketingcloudapis.com//interaction/v1/interactions, only /interaction/v1/interactions is entered in this field. | /interaction/v1/interactions |
| Use Exponential Backoff | Specifies whether to use a pre-defined exponential backoff strategy for retries. When enabled, 'Retry Delay (ms)' is ignored. | false |
{
"data": {
"links": {
"self": "/v1/customobjectdata/token/70de54a3-1e37-4340-a2fc-d09f809b4d2d/rowset?$page=1"
},
"requestToken": "70de54a3-1e37-4340-a2fc-d09f809b4d2d",
"tokenExpireDateUtc": "2026-02-18T04:59:10.917",
"customObjectId": "179dede7-637a-ef11-a5af-48df37deb009",
"customObjectKey": "09850BAC-D44C-452B-A182-CD9A695E4070",
"pageSize": 1,
"page": 1,
"count": 1,
"top": 0,
"items": [
{
"keys": {},
"values": {
"email": "user@example.com",
"name": "Example User",
"insider_id": "example-id-123456789"
}
}
]
}
}
Search Contacts
Search contacts using filter criteria. | key: searchContacts
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Search Filter | A filter object to search contacts. Uses the Marketing Cloud Contacts search syntax. |
{
"data": {
"count": 1,
"page": 1,
"pageSize": 50,
"items": [
{
"contactKey": "user@example.com",
"contactID": 123456789
}
]
}
}
Search Contacts by Email
Search for contacts by email address. | key: searchContactsByEmail
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Email Address | The email address associated with the contact. | john.doe@example.com |
{
"data": {
"count": 1,
"page": 1,
"pageSize": 50,
"items": [
{
"contactKey": "user@example.com",
"contactID": 123456789
}
]
}
}
Send Email
Send a transactional email to a single recipient using a send definition. | key: sendEmail
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
| Message Key | The unique identifier of the email definition you want to send. | msg-abc-123 |
| Recipient Attributes | Key-value pairs of personalization attributes for the email template. | |
| Recipient Contact Key | The contact key (subscriber key) of the email recipient. | contact-abc-123 |
| Recipient Email | The email address to send to. | john.doe@example.com |
{
"data": {
"requestId": "239a2bc3-bdcb-4f8a-9e08-28aff9f983b7",
"errorcode": 0,
"responses": [
{
"messageKey": "f4fe74b7-c3c0-4e5a-9f49-b63a641109a2"
}
]
}
}
Send Email Batch
Send a transactional email to multiple recipients in a single batch request. | key: sendEmailBatch
| Input | Notes | Example |
|---|---|---|
| Recipients | An array of recipient objects for batch email sending. Each must include contactKey and to. | |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
{
"data": {
"requestId": "ccdb94bf-fcac-4fef-b194-08f534a2079a",
"errorcode": 0,
"responses": [
{
"messageKey": "nFL4ULgheUeaGbPIMzJJSw"
},
{
"messageKey": "GV1LhQ6NFkqFUAE1IsoQ9Q"
}
]
}
}
Send SMS
Send a transactional SMS to a single recipient using a send definition. | key: sendSms
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
| Message Key | A unique identifier that you can use to track the status of the message. The key can contain up to 100 characters. | msg-abc-123 |
| Recipient Attributes | Key-value pairs of personalization attributes for the SMS. | |
| Recipient Contact Key | The contact key (subscriber key) of the SMS recipient. | contact-abc-123 |
| Recipient Phone | The phone number to send the SMS to, including country code (e.g., +15551234567). | +15551234567 |
{
"data": {
"requestId": "239a2bc3-bdcb-4f8a-9e08-28aff9f983b7",
"errorcode": 0,
"responses": [
{
"messageKey": "f4fe74b7-c3c0-4e5a-9f49-b63a641109a2"
}
]
}
}
Send SMS Batch
Send a transactional SMS to multiple recipients in a single batch request. | key: sendSmsBatch
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Recipients | An array of recipient objects for batch SMS sending. Each must include contactKey and to (phone number). | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
{
"data": {
"requestId": "ccdb94bf-fcac-4fef-b194-08f534a2079a",
"errorcode": 0,
"responses": [
{
"messageKey": "nFL4ULgheUeaGbPIMzJJSw"
},
{
"messageKey": "GV1LhQ6NFkqFUAE1IsoQ9Q"
}
]
}
}
Update Asset
Update an existing Content Builder asset. | key: updateAsset
| Input | Notes | Example |
|---|---|---|
| Content | The HTML or text content of the asset. | |
| Asset Description | Optional description providing details about the asset's purpose and usage. | HTML email template for new subscriber welcome series |
| Extra Body | Additional properties to include in the asset creation or update request. | |
| Asset ID | The unique identifier for the Content Builder asset in Marketing Cloud. | 12345 |
| Asset Name | The display name shown for the asset in Content Builder. | Welcome Email Template |
| Category ID | The ID of the Content Builder folder/category for the asset. | 98765 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": 151239,
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"objectID": "087946b9-6c2a-4862-85e8-98c4f53b923e",
"contentType": "application/vnd.etmc.email.Message; kind=textOnly",
"assetType": {
"id": 209,
"name": "textonlyemail",
"displayName": "Text Only Email"
},
"name": "Test",
"description": "",
"owner": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"createdDate": "2026-02-16T16:46:01.383-06:00",
"createdBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"modifiedDate": "2026-02-16T16:46:16.753-06:00",
"modifiedBy": {
"id": 12345,
"email": "user@example.com",
"name": "Example User",
"userId": "12345"
},
"enterpriseId": 100012041,
"memberId": 100012041,
"status": {
"id": 1,
"name": "Draft"
},
"thumbnail": {
"thumbnailUrl": "/v1/assets/151239/thumbnail"
},
"category": {
"id": 54975,
"name": "Content Builder",
"parentId": 0
},
"views": {
"subjectline": {
"contentType": "application/vnd.etmc.email.View; kind=subjectline",
"thumbnail": {},
"content": "Subject",
"meta": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"text": {
"thumbnail": {},
"content": "Test",
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"subscriptioncenter": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
},
"forwardText": {
"thumbnail": {},
"availableViews": [],
"data": {
"email": {
"options": {
"generateFrom": ""
}
}
},
"modelVersion": 2
}
},
"availableViews": [
"subjectline",
"text",
"subscriptioncenter",
"forwardText"
],
"data": {
"email": {
"options": {
"characterEncoding": "utf-8"
},
"legacy": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
}
}
},
"legacyData": {
"legacyId": 55741,
"legacyKey": "7f18a738-74a7-4243-a763-4d80f42fb739",
"legacyType": "email",
"legacyCategoryId": 1580
},
"modelVersion": 2
}
}
Update Automation
Update an automation by ID. Use this to modify properties like name, description, or toggle isActive to pause/resume a scheduled automation. | key: updateAutomation
| Input | Notes | Example |
|---|---|---|
| Extra Body | A JSON object of properties to update on the automation (e.g., name, description, isActive, steps, schedule). | |
| Automation ID | The unique identifier for the automation in Marketing Cloud. | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). |
{
"data": {
"id": "6b6ec44f-aaf1-4d3d-9f05-074a0328a9ee",
"name": "Example-Automation-24",
"description": "This automation processes data for analysis and scoring purposes.",
"key": "example-automation-24",
"typeId": 1,
"type": "scheduled",
"statusId": 6,
"status": "Scheduled",
"categoryId": 305349,
"lastRunTime": "2026-02-16T21:14:03.26",
"lastRunInstanceId": "684531f1-a97b-42bd-b252-ffbeb1c633ab",
"schedule": {
"id": "ef2a92b6-28d2-4fae-a2ee-c750154116fe",
"typeId": 2,
"startDate": "2022-11-22T21:14:08.603",
"endDate": "2052-11-20T21:14:08",
"scheduledTime": "2026-02-17T21:14:00",
"rangeTypeId": 0,
"occurrences": 10957,
"pattern": "<Pattern><PatternType>0</PatternType><HourInterval>24</HourInterval></Pattern>",
"icalRecur": "FREQ=HOURLY;COUNT=10957;INTERVAL=24",
"timezoneName": "Central Standard Time (no DST)",
"scheduleStatus": "active",
"timezoneId": 1
},
"steps": [
{
"id": "9e3db705-cd20-42f1-8b57-4955198e2a4f",
"name": "Automation Task for DFU ELT Activities",
"description": "Auto generated step task",
"step": 1,
"activities": [
{
"id": "5826c92e-6a12-410e-b9dc-b90379d20809",
"name": "Extract-Upload Example_Predictive_Scores into S3",
"activityObjectId": "53963411-9619-41a8-a958-d33b785f6a89",
"objectTypeId": 425,
"displayOrder": 1
},
{
"id": "879cf9f8-3810-4467-801a-f4a5b2bb6793",
"name": "Extract-Upload Example_DataExtension into S3",
"activityObjectId": "21e6bf87-f552-43ff-ac1e-88e58cf8a72f",
"objectTypeId": 425,
"displayOrder": 2
}
]
}
]
}
}
Update Category
Update a Content Builder category (folder) by ID. Provide only the fields you want to change. | key: updateCategory
| Input | Notes | Example |
|---|---|---|
| Category ID | The unique identifier of the Content Builder category (folder). | 54975 |
| Category Name | The display name for the Content Builder folder/category. | Email Templates |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Parent Category ID | The ID of the parent category. Omit to create a top-level category. | 12345 |
{
"data": {
"id": 54975,
"description": "The root folder for assets",
"enterpriseId": 10001,
"memberId": 10001,
"name": "Content Builder",
"parentId": 0,
"categoryType": "asset"
}
}
Update Contact
Update an existing contact's attributes in Marketing Cloud. | key: updateContact
| Input | Notes | Example |
|---|---|---|
| Attribute Sets | An array of attribute set objects containing contact data to create or update. | |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Contact Key | The unique identifier (subscriber key) for the contact in Marketing Cloud. | contact-abc-123 |
{
"data": {
"contactID": 123456789,
"contactType": "Default",
"contactKey": "user@example.com",
"contactStatus": "Active",
"modifiedDate": "2024-02-08T06:35:03.6"
}
}
Update Email Definition
Update a transactional email send definition by key. Changes are applied automatically. | key: updateEmailDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Description | A description of the transactional email definition. | Sends a welcome email to new subscribers |
| Extra Body | Additional properties to include in the email definition creation request. | |
| Definition Key | The unique key identifying the transactional email definition. | welcome-email-def |
| Definition Name | The display name for the transactional email definition. | Welcome Email |
{
"data": {
"requestId": "c537a3f4-ea8c-40b3-81bb-41a91666c82a",
"name": "Example Email Definition",
"definitionKey": "welcome-email-def",
"definitionId": "856cf449-8f0b-f111-a5c3-48df37deb009",
"description": "Example transactional email definition",
"classification": "Default Transactional",
"status": "New",
"createdDate": "2026-02-16T17:29:00",
"modifiedDate": "2026-02-16T17:29:00",
"content": {
"customerKey": "7f18a738-74a7-4243-a763-4d80f42fb739"
},
"subscriptions": {
"list": "All Subscribers - Example",
"autoAddSubscriber": true,
"updateSubscriber": true
},
"options": {
"trackLinks": true,
"isReconcilable": false
},
"journey": {}
}
}
Update ENS Callback
Update an Event Notification Service (ENS) callback endpoint. Changes may take up to 2 minutes to become active. | key: updateCallback
| Input | Notes | Example |
|---|---|---|
| Callback ID | The unique identifier of the ENS callback registration. | cb-12345-abcde |
| Callback Name | A descriptive name for the ENS callback endpoint registration. | My Integration Webhook |
| Callback URL | The updated URL where Marketing Cloud will send event notifications. | https://hooks.example.com/sfmc/events |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Max Batch Size | The updated maximum number of events to include in a single callback batch (1-100). | 100 |
{
"data": [
{
"callbackId": "14e2ee5b-8c01-4f9d-916d-29e329945619",
"callbackName": "Updated Callback",
"url": "https://webhook.example.com/callback/updated",
"maxBatchSize": 500,
"status": "verified",
"statusReason": ""
}
]
}
Update ENS Subscription
Update an Event Notification Service (ENS) subscription. Can modify the subscription name, event types, or status. | key: updateSubscription
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Event Types | The event types to subscribe to. Select one or more Marketing Cloud event categories. | |
| Subscription ID | The unique identifier of the ENS event subscription. | sub-12345-abcde |
| Subscription Name | A descriptive name for the ENS event subscription. | Email Events Subscription |
{
"data": [
{
"callbackId": "65b885ab-c2b4-46fe-85d0-d6cb8be8057d",
"callbackName": "Example Callback 1",
"subscriptionName": "Updated Subscription",
"eventCategoryTypes": [
"TransactionalSendEvents.EmailSent",
"TransactionalSendEvents.EmailNotSent"
],
"subscriptionId": "d89c87c4-70f8-43d6-be1e-f01dce97fe4c",
"filters": [],
"status": "active"
}
]
}
Update Journey
Update an existing journey (interaction). This operation requires the full journey definition and replaces the existing configuration. Partial updates are not supported. | key: updateJourney
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Extra Body | Additional properties to include in the request body. | |
| Journey ID | The unique identifier of the journey (interaction). | a1b2c3d4-e5f6-7890-abcd-ef1234567890 |
| Journey Key | The customer key as a GUID (UUID) to be used while referencing this journey. | journey-welcome-series-2024 |
| Version | The version of this journey. | 1 |
| Workflow API Version | The Journey Spec version to use for this journey. Possible values: 0.5, 1.0. | 1.0 |
{
"data": {
"id": "69dd5e94-d963-4508-861b-8f818d6da93a",
"key": "281ba2ad-c597-4740-54f6-3cc41f629caa",
"name": "Example Journey",
"lastPublishedDate": "2020-04-30T03:54:50",
"description": "",
"version": 1,
"workflowApiVersion": 1,
"createdDate": "2020-04-30T03:54:17.993",
"modifiedDate": "2020-04-30T03:54:50.667",
"activities": [
{
"id": "6a630227-757b-449e-9ecb-e8ef0946b714",
"key": "REST-1",
"name": "",
"description": "",
"type": "REST",
"outcomes": [
{
"key": "12974ba8-e3e7-407f-91ec-ee93bae7dad4",
"next": "WAITBYDURATION-1",
"arguments": {},
"metaData": {
"invalid": false
}
}
],
"arguments": {
"executionMode": "{{Context.ExecutionMode}}",
"definitionId": "{{Context.DefinitionId}}",
"activityId": "{{Activity.Id}}",
"contactKey": "{{Context.ContactKey}}",
"execute": {
"inArguments": [
{
"emailAddress": "{{Contact.Attribute.EmailAddress}}",
"api_key": "example-api-key-123",
"title": "Example Title",
"description": "Example Description",
"image_url": "https://example.com/images/example-image.jpeg",
"push_url": "https://example.com/webhook/"
}
],
"outArguments": [],
"url": "https://example.com/api/activity/execute",
"verb": "POST",
"body": "",
"header": "",
"format": "json",
"timeout": 90000
},
"testExecute": "",
"startActivityKey": "{{Context.StartActivityKey}}",
"definitionInstanceId": "{{Context.DefinitionInstanceId}}",
"requestObjectId": "{{Context.RequestObjectId}}"
},
"configurationArguments": {
"applicationExtensionKey": "f10680af-8b0b-492c-8417-56a158edc788",
"applicationExtensionId": "b053f0cd-2e41-446c-9150-d34733ee446a",
"save": {
"url": "https://example.com/api/activity/save",
"verb": "POST",
"body": ""
},
"testSave": "",
"publish": {
"url": "https://example.com/api/activity/publish",
"verb": "POST",
"body": ""
},
"testPublish": "",
"unpublish": "",
"stop": "",
"testStop": "",
"testUnpublish": "",
"partnerActivityId": "",
"validate": {
"url": "https://example.com/api/activity/validate",
"verb": "POST",
"body": ""
},
"testValidate": "",
"outArgumentSchema": "",
"executeSchema": ""
},
"metaData": {
"icon": "https://example.com/images/icon.png",
"iconSmall": "https://example.com/images/iconSmall.png",
"category": "message",
"isConfigured": true,
"statsContactIcon": "",
"original_icon": "images/icon.png",
"original_iconSmall": "images/iconSmall.png"
}
}
],
"triggers": [
{
"id": "1f9e7189-0fd9-49de-9a4d-1d45bfa8647d",
"key": "TRIGGER",
"name": "TRIGGER",
"description": "",
"type": "EmailAudience",
"outcomes": [],
"arguments": {
"startActivityKey": "{{Context.StartActivityKey}}",
"dequeueReason": "{{Context.DequeueReason}}",
"lastExecutedActivityKey": "{{Context.LastExecutedActivityKey}}",
"filterResult": "true"
},
"configurationArguments": {
"schemaVersionId": 0,
"criteria": "",
"filterDefinitionId": "00000000-0000-0000-0000-000000000000"
},
"metaData": {
"sourceInteractionId": "00000000-0000-0000-0000-000000000000",
"eventDefinitionId": "4b3fe563-edc3-4b89-a1b1-d3f2b2821f06",
"eventDefinitionKey": "DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c",
"chainType": "None",
"configurationRequired": false,
"iconUrl": "/images/icon-data-extension.svg",
"title": "Data Extension",
"entrySourceGroupConfigUrl": "jb:///data/entry/audience/entrysourcegroupconfig.json"
}
}
],
"goals": [],
"exits": [],
"notifiers": [],
"stats": {
"currentPopulation": 0,
"cumulativePopulation": 0,
"metGoal": 0,
"metExitCriteria": 0,
"goalPerformance": 0
},
"entryMode": "MultipleEntries",
"definitionType": "Multistep",
"channel": "",
"defaults": {
"email": [
"{{Event.DEAudience-b9b8d08c-91bf-4b09-fc61-ff1b60ed751c.\"EmailAddress\"}}"
],
"properties": {
"analyticsTracking": {
"enabled": false,
"analyticsType": "google",
"urlDomainsToTrack": []
}
}
},
"metaData": {},
"executionMode": "Production",
"categoryId": 2929,
"status": "Published",
"definitionId": "69dd5e94-d963-4508-861b-8f818d6da93a",
"scheduledStatus": "Draft",
"campaigns": []
}
}
Update SMS Definition
Update a transactional SMS send definition by key. Changes may take up to two minutes to reflect in outbound messages. | key: updateSmsDefinition
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Definition Description | A description of the transactional SMS definition. | Sends order confirmation via SMS |
| Extra Body | Additional properties to include in the SMS definition creation request. | |
| Definition Key | The unique key identifying the transactional SMS definition. | order-confirmation-sms |
| Definition Name | The display name for the transactional SMS definition. | Order Confirmation SMS |
{
"data": {
"requestId": "582bec09-6d04-4222-bbba-cea616495596",
"name": "Example SMS Definition",
"definitionKey": "example-sms-def",
"description": "Example SMS transactional definition",
"status": "Active",
"createdDate": "2024-07-10T04:20:00",
"modifiedDate": "2024-07-10T04:20:00",
"content": {
"message": "Your verification code is: {{code}}"
},
"subscriptions": {
"shortCode": "12345",
"countryCode": "US",
"autoAddSubscriber": true,
"updateSubscriber": true,
"keyword": "EXAMPLE"
},
"options": {
"urlShortenerOptions": {
"isLinkShorteningEnabled": true,
"isSubscriberTrackingEnabled": true,
"shortenerType": "SFMC"
},
"smsMessageRegulatoryAuthorityTemplateId": "example-template-id-123"
}
}
}
Upsert Data Extension Row
Insert or update a single row in a data extension by primary key. | key: upsertRow
| Input | Notes | Example |
|---|---|---|
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Data Extension Key | The external key (customer key) of the data extension. Found in the data extension properties. | my-data-extension-key |
| Primary Keys | A JSON object of primary key column name/value pairs that identify the row. | |
| Row Data | A JSON object representing the row to upsert. Keys should match data extension column names. |
{
"data": [
{
"keys": {
"key": "425"
},
"values": {
"name": "Example Name"
}
}
]
}
Verify ENS Callback
Verify ownership of an ENS callback endpoint using the verification key. | key: verifyCallback
| Input | Notes | Example |
|---|---|---|
| Callback ID | The unique identifier of the ENS callback registration. | cb-12345-abcde |
| Connection | The Salesforce Marketing Cloud OAuth connection (Authorization Code for user context or Client Credentials for server-to-server). | |
| Verification Key | The verification key sent to the callback URL during registration. Must be returned to verify ownership. | abc123def456 |
{
"data": {}
}
Changelog
2025-02-23
Initial release of the Salesforce Marketing Cloud component with support for Content Builder assets, contacts, data extensions, transactional email, transactional SMS, journeys, campaigns, automations, and Event Notification Service (ENS) webhooks