Skip to content

[ACTION] Salesforce Marketing Cloud Engagement API #18124

@achammah

Description

@achammah

Is there a specific app this action is for?
Marketing automation - Salesforce Marketing Cloud Engagement is a comprehensive marketing automation platform used by enterprises for email marketing, customer journeys, mobile messaging, and multi-channel campaign management. Integration would benefit a LOT users managing marketing campaigns and customer communications at scale. This should be an extension or a separate implementation of existing salesforce integration

Please provide a link to the relevant API docs for the specific service / operation.

Journey Builder & Events (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_interaction):

  • Get Event Definitions (GET - /eventDefinitions)
  • Get Event Definition (GET - /eventDefinitions/key:{key} or /eventDefinitions/{id})
  • Create Event Definition (POST - /eventDefinitions)
  • Update Event Definition (PUT - /eventDefinitions/key:{key} or /eventDefinitions/{id})
  • Delete Event Definition (DELETE - /eventDefinitions/key:{key} or /eventDefinitions/{id})
  • Fire Entry Event (POST - /events)
  • Get Discovery Document (GET - /rest)
  • Get Journey by ID (GET - /interactions/{id})
  • Get Collection of Journeys (GET - /interactions)
  • Create or Save Journey (POST - /interactions)
  • Update Journey Version (PUT - /interactions)
  • Delete Journey by ID (DELETE - /interactions/{id})
  • Publish Journey Version Async (POST - /interactions/publishAsync/{id}?versionNumber={versionNumber})
  • Get Publish Status (GET - /interactions/publishStatus/{statusId})
  • Stop Journey (POST - /interactions/stop/{id}?versionNumber={versionNumber})
  • Get Journey Audit Log (GET - /interactions/{id}/audit/{action})
  • Download Journey History (POST - /interaction/journeyhistory/download)
  • Get Journey History Download Estimate (POST - /interaction/journeyhistory/estimate)
  • Get Journey History Download Freshness (GET - /interaction/journeyhistory/freshness)
  • Enter Contacts Into Journey In Batches (POST - /interaction/v1/batchcontacts)

Contacts (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_contacts):

  • Create Contact (POST - /contacts/v1/contacts)
  • Get Contact by ID (GET - /contacts/v1/contacts/{id})
  • Get Contact by Key (GET - /contacts/v1/contacts/key:{key})
  • Update Contact (PATCH - /contacts/v1/contacts)
  • Search Contacts (POST - /contacts/v1/contacts/search)
  • Search Contact Attributes (POST - /contacts/v1/attributes/search)
  • Delete Contacts by IDs (POST - /contacts/v1/contacts/actions/delete?type=ids)
  • Delete Contacts by Keys (POST - /contacts/v1/contacts/actions/delete?type=keys)
  • Delete Contacts by List (POST - /contacts/v1/contacts/actions/delete?type=listReference)
  • Delete Contacts by Data Extension (POST - /contacts/v1/contacts/actions/delete?type=dataExtensionReference)
  • Get Delete Status (GET - /contacts/v1/contacts/actions/delete/status?operationID={id})
  • Get Delete Requests (GET - /contacts/v1/contacts/analytics/deleterequests)
  • Configure Delete Settings (POST - /contacts/v1/contacts/actions/delete/configSettings)
  • Get Contact Preferences (GET - /contacts/v1/contacts/{id}/preferences)
  • Update Contact Preferences (PUT - /contacts/v1/contacts/{id}/preferences)

Assets (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_assets):

  • Get Assets (GET - /asset/v1/content/assets)
  • Get Asset by ID (GET - /asset/v1/content/assets/{id})
  • Create Asset (POST - /asset/v1/content/assets)
  • Update Asset (PATCH - /asset/v1/content/assets/{id})
  • Delete Asset (DELETE - /asset/v1/content/assets/{id})
  • Validate Asset (POST - /asset/v1/content/assets/{id}/validate)
  • Get Asset Categories (GET - /asset/v1/content/categories)
  • Create Asset Category (POST - /asset/v1/content/categories)
  • Update Asset Category (PUT - /asset/v1/content/categories/{id})
  • Delete Asset Category (DELETE - /asset/v1/content/categories/{id})
  • Get Asset File (GET - /asset/v1/content/assets/{id}/file)
  • Upload Asset File (POST - /asset/v1/content/assets/{id}/file)

Data Extensions (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_objects):

  • Get Data Extensions (GET - /data/v1/customobjects)
  • Get Data Extension by Key (GET - /data/v1/customobjects/key:{key})
  • Create Data Extension (POST - /data/v1/customobjects)
  • Update Data Extension (PUT - /data/v1/customobjects/key:{key})
  • Delete Data Extension (DELETE - /data/v1/customobjects/key:{key})
  • Get Data Extension Fields (GET - /data/v1/customobjects/key:{key}/fields)

Data Extension Data (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-custom_object_data):

  • Get Rows (GET - /data/v1/customobjectdata/key/{key}/rowset)
  • Insert Rows (POST - /data/v1/customobjectdata/key/{key}/rowset)
  • Upsert Rows (PUT - /data/v1/customobjectdata/key/{key}/rowset)
  • Delete Rows (DELETE - /data/v1/customobjectdata/key/{key}/rowset)
  • Get Row by Primary Key (GET - /data/v1/customobjectdata/key/{key}/row/{primaryKey})
  • Update Row by Primary Key (PUT - /data/v1/customobjectdata/key/{key}/row/{primaryKey})
  • Delete Row by Primary Key (DELETE - /data/v1/customobjectdata/key/{key}/row/{primaryKey})

Data Extension Rows (Asynchronous) (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-data_extension_rows_async):

  • Insert Rows Async (POST - /hub/v1/dataevents/key:{key}/rowset)
  • Upsert Rows Async (PUT - /hub/v1/dataeventsasync/key:{key}/rowset)
  • Get Async Request Status (GET - /hub/v1/dataevents/asyncRequests/{requestId})

Data Extension Rows (Synchronous) (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-data_extension_rows_sync):

  • Insert Row (POST - /hub/v1/dataevents/key:{key}/rows)
  • Get Row (GET - /hub/v1/dataevents/key:{key}/rows/{primaryKey})
  • Update Row (PUT - /hub/v1/dataevents/key:{key}/rows/{primaryKey})

Data Extension Imports (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc-import_job_api):

  • Create Import Definition (POST - /automation/v1/imports)
  • Get Import Definitions (GET - /automation/v1/imports)
  • Get Import Definition (GET - /automation/v1/imports/{id})
  • Update Import Definition (PUT - /automation/v1/imports/{id})
  • Delete Import Definition (DELETE - /automation/v1/imports/{id})
  • Start Import (POST - /automation/v1/imports/{id}/start)

Bulk Data Ingest (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_bulk_ingest):

  • Create Ingest Job (POST - /data/v1/async/dataextensions/key:{key}/rows)
  • Upload Data to Ingest Job (PUT - /data/v1/async/{requestId}/data)
  • Complete Ingest Job (POST - /data/v1/async/{requestId}/actions/complete)
  • Get Ingest Job Status (GET - /data/v1/async/{requestId}/status)
  • Get Ingest Job Results (GET - /data/v1/async/{requestId}/results)

Automation Studio (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_automation_studio_automations):

  • Get Automations (GET - /automation/v1/automations)
  • Get Automation by ID (GET - /automation/v1/automations/{id})
  • Create Automation (POST - /automation/v1/automations)
  • Update Automation (PATCH - /automation/v1/automations/{id})
  • Delete Automation (DELETE - /automation/v1/automations/{id})
  • Start Automation (POST - /automation/v1/automations/{id}/actions/start)
  • Stop Automation (POST - /automation/v1/automations/{id}/actions/stop)
  • Pause Automation (POST - /automation/v1/automations/{id}/actions/pause)
  • Resume Automation (POST - /automation/v1/automations/{id}/actions/resume)
  • Get Automation History (GET - /automation/v1/automations/{id}/history)

Campaigns (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_campaigns):

  • Get Campaigns (GET - /hub/v1/campaigns)
  • Get Campaign by ID (GET - /hub/v1/campaigns/{id})
  • Create Campaign (POST - /hub/v1/campaigns)
  • Update Campaign (PUT - /hub/v1/campaigns/{id})
  • Delete Campaign (DELETE - /hub/v1/campaigns/{id})
  • Get Campaign Assets (GET - /hub/v1/campaigns/{id}/assets)
  • Associate Asset to Campaign (POST - /hub/v1/campaigns/{id}/assets/{assetId})

Transactional Messaging - Email (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_email):

  • Create Email Send Definition (POST - /messaging/v1/email/definitions)
  • Get Email Send Definitions (GET - /messaging/v1/email/definitions)
  • Get Email Send Definition (GET - /messaging/v1/email/definitions/{definitionKey})
  • Update Email Send Definition (PATCH - /messaging/v1/email/definitions/{definitionKey})
  • Delete Email Send Definition (DELETE - /messaging/v1/email/definitions/{definitionKey})
  • Send Email to Single Recipient (POST - /messaging/v1/email/messages/{messageKey})
  • Send Email to Multiple Recipients (POST - /messaging/v1/email/messages/)
  • Get Email Send Status (GET - /messaging/v1/email/messages/{messageKey}/status)
  • Get Queue Metrics (GET - /messaging/v1/email/definitions/{definitionKey}/queue)

Transactional Messaging - SMS (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_sms):

  • Create SMS Send Definition (POST - /sms/v1/definitions)
  • Get SMS Send Definitions (GET - /sms/v1/definitions)
  • Get SMS Send Definition (GET - /sms/v1/definitions/{definitionKey})
  • Update SMS Send Definition (PATCH - /sms/v1/definitions/{definitionKey})
  • Delete SMS Send Definition (DELETE - /sms/v1/definitions/{definitionKey})
  • Send SMS to Single Recipient (POST - /sms/v1/message/send/{messageKey})
  • Send SMS to Multiple Recipients (POST - /sms/v1/message/send)
  • Get SMS Send Status (GET - /sms/v1/message/{messageKey}/status)
  • Get SMS Queue Metrics (GET - /sms/v1/definitions/{definitionKey}/queue)

Transactional Messaging - Push (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_push):

  • Create Push Send Definition (POST - /push/v1/definitions)
  • Get Push Send Definitions (GET - /push/v1/definitions)
  • Get Push Send Definition (GET - /push/v1/definitions/{definitionKey})
  • Update Push Send Definition (PATCH - /push/v1/definitions/{definitionKey})
  • Delete Push Send Definition (DELETE - /push/v1/definitions/{definitionKey})
  • Send Push to Single Recipient (POST - /push/v1/message/send/{messageKey})
  • Send Push to Multiple Recipients (POST - /push/v1/message/send)
  • Get Push Send Status (GET - /push/v1/message/{messageKey}/status)

Transactional Messaging - OTT (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_transactional_messaging_ott):

  • Create OTT Send Definition (POST - /ott/v1/definitions)
  • Get OTT Send Definitions (GET - /ott/v1/definitions)
  • Get OTT Send Definition (GET - /ott/v1/definitions/{definitionKey})
  • Update OTT Send Definition (PATCH - /ott/v1/definitions/{definitionKey})
  • Delete OTT Send Definition (DELETE - /ott/v1/definitions/{definitionKey})
  • Send OTT Message (POST - /ott/v1/message/send)

SMS (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_sms):

  • Send SMS Message (POST - /sms/v1/messageContact/{messageId}/send)
  • Create SMS Message (POST - /sms/v1/message)
  • Get SMS Messages (GET - /sms/v1/message)
  • Get SMS Message (GET - /sms/v1/message/{messageId})
  • Update SMS Message (PUT - /sms/v1/message/{messageId})
  • Delete SMS Message (DELETE - /sms/v1/message/{messageId})
  • Get SMS Deliveries (GET - /sms/v1/message/{messageKey}/deliveries)

Push (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_push):

  • Create Push Message (POST - /push/v1/message)
  • Get Push Messages (GET - /push/v1/message)
  • Get Push Message (GET - /push/v1/message/{messageId})
  • Update Push Message (PUT - /push/v1/message/{messageId})
  • Delete Push Message (DELETE - /push/v1/message/{messageId})
  • Send Push Message (POST - /push/v1/messageContact/{messageId}/send)
  • Get Push Application (GET - /push/v1/application/{applicationId})
  • Create Push Application (POST - /push/v1/application)

Chat Messaging (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_chat_messaging):

  • Register OTT Platform (POST - /ott/v1/registration)
  • Get OTT Registrations (GET - /ott/v1/registration)
  • Get OTT Registration (GET - /ott/v1/registration/{id})
  • Update OTT Registration (PUT - /ott/v1/registration/{id})
  • Delete OTT Registration (DELETE - /ott/v1/registration/{id})
  • Send OTT Message (POST - /ott/v1/send)

Messaging (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_messaging):

  • Send Triggered Message (POST - /messaging/v1/messageDefinitionSends/key:{key}/send)
  • Send Triggered Message Async (POST - /messaging/v1/messageDefinitionSends/key:{key}/sendAsync)
  • Get Send Status (GET - /messaging/v1/messageDefinitionSends/{sendId}/status)
  • Get Delivery Records (GET - /messaging/v1/messageDefinitionSends/key:{key}/deliveryrecords)
  • Pause Message Send (POST - /messaging/v1/messageDefinitionSends/pause)
  • Resume Message Send (POST - /messaging/v1/messageDefinitionSends/resume)

Event Notification (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_event_notification):

  • Create Subscription (POST - /platform/v1/ens-subscriptions)
  • Get Subscriptions (GET - /platform/v1/ens-subscriptions)
  • Get Subscription (GET - /platform/v1/ens-subscriptions/{subscriptionId})
  • Update Subscription (PUT - /platform/v1/ens-subscriptions/{subscriptionId})
  • Delete Subscription (DELETE - /platform/v1/ens-subscriptions/{subscriptionId})
  • Verify Callback (POST - /platform/v1/ens-verify)
  • Get Event Types (GET - /platform/v1/ens-event-types)

Approvals (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_approvals):

  • Get Approval Items (GET - /workflows/v1/approval-items)
  • Get Approval Item (GET - /workflows/v1/approval-items/{id})
  • Submit for Approval (POST - /workflows/v1/approval-items)
  • Approve Item (POST - /workflows/v1/approval-items/{id}/approve)
  • Reject Item (POST - /workflows/v1/approval-items/{id}/reject)
  • Recall Approval (POST - /workflows/v1/approval-items/{id}/recall)

Audits (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_audit):

  • Get Audit Events (GET - /audit/v1/audits)
  • Get Audit Event by ID (GET - /audit/v1/audits/{id})
  • Get Audit Event Types (GET - /audit/v1/audits/types)
  • Export Audit Events (POST - /audit/v1/audits/export)

Auth (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_auth):

  • Request Access Token v2 (POST - /v2/token)
  • Request Access Token v1 (POST - /v1/requestToken)
  • Revoke Token (POST - /v2/revoke)
  • Get Token Info (GET - /v2/tokeninfo)

Address (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_address):

  • Validate Address (POST - /address/v1/validate)
  • Validate Multiple Addresses (POST - /address/v1/validateBatch)
  • Get Address Suggestions (GET - /address/v1/suggestions)

Domain Verification (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_domain_verfication):

  • Get Verified Domains (GET - /messaging/v1/domainverification)
  • Initiate Domain Verification (POST - /messaging/v1/domainverification/initiate)
  • Verify Domain (POST - /messaging/v1/domainverification/verify)
  • Delete Verified Domain (DELETE - /messaging/v1/domainverification/{domain})

File Transfer Locations (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_file_transfer_locations):

  • Get File Locations (GET - /platform/v1/filelocations)
  • Get File Location (GET - /platform/v1/filelocations/{id})
  • Create File Location (POST - /platform/v1/filelocations)
  • Update File Location (PUT - /platform/v1/filelocations/{id})
  • Delete File Location (DELETE - /platform/v1/filelocations/{id})

Nested Tags (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_objects):

  • Get Tags (GET - /hub/v1/tags)
  • Get Tag (GET - /hub/v1/tags/{id})
  • Create Tag (POST - /hub/v1/tags)
  • Update Tag (PUT - /hub/v1/tags/{id})
  • Delete Tag (DELETE - /hub/v1/tags/{id})

Platform (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_platform):

  • Get Account Info (GET - /platform/v1/accounts/{accountId})
  • Get Business Units (GET - /platform/v1/businessunits)
  • Get Business Unit (GET - /platform/v1/businessunits/{id})
  • Get User Info (GET - /platform/v1/accounts/{accountId}/users)
  • Get Roles (GET - /platform/v1/roles)
  • Get Permissions (GET - /platform/v1/permissions)

Security (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_security):

  • Get Security Settings (GET - /platform/v1/security)
  • Update Security Settings (PUT - /platform/v1/security)
  • Get IP Allowlist (GET - /platform/v1/security/ipallowlist)
  • Add IP to Allowlist (POST - /platform/v1/security/ipallowlist)
  • Remove IP from Allowlist (DELETE - /platform/v1/security/ipallowlist/{ip})

Seed List (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_seedlist):

  • Get Seed Lists (GET - /messaging/v1/seedlists)
  • Get Seed List (GET - /messaging/v1/seedlists/{id})
  • Create Seed List (POST - /messaging/v1/seedlists)
  • Update Seed List (PUT - /messaging/v1/seedlists/{id})
  • Delete Seed List (DELETE - /messaging/v1/seedlists/{id})

Workflow Teams (https://developer.salesforce.com/docs/marketing/marketing-cloud/references/mc_rest_workflowteams):

  • Get Teams (GET - /workflows/v1/teams)
  • Get Team (GET - /workflows/v1/teams/{id})
  • Create Team (POST - /workflows/v1/teams)
  • Update Team (PUT - /workflows/v1/teams/{id})
  • Delete Team (DELETE - /workflows/v1/teams/{id})
  • Add Team Member (POST - /workflows/v1/teams/{id}/members)
  • Remove Team Member (DELETE - /workflows/v1/teams/{id}/members/{memberId})

Metadata

Metadata

Assignees

No one assigned

    Labels

    actionNew Action RequestenhancementNew feature or requestgood first issueGood for newcomershelp wantedExtra attention is neededtriagedFor maintainers: This issue has been triaged by a Pipedream employee

    Type

    No type

    Projects

    Status

    Prioritized

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions