Overview
Configuration is provided for establishing connections with Salesforce Marketing service. The configuration is used in the REST Connection Manager.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
Step 1. Right click Visual Studio to launch using "Run As Administrator".
Step 2. Right click on "Connection Managers" tab and select "New Connection..."
Step 3. In "Add SSIS Connection Manager" scroll down and select "REST connection manager" and click "Add..."
Step 4. From Configuration combo box select "Salesforce Marketing Cloud".
Step 5. Specify your domainin the Server parameter. The parameter should appear like https://[your domain].rest.marketingcloudapis.com.
Step 6. Click New button to create a new token file.
Step 7. In the Next Wizard, provide your credentials like client_id and client_secret for the required parameters and set the scopes to your desired scopes. Then click on the Next button.
Step 8. After successfuly entering your credentials for the login, Create and Save your password protected token file. Click OK.
Step 9. Click "Test Connection" to test your connection.
Congratulations! You’ve successfully established a connection to your Salesforce Marketing Cloud instance. You’re now ready to begin integrating and working with your data.
This guide provides a step-by-step walkthrough on how to create a connection to the Salesforce Marketing Cloud REST API using COZYROC's REST Connection Manager using OAuth Client Credentials Flow.
Step 1: Open Visual Studio as Administrator and add a REST Connection Manager by right-clicking in the Connection Managers area and selecting New Connection > REST.
Step 2: From the Configuration dropdown menu, select Salesforce Marketing Cloud. Set the Authentication type to Service.
Step 3: Provide client_id, client_secret and set the scope to desired scopes. Then press Test Connection button.
Congratulations! You’ve successfully established a connection to your Salesforce Marketing Cloud instance. You’re now ready to begin integrating and working with your data.
This guide demonstrates how to read data from the Salesforce Marketing Cloud service using the COZYROC REST Source component.
Step 1: Select an existing Data Flow Task or create a new Data Flow Task to begin configuring your data extraction.
Step 2: Open the SSIS Toolbox, then drag and drop the COZYROC REST Source component onto the Data Flow design surface.
Step 3: Double-click the REST Source component to open its settings. From the dropdown menu, select your Salesforce Marketing Cloud connection. Then, choose the desired resource from the list available in the second dropdown below.
If necessary, you can add additional parameters in the grid at the bottom..
Step 4: Click on the Columns tab, then select the Salesforce Marketing Cloud resource columns you want to retrieve.
Step 5: Click Preview to verify that all the required resource columns are included.
Congratulations! You have successfully learned how to read data from the Salesforce Marketing Cloud service.
This guide provides a step-by-step demonstration on how to write data to the Salesforce Marketing Cloud service resource using the COZYROC REST Destination component.
Step 1: Select an existing Data Flow Task or create a new one.
Step 2. Open the SSIS Toolbox, then drag and drop the COZYROC REST Destination component onto the design surface.
Step 3: Double-click the REST Destination component to open its settings. Select your Salesforce Marketing Cloud connection from the dropdown menu, then choose the desired resource action and the resource you wish to work with.
Step 4: Click the Mapping tab and map the input columns according to the process you are configuring.
If you need to provide input for other composite resource objects, adjust the inputs above accordingly and map the corresponding columns.
You’re all set! You have successfully learned how to write data to the Salesforce Marketing Cloud resource.
Configuration
Base URL address: https://[domain].rest.marketingcloudapis.com.
- OAuth
-
The authentication uses an authorized token. The token will be refreshed with the following expression:
{{=Date.now() + (response.expires_in - 300) * 1000}}.The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify client secret.
- redirect_uri: Required. Specify redirect_uri.
- Scope: https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/rest-permissions-and-scopes.htm
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/integration-app-auth-code.htm.
- Service
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id: Required. Specify client ID.
- client_secret: Required. Specify client secret.
- Scope: https://developer.salesforce.com/docs/atlas.en-us.mc-apis.meta/mc-apis/rest-permissions-and-scopes.htm
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.salesforce.com/docs/atlas.en-us.mc-app-development.meta/mc-app-development/integration-s2s-client-credentials.htm.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/address/v1/validateEmail.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_address?meta=validateEmail.
Template: ShortText.
- validators
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hub/v1/approvals-v2.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/getApprovalItems.html.
- [Read Single] action
-
Endpoint URL address:
/hub/v1/approvals-v2/{{=parameters.approvalItemId}}.The action has the following user-defined parameters:
- approvalItemId: Required. Specify the approval item identifier.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/getApprovalItem.html.
- [Create] action
-
Endpoint URL address:
/hub/v1/approvals-v2.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/createApprovalItem.html.
- approvalItemId
A key field. Template: ShortText.
- objectType
Template: ShortText.
- objectId
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- workflowItemId
Template: ShortText.
- workflowState
Template: ShortText.
- workflowType
Template: ShortText.
- workflowName
Template: ShortText.
- deadline
Template: LongText. A composite field.
- commentCounts
Field components:
- Contains the following components: open, addressed, completed, total.
- workflowItem
Field components:
-
Uses template:
ShortText. - Contains the following components: workflowItemId, workflowRound, type, currentState, availableTransitions.
-
Uses template:
- blocked
Data type: DT_BOOL
- roles
The value is gathered from
/hub/v1/approvals-v2/{{=item.approvalItemId}}/rolesaddress. Field components:- An array.
- Contains the following components: RoleId, workflowRoleInstanceId, workflowRoleDefinitionId, key, users.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/approvals-v2/settings.
The result is extracted from:{{=[response]}}.
The result is paginated.The following request parameters will be automatically processed:
-
$page:
{{=undefined}} -
$pagesize:
{{=undefined}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/getApprovalSettings.html.
-
$page:
- [Update] action
-
Endpoint URL address:
/approvals-v2/settings.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/updateApprovalSettings.html.
- key
Template: ShortText.
- value
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/asset/v1/content/assets.
The result is extracted from:{{=response.items}}.The following request parameters will be automatically processed:
-
$fields:
{{=parameters.fields.join()}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=getAssetsSimpleQuery.
-
$fields:
- [Read Single] action
-
Endpoint URL address:
/asset/v1/content/assets/{{=parameters.assetId}}.The action has the following user-defined parameters:
- assetId: Required. Specify the asset identifier.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals/getApprovalItem.html.
- [Create] action
-
Endpoint URL address:
/asset/v1/content/assets.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=createAsset.
- [Update] action
-
Endpoint URL address:
/asset/v1/content/assets/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=updateAsset.
- [Delete] action
-
Endpoint URL address:
/asset/v1/content/assets/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=deleteAsset.
- id
A key field. Data type: DT_I4
- customerKey
Template: ShortText.
- objectID
Template: ShortText.
- assetType
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, displayName.
-
Uses template:
- fileProperties
Field components:
-
Uses template:
ShortText. - Contains the following components: fileName, fileSize, fileType, extension, fileCreatedDate, width, height, publishedURL.
-
Uses template:
- name
Template: ShortText.
- superContent
Template: ShortText.
- description
Template: LongText.
- owner
Template: UserT.
- createdDate
Template: DateTime. A read-only field.
- createdBy
Template: UserT.
- modifiedDate
Template: DateTime. A read-only field.
- modifiedBy
Template: UserT.
- enterpriseId
Data type: DT_I4
- memberId
Data type: DT_I4
- status
Template: IdName.
- category
Template: IdName.
- availableViews
Template: LongText. A composite field.
- modelVersion
Data type: DT_I4
- allowedBlocks
Template: LongText. A composite field.
- blocks
Field components:
- Contains the following components: header, image.
- businessUnitAvailability
Field components:
- Contains the following components: MID_001, MID_002.
- channels
Field components:
- Contains the following components: email, mobilePush, sms.
- content
Template: ShortText.
- contentType
Template: ShortText.
- customFields
Field components:
-
Uses template:
ShortText. - Contains the following components: campaign, priority.
-
Uses template:
- data
Field components:
-
Uses template:
ShortText. - Contains the following components: subject, preheader.
-
Uses template:
- design
Template: ShortText.
- generateFrom
Template: LongText.
- locked
Data type: DT_BOOL
- maxBlocks
Data type: DT_I4
- minBlocks
Data type: DT_I4
- sharingProperties
Template: SharingPropsT.
- slots
Field components:
-
Uses template:
SlotT. - Contains the following components: slot1, slot2.
-
Uses template:
- superContent
Template: ShortText.
- tags
Template: LongText. A composite field.
- template
Field components:
-
Uses template:
ShortText. - Contains the following components: templateId, templateName.
-
Uses template:
- version
Data type: DT_I4
- views
Field components:
- Contains the following components: desktop, mobile.
- data
Template: AssetCustomDataT.
- file
Template: LongText. The value is gathered from
/asset/v1/content/assets/{{=item.id}}/fileaddress.- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: restore, archive.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/asset/v1/content/categories.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=getCategories.
- [Read Single] action
-
Endpoint URL address:
/asset/v1/content/categories/{{=SFMC.UI.CategoryEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- categoryId: Required. Specify the category identifier.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=getCategory.
- [Create] action
-
Endpoint URL address:
/asset/v1/content/categories.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=createCategory.
- [Update] action
-
Endpoint URL address:
/asset/v1/content/categories/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=updateCategory.
- [Delete] action
-
Endpoint URL address:
/asset/v1/content/categories/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets?meta=deleteCategory.
- id
A key field. Data type: DT_I4
- categoryType
Template: ShortText.
- description
Template: LongText.
- enterpriseId
Data type: DT_I4
- memberId
Data type: DT_I4
- name
Template: ShortText.
- parentId
Data type: DT_I4
- sharingProperties
Field components:
-
Uses template:
LongText. - Contains the following components: sharedWith, sharingType.
-
Uses template:
Based on resource template Data.
- [Read] action
-
Endpoint URL address:
/audit/auditEvents.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- enddate: Specify the end date of the date range to search for events in ISO 8601 timestamp format.
- startdate: Specify the start date of the date range to search for events in ISO 8601 timestamp format.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_audit?meta=getAuditEvents.
- id
A key field. Data type: DT_I4
- createdDate
Template: DateTime. A read-only field.
- memberId
Data type: DT_I4
- enterpriseId
Data type: DT_I4
- employee
Template: EmployeeAuditT.
- objectType
Template: IdName.
- operation
Template: IdName.
- object
Template: IdName.
- transactionId
Template: ShortText.
Based on resource template Data.
- [Read] action
-
Endpoint URL address:
/audit/securityEvents.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- enddate: Specify the end date of the date range to search for events in ISO 8601 timestamp format.
- startdate: Specify the start date of the date range to search for events in ISO 8601 timestamp format.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_audit?meta=getSecurityEvents.
- id
A key field. Data type: DT_I4
- createdDate
Template: DateTime. A read-only field.
- memberId
Data type: DT_I4
- enterpriseId
Data type: DT_I4
- employee
Template: EmployeeAuditT.
- ipAddress
Template: ShortText.
- eventType
Template: IdName.
- loginStatus
Template: IdName.
- eventSource
Template: IdName.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automation/v1/automations.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=getAutomations.
- [Read Single] action
-
Endpoint URL address:
/automation/v1/automations/{{=SFMC.UI.AutomationEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- automationId: Required. Specify the unique identifier of the automation.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=getDataExtension.
- [Create] action
-
Endpoint URL address:
/automation/v1/automations.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=createAutomation.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- key
Template: ShortText.
- typeId
Data type: DT_I4
- type
Template: ShortText.
- statusId
Data type: DT_I4
- status
Template: ShortText.
- categoryId
Data type: DT_I4
- lastRunTime
Template: DateTime. A read-only field.
- lastRunInstanceId
Template: ShortText.
- schedule
Field components:
-
Uses template:
ShortText. - Contains the following components: scheduleStatus.
-
Uses template:
- fileTrigger
Field components:
-
Uses template:
ShortText. - Contains the following components: queueFiles, isPublished, fileNamePatternTypeId, fileNamingPattern, folderLocationText, triggerActive.
-
Uses template:
- automationTrigger
Field components:
-
Uses template:
ShortText. - Contains the following components: queueFiles, filenamePattern, filenamePatternTypeId, fileTransferLocationId, sampleFileName, status.
-
Uses template:
- steps
Field components:
- An array.
- Contains the following components: id, name, annotations, step, stepNumber, activities.
- startSource
Field components:
- Contains the following components: typeId, schedule.
- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: executeAutomationActivities.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/automation/v1/fileTransfers.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=getFileTransferActivities.
- [Read Single] action
-
Endpoint URL address:
/automation/v1/fileTransfers/{{=SFMC.UI.FileTransferEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- fileTransferActivityId: Required. Specify the unique identifier of the automation.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=getFileTransferActivity.
- [Create] action
-
Endpoint URL address:
/automation/v1/fileTransfers.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=createFileTransferActivity.
- [Update] action
-
Endpoint URL address:
/automation/v1/fileTransfers/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=updateFileTransferActivity.
- [Delete] action
-
Endpoint URL address:
/automation/v1/fileTransfers/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations?meta=deleteFileTransferActivity.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- customerKey
Template: ShortText.
- fileSpec
Template: ShortText.
- isEncrypted
Data type: DT_BOOL
- isCompressed
Data type: DT_BOOL
- maxFileAge
Data type: DT_I4
- maxFileAgeScheduleOffset
Data type: DT_I4
- maxImportFrequency
Data type: DT_I4
- publicKeyManagementId
Data type: DT_I4
- fileTransferLocationId
Template: ShortText.
- isUpload
Data type: DT_BOOL
- isPgp
Data type: DT_BOOL
- isFileSpecLocalized
Data type: DT_BOOL
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: start.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hub/v1/campaigns/.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=getCampaigns.
- [Read Single] action
-
Endpoint URL address:
/hub/v1/campaigns/{{=SFMC.UI.CampaignEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- campaignId: Required. Specify the unique identifier of the campaign.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=getCampaign.
- [Create] action
-
Endpoint URL address:
/hub/v1/campaigns/.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=createCampaign.
- [Update] action
-
Endpoint URL address:
/hub/v1/campaigns/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=updateCampaign.
- [Delete] action
-
Endpoint URL address:
/hub/v1/campaigns/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=deleteCampaign.
- id
A key field. Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- name
Template: ShortText.
- description
Template: LongText.
- campaignCode
Template: ShortText.
- color
Template: ShortText.
- favorite
Data type: DT_BOOL
- assets
The value is gathered from
/hub/v1/campaigns/{{=item.id}}/assetsaddress. The gathered value is processed with{{=response.items}}expression. Field components:- An array.
-
Uses template:
CampaignAssetT.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/campaigns/{{=SFMC.UI.CampaignEditor.getValue(parameters)}}/assets.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- campaignId: Required. Specify the unique identifier of the campaign.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=getCampaignAssets.
- [Read Single] action
-
Endpoint URL address:
/campaigns/{{=SFMC.UI.CampaignEditor.getValue(parameters)}}/assets/{{=parameters.assetId}}.The action has the following user-defined parameters:
- campaignId: Required. Specify the unique identifier of the campaign.
- assetId: Required. Specify the unique identifier of the asset.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=getCampaignAsset.
- [Create] action
-
Endpoint URL address:
/campaigns/{{=SFMC.UI.CampaignEditor.getValue(parameters)}}/assets.The action has the following user-defined parameters:
- campaignId: Required. Specify the unique identifier of the campaign.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=addAssetToCampaign.
- [Delete] action
-
Endpoint URL address:
/campaigns/{{=SFMC.UI.CampaignEditor.getValue(parameters)}}/assets/{{=item.id}}.The action has the following user-defined parameters:
- campaignId: Required. Specify the unique identifier of the campaign.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns?meta=removeAssetFromCampaign.
The resource includes the fields from the CampaignAssetT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/v1/domainverification.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_domain_verfication?meta=getDomains.
- [Create] action
-
Endpoint URL address:
/messaging/v1/domainverification.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_domain_verfication?meta=createDomain.
- [Update] action
-
Endpoint URL address:
/messaging/v1/domainverification/update.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_domain_verfication?meta=updateDomain.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/messaging/v1/domainverification/delete.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_domain_verfication?meta=deleteDomain.
-
application/json:
- enterpriseId
Data type: DT_I4
- domain
Template: ShortText.
- status
Template: ShortText.
- domainType
Template: ShortText.
- isSendable
Data type: DT_BOOL
- memberId
Data type: DT_I4
- emailSendTime
Template: ShortText.
- emailAddress
Template: ShortText.
- action
Field components:
-
Uses template:
ActionT. - Contains the following components: register, push.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/platform/v1/ens-callbacks.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/getAllCallbacks.html.
- [Read Single] action
-
Endpoint URL address:
/platform/v1/ens-callbacks/{{=SFMC.UI.CallbackEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- callbackId: Required. Specify the unique identifier of the callback.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/getCallback.html.
- [Create] action
-
Endpoint URL address:
/platform/v1/ens-callbacks.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/createCallback.html.
-
application/json:
- [Update] action
-
Endpoint URL address:
/platform/v1/ens-callbacks.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/updateCallback.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/platform/v1/ens-callbacks/{{=item.callbackId}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/deleteCallback.html.
- callbackId
Template: ShortText.
- callbackName
Template: ShortText.
- url
Template: ShortText.
- maxBatchSize
Data type: DT_I4
- status
Template: ShortText.
- statusReason
Template: ShortText.
- subscription
The value is gathered from
/platform/v1/ens-subscriptions-by-cb/{{=item.callbackId}}address. Field components:- An array.
-
Uses template:
SubscriptionT.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/platform/v1/ens-subscriptions-by-cb/{{=SFMC.UI.CallbackEditor.getValue(parameters)}}.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- callbackId: Required. Specify the unique identifier of the callback.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/getAllSubscriptionsForCallback.html.
- [Read Single] action
-
Endpoint URL address:
/platform/v1/ens-callbacks/{{=SFMC.UI.CallbackEditor.getValue(parameters)}}/{{=parameters.subscriptionId}}.The action has the following user-defined parameters:
- callbackId: Required. Specify the unique identifier of the callback.
- subscriptionId: Required. Specify the unique identifier of the subscriptions.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/getSubscription.html.
- [Create] action
-
Endpoint URL address:
/platform/v1/ens-subscriptions.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/createSubscription.html.
-
application/json:
- [Update] action
-
Endpoint URL address:
/platform/v1/ens-subscriptions.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=[item]}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/updateSubscription.html.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/platform/v1/ens-subscriptions/{{=item.subscriptionId}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification/deleteSubscription.html.
The resource includes the fields from the SubscriptionT template.
Based on resource template Data.
- [Read] action
-
Endpoint URL address:
/filetransferlocations.
The result is extracted from:{{=response.items}}.
- [Read Single] action
-
Endpoint URL address:
/filetransferlocations/{{=parameters.customerKey}}.
The result is extracted from:{{=[response.fileTransferLocation]}}.The action has the following user-defined parameters:
- customerKey: Required. Specify the customerkey of the FileTransferLocation to retrieve.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-file_transfer_locations?meta=Get%2Ba%2Bfile%2Btransfer%2Blocation.
- [Create] action
-
Endpoint URL address:
/filetransferlocations.The following request parameters will be automatically processed:
-
application/json:
{{={ fileTransferLocation: item } }}
-
application/json:
- [Update] action
-
Endpoint URL address:
/filetransferlocation/{{=item.customerKey}}.The following request parameters will be automatically processed:
-
application/json:
{{={ fileTransferLocation: item } }}
-
application/json:
- [Delete] action
-
Endpoint URL address:
/filetransferlocation/{{=item.customerKey}}.
- customerKey
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- locationType
Template: ShortText.
- awsFileTransferLocation
Field components:
-
Uses template:
ShortText. - Contains the following components: accessKeyId, roleArn, regionName, relativePath, bucketName, authType, customerKey, name, description, locationType.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/push/v1/message.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2BPush%2BMessages.
- [Read Single] action
-
Endpoint URL address:
/push/v1/message/{{=parameters.messageId}}.The action has the following user-defined parameters:
- messageId: Required. Specify the customerkey of the FileTransferLocation to retrieve.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2Ba%2BPush%2BMessage%2Bby%2BID.
- [Create] action
-
Endpoint URL address:
/push/v1/message.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Create%2Ba%2BPush%2BMessage.
- [Update] action
-
Endpoint URL address:
/push/v1/message/{{=item.id}}.
The action uses PUT method.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Update%2Ba%2BPush%2BMessage.
- [Delete] action
-
Endpoint URL address:
/push/v1/message/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Delete%2Ba%2BPush%2BMessage.
- id
A key field. Template: ShortText.
- messageType
Data type: DT_I4
- contentType
Data type: DT_I4
- messageObjectId
Template: ShortText.
- name
Template: ShortText.
- tzPastSendAction
Data type: DT_I4
- sendInitiator
Data type: DT_I4
- status
Data type: DT_I4
- activeTimes
Template: LongText. A composite field.
- createdDate
Template: DateTime. A read-only field.
- lastUpdated
Template: DateTime. A read-only field.
- alert
Template: ShortText.
- sound
Template: ShortText.
- badge
Template: ShortText.
- content-available
Data type: DT_I4
- openDirect
Template: ShortText.
- custom
Template: PushMessageCustomT.
- startDate
Template: DateTime.
- endDate
Template: DateTime.
- messagesPerPeriod
Data type: DT_I4
- minutesPerPeriod
Data type: DT_I4
- numberOfPeriods
Data type: DT_I4
- periodType
Data type: DT_I4
- isRollingPeriod
Data type: DT_BOOL
- messageLimit
Data type: DT_I4
- tzBased
Data type: DT_BOOL
- scheduledTzOffset
Data type: DT_I4
- scheduledTzSupportsDst
Data type: DT_BOOL
- inclusionLists
Template: PushMessageListFenceT.
- exclusionLists
Template: PushMessageListFenceT.
- pageId
Data type: DT_I4
- url
Template: LongText.
- geofences
Template: PushMessageListFenceT.
- subject
Template: ShortText.
- application
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- media
Field components:
-
Uses template:
LongText. - Contains the following components: iosUrl, androidUrl, alt.
-
Uses template:
- keys
Field components:
- An array.
- Contains the following components: key, value.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/push/v1/application.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2BApps.
- [Read Single] action
-
Endpoint URL address:
/push/v1/application/{{=SFMC.UI.ApplicationEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- appId: Required. Specify the unique identifier of an app that receives push messages.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2Ban%2BApp%2Bby%2BID.
- id
A key field. Template: ShortText.
- messageCategories
Field components:
- An array.
- Contains the following components: id, name, buttons.
- key
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- apnsEnabled
Data type: DT_BOOL
- gcmEnabled
Data type: DT_BOOL
- configuration
Field components:
- Contains the following components: customSound, openDirect, customKeys, payloadEditor, messageCategories.
- deviceEndpoint
Template: ShortText.
- keys
The value is gathered from
/push/v1/application/{{=item.id}}/keyaddress. Field components:-
Uses template:
LongText. - Contains the following components: keys.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/push/v1/application/{{=SFMC.UI.ApplicationEditor.getValue(parameters)}}/key.
The result is extracted from:{{={ keys: response } }}.The action has the following user-defined parameters:
- appId: Required. Specify the unique identifier of an app that receives push messages.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2BApp%2BKeys.
- [Update] action
-
Endpoint URL address:
/push/v1/application/{{=item.appId}}/key.
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=_.values(item.keys)}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Update%2BApp%2BKeys.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/push/v1/application/{{=item.appId}}/key/{{=item.key}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Delete%2Ban%2BApp%2BKey.
- key
A key field. Template: ShortText.
- keys
Template: LongText. A composite field.
- appId
A key field. Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/v1/email/seed-lists.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageReadAllSeedListsForAccount.html.
- [Read Single] action
-
Endpoint URL address:
/messaging/v1/email/seed-lists/{{=parameters.seedListId}}.The action has the following user-defined parameters:
- seedListId: Required. Specify the seed list identifier.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push?meta=Get%2Ba%2BPush%2BMessage%2Bby%2BID.
- [Create] action
-
Endpoint URL address:
/messaging/v1/email/seed-lists.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageCreateSeedList.html.
- [Update] action
-
Endpoint URL address:
/messaging/v1/email/seed-lists/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageUpdateSeedListForAccount.html.
- [Delete] action
-
Endpoint URL address:
/messaging/v1/email/seed-lists/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageUpdateSeedListForAccount.html.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- activeSeedCount
Data type: DT_I4
- seeds
Field components:
- An array.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/messaging/v1/email/seed-list-account.
The result is extracted from:{{=response.items}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageReadAccountInfoForSeedList.html.
- [Update] action
-
Endpoint URL address:
/messaging/v1/email/seed-list-account.
The action uses PUT method.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist/messageUpdateAccountInfoForSeedList.html.
- autoSeedListID
Template: ShortText.
- autoSeedThreshold
Data type: DT_I4
- autoSeedEnabled
Data type: DT_BOOL
- autoSeedListName
Template: ShortText.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/email/definitions.
The result is extracted from:{{=response.definitions}}.
- [Read Single] action
-
Endpoint URL address:
/email/definitions/{{=parameters.definitionKey}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the key of the email send definition.
- [Create] action
-
Endpoint URL address:
/email/definitions.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email?meta=Create%2Bemail%2Bsend%2Bdefinition .
- [Update] action
-
Endpoint URL address:
/email/definitions/{{=item.definitionKey}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email?meta=Update%2Bemail%2Bsend%2Bdefinition .
- [Delete] action
-
Endpoint URL address:
/email/definitions/{{=item.definitionKey}}.
- definitionKey
A key field. Template: ShortText.
- requestId
Template: ShortText.
- name
Template: ShortText.
- definitionId
Template: ShortText.
- description
Template: LongText.
- classification
Template: ShortText.
- status
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- content
Field components:
-
Uses template:
ShortText. - Contains the following components: customerKey.
-
Uses template:
- subscriptions
Field components:
-
Uses template:
ShortText. - Contains the following components: list, autoAddSubscriber, updateSubscriber.
-
Uses template:
- options
Template: OptionT. Field components:
- Contains the following components: trackLinks.
- journey
Template: LongText. A composite field.
- queueMetrics
Template: QueueMetrics. The value is gathered from
/messaging/v1/email/definitions/{{=item.definitionKey}}/queueaddress.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/email/messages.
The result is extracted from:{{=response.messages}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email?meta=Retrieve%2Bqueue%2Bmetrics .
- messageKey
A key field. Template: ShortText. The gathered value is processed with
{{=item.info.messageKey}}expression.- statusCode
Data type: DT_I4
- statusMessage
Template: ShortText.
- eventCategoryType
Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
- definitionKey
Template: ShortText.
- eventID
Data type: DT_I4
- info
Field components:
-
Uses template:
ShortText. - Contains the following components: messageKey, contactKey, to.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/messaging/v1/email/messages/{{=parameters.messageKey}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- messageKey: Required. Specify the unique key of the message to retrieve the status for.
- requestId
Template: ShortText.
- eventCategoryType
Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
- compositeId
Template: ShortText.
- info
Field components:
-
Uses template:
ShortText. - Contains the following components: messageKey, contactKey, to.
-
Uses template:
- statusCode
Data type: DT_I4
- statusMessage
Template: ShortText.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/messaging/v1/email/definitions/{{=parameters.definitionKey}}/queue.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the key of the email send definition.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email?meta=Retrieve%2Bqueue%2Bmetrics .
- [Delete] action
-
Endpoint URL address:
/messaging/v1/email/definitions/{{=item.definitionKey}}/queue.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email?meta=Delete%2Bqueue%2Bmetrics .
The resource includes the fields from the QueueMetrics template.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/push/definitions.
The result is extracted from:{{=response.definitions}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_push?meta=Get%2BPush%2BSend%2BDefinitions .
- [Read Single] action
-
Endpoint URL address:
/push/definitions/{{=parameters.definitionKey}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the user-defined key of a send definition for push messaging..
- [Create] action
-
Endpoint URL address:
/push/definitions.
- [Update] action
-
Endpoint URL address:
/push/definitions/{{=item.definitionKey}}.
- [Delete] action
-
Endpoint URL address:
/push/definitions/{{=item.definitionKey}}.
- definitionKey
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- applicationId
Template: ShortText.
- description
Template: ShortText.
- content
Field components:
-
Uses template:
ShortText. - Contains the following components: customerKey.
-
Uses template:
- options
Template: OptionT.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/ott/definitions/.
The result is extracted from:{{=response.definitions}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_ott?meta=Get%2Ball%2Bsend%2Bdefinitions .
- [Read Single] action
-
Endpoint URL address:
/ott/definitions/{{=parameters.definitionKey}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the unique identifier of the definition.
- [Create] action
-
Endpoint URL address:
/ott/definitions/.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_ott?meta=Create%2Ban%2BOTT%2Bsend%2Bdefinition .
- [Update] action
-
Endpoint URL address:
/ott/definitions/{{=item.definitionKey}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_ott?meta=Create%2Ban%2BOTT%2Bsend%2Bdefinition .
- [Delete] action
-
Endpoint URL address:
ott/definitions/{{=item.definitionKey}}.
- definitionKey
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- requestId
Template: ShortText.
- description
Template: ShortText.
- senderType
Template: ShortText.
- senderID
Template: ShortText.
- content
Field components:
-
Uses template:
ShortText. - Contains the following components: customerKey.
-
Uses template:
- options
Template: OptionT.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/sms/definitions/.
The result is extracted from:{{=response.definitions}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/getSMSDefinitions.html.
- [Read Single] action
-
Endpoint URL address:
/sms/definitions/{{=parameters.definitionKey}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the unique identifier of the send definition.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/getSMSSendDefinition.html.
- [Create] action
-
Endpoint URL address:
/sms/definitions/.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/createSMSSendDefinition.html.
- [Update] action
-
Endpoint URL address:
/sms/definitions/{{=item.definitionKey}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/updateSMSMessageDefinition.html.
- [Delete] action
-
Endpoint URL address:
sms/definitions/{{=item.definitionKey}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/deleteSMSMessageDefinition.html.
- definitionKey
A key field. Template: ShortText.
- name
Template: ShortText.
- status
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- requestId
Template: ShortText.
- description
Template: ShortText.
- senderType
Template: ShortText.
- senderID
Template: ShortText.
- content
Field components:
-
Uses template:
ShortText. - Contains the following components: customerKey.
-
Uses template:
- subscriptions
Field components:
-
Uses template:
ShortText. - Contains the following components: shortCode, countryCode, autoAddSubscriber, updateSubscriber, keyword.
-
Uses template:
- options
Field components:
- Contains the following components: urlShortenerOptions.
- smsMessageRegulatoryAuthorityTemplateId
Template: ShortText.
- queueMetrics
Template: QueueMetrics. The value is gathered from
/messaging/v1/sms/definitions/{{=item.definitionKey}}/queueaddress.
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/messaging/v1/sms/definitions/{{=parameters.definitionKey}}/queue.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- definitionKey: Required. Specify the key of the email send definition.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/getSMSQueueMetricsForDefinition.html .
- [Delete] action
-
Endpoint URL address:
/messaging/v1/sms/definitions/{{=item.definitionKey}}/queue.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/deleteSMSQueuedMessagesForDefinition.html .
The resource includes the fields from the QueueMetrics template.
Based on resource template TransactionalMessaging.
- [Read] action
-
Endpoint URL address:
/sms/messages.
The result is extracted from:{{=response.messages}}.The following request parameters will be automatically processed:
-
type:
noteSent
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms/getSMSMessagesNotSent.html.
-
type:
- messageKey
A key field. Template: ShortText. The gathered value is processed with
{{=item.info.messageKey}}expression.- statusCode
Data type: DT_I4
- statusMessage
Template: ShortText.
- eventCategoryType
Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
- definitionKey
Template: ShortText.
- eventID
Data type: DT_I4
- info
Field components:
-
Uses template:
ShortText. - Contains the following components: messageKey, contactKey, to.
-
Uses template:
Based on resource template NoPaging.
- [Read] action
-
Endpoint URL address:
/messaging/v1/sms/messages/{{=parameters.messageKey}}.
The result is extracted from:{{=[response]}}.The action has the following user-defined parameters:
- messageKey: Required. Specify the unique key of the message to retrieve the status for.
- requestId
Template: ShortText.
- eventCategoryType
Template: ShortText.
- timestamp
Template: DateTime. A read-only field.
- compositeId
Template: ShortText.
- info
Field components:
-
Uses template:
ShortText. - Contains the following components: messageKey, contactKey, to.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/hub/v1/workflowteams/{{=parameters.objectType}}.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- objectType: Required. Specify the workflow object type to retrieve or use @all to retrieve all workflow object types.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_workflowteams/workflowTeams.html.
- id
A key field. Template: ShortText.
- objectType
Template: ShortText.
- name
Template: ShortText.
- description
Template: LongText.
- roleUsers
Field components:
- An array.
- Contains the following components: id, TeamId, roleDefinitionId, roleDefinitionName, employeeId, employeeName, roleId.
Based on resource template Base.
- [Create] action
-
Endpoint URL address:
/hub/v1/workflowitems/{{=parameters.workflowItemId}}/roles/{{=parameters.workflowRoleInstanceId}}.The action has the following user-defined parameters:
- workflowItemId: Required. Specify the unique identifier of the workflow role instance.
- workflowRoleInstanceId: Required. Specify the unique identifier of the workflow item.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_workflowteams/createWorkflowTeamUser.html.
- [Delete] action
-
Endpoint URL address:
/hub/v1/workflowitems/{{=parameters.workflowItemId}}/roles/{{=parameters.workflowRoleInstanceId}}/{{=item.userId}}.The action has the following user-defined parameters:
- workflowItemId: Required. Specify the unique identifier of the workflow role instance.
- workflowRoleInstanceId: Required. Specify the unique identifier of the workflow item.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_workflowteams/deleteWorkflowTeamuser.html.
- userId
A key field. Template: ShortText.
- userName
Template: ShortText.
Based on resource template Data.
- [Read] action
-
Endpoint URL address:
/customobjects.
The result is extracted from:{{=response.items}}.The action has the following user-defined parameters:
- $search: Required. Specify a string to search for in the name of the custom object.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=getDataExtensions.
- [Read Single] action
-
Endpoint URL address:
/customobjects/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}.The action has the following user-defined parameters:
- dataExtensionId: Required. Specify the unique identifier of the data extension.
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=getDataExtension.
- [Read categoryId] action
-
Endpoint URL address:
/customobjects/category/{{=parameters.categoryId}}.
The result is extracted from:{{=response.items}}.
The result is paginated.The action has the following user-defined parameters:
- categoryId: Required. Specify the unique identifier of the data extension folder.
The following request parameters will be automatically processed:
-
$page:
{{=parameters.iterator}} -
$pagesize:
{{=parameters.batchSize}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=getDataExtensionsByCategoryId.
- [Create] action
-
Endpoint URL address:
/customobjects.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=createDataExtension.
- [Update] action
-
Endpoint URL address:
/customobjects/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=updateDataExtension.
- [Delete] action
-
Endpoint URL address:
/customobjects/{{=item.id}}.Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=deleteDataExtension.
- id
A key field. Template: ShortText.
- name
Template: ShortText.
- key
Template: ShortText.
- description
Template: LongText.
- isActive
Data type: DT_BOOL
- isSendable
Data type: DT_BOOL
- sendableCustomObjectField
Template: ShortText.
- sendableSubscriberField
Template: ShortText.
- isTestable
Data type: DT_BOOL
- categoryId
Data type: DT_I4
- ownerId
Data type: DT_I4
- isObjectDeletable
Data type: DT_BOOL
- isFieldAdditionAllowed
Data type: DT_BOOL
- isFieldModificationAllowed
Data type: DT_BOOL
- createdDate
Template: DateTime. A read-only field.
- createdById
Data type: DT_I4
- createdByName
Template: ShortText.
- modifiedDate
Template: DateTime. A read-only field.
- modifiedById
Data type: DT_I4
- modifiedByName
Template: ShortText.
- ownerName
Template: ShortText.
- partnerApiObjectTypeId
Data type: DT_I4
- partnerApiObjectTypeName
Template: ShortText.
- rowCount
Data type: DT_I4
- fieldCount
Data type: DT_I4
- dataRetentionProperties
Field components:
- Contains the following components: isDeleteAtEndOfRetentionPeriod, isRowBasedRetention, isResetRetentionPeriodOnImport, rowBasedThreshold.
- fields
The value is gathered from
/data/v1/customobjects/{{=item.id}}/fieldsaddress. The gathered value is processed with{{=response.fields}}expression. Field components:- An array.
-
Uses template:
FieldT.
- action
Template: ShortText. Field components:
-
Uses template:
NoBodyActionT. - Contains the following components: clearData.
-
Uses template:
Based on resource template Data.
- [Read] action
-
Endpoint URL address:
/customobjects/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/fields.
The result is extracted from:{{=response.fields}}.
The result is paginated.The action has the following user-defined parameters:
- dataExtensionId: Required. Specify the unique identifier of the data extension.
The following request parameters will be automatically processed:
-
$page:
{{=undefined}} -
$pagesize:
{{=undefined}} -
_includeUserParameters:
{{=parameters}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=getDataExtensionFields.
- [Create] action
-
Endpoint URL address:
/customobjectsasync/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/fields.The action has the following user-defined parameters:
- dataExtensionId: Required. Specify the unique identifier of the data extension.
The following request parameters will be automatically processed:
-
application/json:
{{={ fields: item } }}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=createDataExtensionField.
- [Update] action
-
Endpoint URL address:
/customobjectsasync/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/fields.The action has the following user-defined parameters:
- dataExtensionId: Required. Specify the unique identifier of the data extension.
The following request parameters will be automatically processed:
-
application/json:
{{={ fields: item } }}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects?meta=updateDataExtensionField.
The resource includes the fields from the FieldT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/data/v1/customobjectdata/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/rowset.
The result is extracted from:{{=_.map( response.items, function(item) { return _.extend({}, item.keys, item.values); } )}}.The action has the following user-defined parameters:
- dataExtensionId: Required. Specify the unique identifier of the data extension.
The following request parameters will be automatically processed:
-
$fields:
{{=parameters.fields.join()}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_object_data?meta=getData.
- [Upsert] action
-
Endpoint URL address:
/hub/v1/dataevents/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/rowset.
The result is extracted from:{{=undefined}}.The following request parameters will be automatically processed:
-
application/json:
{{=SFMC.upsertDataRows(resource.getFields(), batch)}}
Documentation: https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-data_extension_rows_sync?meta=upsertRowset.
-
application/json:
- [External]
-
The external fields URL address:
/data/v1/customobjects/{{=SFMC.UI.DataExtensionIdEditor.getValue(parameters)}}/fields. The external fields list is extracted from:{{=response.items}}.- {{=external.name}}
Template: {{=SFMC.getFieldTemplate(external.type)}}.
- [Read Single] action
-
The result is extracted from:{{=[response]}}.
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PATCH method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
Based on resource template NoPaging.
- [Read] action
-
The result is paginated.The following request parameters will be automatically processed:
-
$page:
{{=parameters.iterator}} -
$pagesize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
$page:
Based on resource template Base.
Based on resource template Base.
- ShortText
Data type: DT_WSTR ( length 250 )
- LongText
Data type: DT_WSTR ( length 4000 )
- DateTime
Data type: DT_DBTIMESTAMP
- Date
Data type: DT_DBDATE
- Numeric
Data type: DT_R8
- Boolean
Data type: DT_BOOL
- Number
Data type: DT_I4
- FieldT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, type, maskType, storageType, length, description, ordinal, isNullable, isPrimaryKey, isTemplateField, isInheritable, isOverridable, isHidden, isReadOnly, mustOverride.
-
Uses template:
- UserT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, email, name, userId.
-
Uses template:
- SlotT
Field components:
-
Uses template:
ShortText. - Contains the following components: type, defaultContent.
-
Uses template:
- IdName
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name.
-
Uses template:
- ViewsT
Field components:
- Contains the following components: width, height.
- DictionaryT
The gathered value is processed with
{{=_.map(value, function(v, k) { return { name: k, value: v}; })}}expression. Field components:- An array.
- Contains the following components: name, value.
- SharingPropsT
Template: DictionaryT.
- AssetCustomDataT
Template: DictionaryT.
- PushMessageCustomT
Template: DictionaryT.
- EmployeeAuditT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, employeeName, userName.
-
Uses template:
- CampaignAssetT
Field components:
-
Uses template:
ShortText. - Contains the following components: id, ids, campaignId, type, itemID, createdDate.
-
Uses template:
- SubscriptionT
Field components:
-
Uses template:
ShortText. - Contains the following components: callbackId, callbackName, url, maxBatchSize, subscriptionId, subscriptionName, eventCategoryTypes, filters, status, statusReason.
-
Uses template:
- PushMessageListFenceT
Field components:
- An array.
- QueueMetrics
Field components:
-
Uses template:
ShortText. - Contains the following components: definitionKey, requestId, count, ageSeconds.
-
Uses template:
- OptionT
Field components:
-
Uses template:
ShortText. - Contains the following components: sound, badge, customKeys.
-
Uses template:
- ActionT
- NoBodyActionT
Knowledge Base
What's New
- New: Introduced connection.
Related documentation
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.