Connectors

Marketing & Customer Engagement

Marketing Cloud

Salesforce Marketing Cloud: contacts, journeys, email, SMS, push, and automations

Signs in with: OAuth 2.0 sign-in
Runs on: Cloud or On-Prem Worker
Operations: 308
Ready-made triggers: 0

Connect Marketing Cloud

In Neblex open Connect › Connections and click New Connection.
Search for Marketing Cloud and give the connection a clear name.
Fill in the fields. Secret values are encrypted and never shown again.
Click Test, then Create Connection.

For services offered under Connect a Service you only sign in and approve access. Otherwise use Connect with OAuth2 with your own OAuth app. See Authorize with OAuth.

Field	What to enter
SubdomainRequired	The tenant subdomain of your REST and Authentication Base URIs: the part before .rest.marketingcloudapis.com.
Token endpointRequired	Your Authentication Base URI followed by v2/token, for example https://YOUR_SUBDOMAIN.auth.marketingcloudapis.com/v2/token.
Client IDRequired	Client ID of the server-to-server API integration in Installed Packages.
Client secretRequiredSecret	Client secret of the API integration.
ScopeOptional	Optional space-separated scopes to request; empty requests every scope the integration has.
Business unitOptional	Optional token request settings.
Token requestRequired	Marketing Cloud takes the client credentials in a JSON token request body.

Use it in a flow

Open a flow, open the node library and search for Marketing Cloud.
Drag it onto the canvas and choose an Operation and your connection.
Map the operation's fields from earlier steps, or click Map with Matt.
Use Test this step to see what it returns, then save.

To start a flow from Marketing Cloud without a ready-made trigger: a Poll for changes trigger can check one of its list operations on a schedule and pass on only what is new; if Marketing Cloud can send webhooks, a Webhook trigger receives them at its own URL.

Operations

308 operations in 30 groups. Each one is a step you can add to a flow.

Address1

Validates an email addressvalidateEmail POST Processes an email address through one or more validators.

Approvals7

Creates an approval item and an associated a workflow item. The response includes details of the approval and workflow`createApprovalItem`	POST	Creates an approval item and an associated a workflow item.
GET /hub/v1/approvals-v2/settings`getApprovalSettings`	GET	GET /hub/v1/approvals-v2/settings
GET /hub/v1/approvals-v2/{id}/roles`getApprovalRoles`	GET	GET /hub/v1/approvals-v2/{id}/roles
Modifies the name, description, and deadline of an existing approval item. The response contains details`modifyApprovalItem`	PATCH	Modifies the name, description, and deadline of an existing approval item.
PATCH /hub/v1/approvals-v2/settings`updateApprovalSettings`	PATCH	PATCH /hub/v1/approvals-v2/settings
Retrieves all approval items that belong to the current user. To filter the results, use the request parameters`getApprovalItems`	GET	Retrieves all approval items that belong to the current user.
Retrieves an approval item that belongs to the current user. The response includes details of the approval and workflow`getApprovalItem`	GET	Retrieves an approval item that belongs to the current user.

Assets18

Archive an asset`archiveAsset`	PATCH	Archive an asset.
Create asset`createAsset`	POST	Creates a new asset.
Create category`createCategory`	POST	Creates a category in Content Builder.
Delete an asset`deleteAsset`	DELETE	Deletes an asset.
Delete category`deleteCategory`	DELETE	Deletes a Content Builder category.
Get asset by ID`getAsset`	GET	Retrieves an asset by its ID.
Get asset file`getFile`	GET	Gets the binary file for an asset.
Get assets by advanced query`getAssetsAdvancedQuery`	POST	Use an advanced query to retrieve a collection of assets.
Get assets by simple filter`getAssetsSimpleQuery`	GET	Retrieve a collection of assets by applying basic filters and sorting rules.
Get categories`getCategories`	GET	Returns one or more Content Builder categories that are owned by or reside in your MID.
Get category by ID`getCategory`	GET	Returns one Content Builder category by ID.
Get channel view`getChannelView`	GET	Returns the compiled HTML for a requested channel view of an asset.
Get default salutations`getSalutations`	GET	Retrieves the default header and footer for an account.
Get email salutations`getHeaderAndFooter`	GET	Retrieves the header and footer of an email asset by specifying the asset ID.
Patch an asset`patchAsset`	PATCH	Modify the properties of an asset deleted in the last 30 days.
Restore asset`restoreAsset`	PATCH	Restore an asset hidden by a prior archive operation, and make it available again for queries, triggered sends, journeys, and other operations.
Update an asset`updateAsset`	PUT	Modify the properties of an existing asset.
Update category`updateCategory`	PUT	Updates a Content Builder category.

Audits2

GET /data/v1/audit/auditEvents`getAuditEvents`	GET	Retrieve logged Audit Trail audit events for the current account and its child accounts.
GET /data/v1/audit/securityEvents`getSecurityEvents`	GET	Retrieve logged Audit Trail security events for the current account and its children.

Auth2

Get base URLs`getBaseUrls`	GET	Obtain the base URLs for the Marketing Cloud Auth and REST APIs.
Get user information`getUserInfo`	GET	Retrieves information about the account and user that are associated with the access token.

Automation Studio20

Activate or deactivate an automation file trigger by providing its ID`updateAutomationFileTrigger`	PATCH	Required Scopes
Activate or deactivate an automation file trigger by providing its key`updateAutomationFileTriggerByKey`	PATCH	Required Scopes
Activate or Deactivate an Automation Trigger`updateAutomationTrigger`	PATCH	Required scopes
Add a file transfer activity to the queue for processing`startFileTransferActivity`	POST	Add a file transfer activity to the queue for processing.
Check the status for a specified Trigger API requestID`getTriggerStatus`	GET	Note To see the automation details, make sure that the request's file details meet the criteria for exactly one automation trigger configuration.
Create a file transfer activity`createFileTransferActivity`	POST	Create a file transfer activity.
Create an automation using existing Automation Studio activities`createAutomation`	POST	Required Scopes
Delete a specific file transfer activity by providing its ID`deleteFileTransferActivity`	DELETE	Delete a specific file transfer activity by providing its ID.
Retrieve a list of all automations in the account`getAutomations`	GET	Required Scopes
Retrieve a list of all file transfer activities in the account`getFileTransferActivities`	GET	Retrieve a list of all file transfer activities in the account.
Retrieve a list of all folders in the account`getAutomationFolders`	GET	Required Scopes
Retrieve a list of all FTP locations in the account`getFtpLocations`	GET	Required Scopes
Retrieve a list of automation script activities`getAutomationScriptActivities`	GET	Required Scopes
Retrieve a specific automation by providing its ID`getAutomation`	GET	Required Scopes
Retrieve a specific file transfer activity by providing its ID`getFileTransferActivity`	GET	Retrieve a specific file transfer activity by providing its ID.
Run a script activity one time`executeScriptActivity`	POST	Required Scopes
Run all activities in an automation one time by specifying its external key`executeAutomationActivitiesByKey`	POST	Required Scopes
Run all activities in an automation one time by specifying its ID`executeAutomationActivities`	POST	Required Scopes
Start an automation that uses a trigger start source`executeTriggeredAutomation`	POST	When you upload a file, the Trigger API request passes the file details for Automation Studio to evaluate.
Update a file transfer activity by providing its ID`updateFileTransferActivity`	PATCH	Update a file transfer activity by providing its ID.

Bulk Data Ingest9

Complete data staging for a bulk data ingest job`completeDataStaging`	POST	Required Scopes
Create a bulk data ingestion job`createBulkIngestJob`	POST	Create a bulk data ingestion job.
Delete the job definition of a bulk data ingest job`deleteBulkIngestJobDefinition`	DELETE	Deletes an active bulk data ingest job.
Get a summary for a completed bulk data ingestion job`getBulkDataIngestJobSummary`	GET	View a summary of a completed bulk data ingest job.
Get the job definition of a bulk data ingest job`getBulkIngestJobDefinition`	GET	Get the job definition of a bulk data ingest job.
Get the validation results of a bulk data ingest job`getBulkDataIngestJobValidationResults`	GET	Get the validation results for a completed bulk data ingest job.
Get the validation summary of a bulk data ingest job`getBulkDataIngestJobValidationSummary`	GET	Get a validation summary for a completed bulk data ingest job.
Stage data for a bulk data ingest job`stageDataForBulkIngestJob`	PUT	Stage data to import in a bulk job.
Update the job definition of an existing bulk data ingest job`updateBulkIngestJobDefinition`	PATCH	Update the job definition of a bulk data ingest job.

Campaigns9

Associate an asset with a campaign`addAssetToCampaign`	POST	Required permission scope: Campaign Write
Create a campaign`createCampaign`	POST	Required permission scope: Campaign Write
Delete a campaign`deleteCampaign`	DELETE	Required permission scope: Campaign Write
Remove an association between an asset and a campaign`removeAssetFromCampaign`	DELETE	Required permission scope: Campaign Write
Retrieve a list of assets that are associated with a campaign`getCampaignAssets`	GET	Required permission scope: Campaign Read
Retrieve a list of campaigns in your account`getCampaigns`	GET	Required permission scope: Campaign Read
Retrieve information about a single campaign`getCampaign`	GET	Required permission scope: Campaign Read
Retrieve information about a specific asset that is associated with a campaign`getCampaignAsset`	GET	Required permission scope: Campaign Read
Update a campaign`updateCampaign`	PATCH	Required permission scope: Campaign Write

Chat Messaging5

GET /ott/v1/registration/{platform}`ottRetrieveRegistrationCollection`	GET	GET /ott/v1/registration/{platform}
GET /ott/v1/registration/{platform}/{ottPropertyId}`ottRetrieveRegistrationProperty`	GET	GET /ott/v1/registration/{platform}/{ottPropertyId}
GET /ott/v1/send/{messageId}`ottRetrieveSentMessage`	GET	GET /ott/v1/send/{messageId}
Register a property for a specific OTT platform. If you try to register an existing Messenger Page ID or LINE Channel`ottRegisterProperty`	POST	Register a property for a specific OTT platform.
Send an OTT message to the recipient. Supported OTT networks are Facebook Messenger and LINE`ottSendMessageToRecipient`	POST	Send an OTT message to the recipient.

Contacts40

Data Extension Data3

Retrieve data from a data extension by providing its external key`getDataByKey`	GET	Retrieve data from a data extension by providing its external key.
Retrieve data from a data extension by providing its ID`getData`	GET	Retrieve data from a data extension by providing its ID.
Retrieve data from a data extension by providing the request token. The $filter, $pagesize, $top, $fields, and $orderby`getDataByRequestToken`	GET	Retrieve data from a data extension by providing the request token.

Data Extension Imports4

Get import row-level validation details by ID`getValidationDetailsOfAOneTimeDataImport`	GET	Returns details of row-level validation errors that occurred during an import.
Queue and start a one-time import into a data extension without creating an import definition`queueAndStartAOneTimeDataImport`	POST	Perform a file-based import without creating an import definition.
Retrieve a list of row-level validation errors that occurred during an import. Use this method after an import finishes`getValidationSummaryForADataImport`	GET	Retrieve a list of row-level validation errors that occurred during an import.
Returns the status of a queued data import, including the final number of imported rows and the import status (Success`getStatusOfAOneTimeDataImport`	GET	Returns the status of a queued data import, including the final number of imported rows and the import status (Success or Error).

Data Extension Rows (Asynchronous)4

Add rows to a data extension asynchronously`insertRows`	POST	For information about the limits that apply to this API, see Salesforce Help : Limits and Guidelines.
Asynchronously update rows in a data extension if the primary key exists, or create rows if the primary key doesn't`upsertRows`	PUT	For information about the limits that apply to this API, see Salesforce Help : Limits and Guidelines.
Retrieve the results of a request to asynchronously insert rows into a data extension`getRequestResults`	GET	For information about the limits that apply to this API, see Salesforce Help : Limits and Guidelines.
Retrieve the status of a request to asynchronously insert rows into a data extension`getRequestStatus`	GET	For information about the limits that apply to this API, see Salesforce Help : Limits and Guidelines.

Data Extension Rows (Synchronous)6

Increase or decrease the value of a data extension column synchronously. For example, you can use this operation`incrementColumnValue`	PUT	Increase or decrease the value of a data extension column synchronously.
Increase or decrease the value of a data extension column synchronously. For example, you can use this operation`incrementColumnValueByKey`	PUT	Increase or decrease the value of a data extension column synchronously.
Upsert one or more rows in a data extension synchronously by specifying the external key of the target data extension`upsertRowsetByKey`	POST	Upsert one or more rows in a data extension synchronously by specifying the external key of the target data extension.
Upsert one or more rows in a data extension synchronously by specifying the ID of the target data extension`upsertRowset`	POST	Upsert one or more rows in a data extension synchronously by specifying the ID of the target data extension.
Upsert one row in a data extension synchronously by specifying the external key of the target data extension`upsertRowByKey`	PUT	The API doesn't accept URLs that contain more than 260 characters.
Upsert one row in a data extension synchronously by specifying the ID of the target data extension`upsertRow`	PUT	Specify the primary key and value in the URL path.

Data Extensions10

Creates a data extension`createDataExtension`	POST	Required Scopes
Deletes a data extension`deleteDataExtension`	DELETE	Required Scopes
Deletes all of the data in a data extension`clearDataExtensionData`	POST	Required Scopes
Inserts a new field into a data extension`createDataExtensionField`	POST	Required Scopes
Retrieves a list of data extensions based on the ID of the parent category`getDataExtensionsByCategoryId`	GET	Required Scopes
Retrieves a list of data extensions that match a search string`getDataExtensions`	GET	Required Scopes
Retrieves a list of fields in a data extension`getDataExtensionFields`	GET	Required Scopes
Retrieves information about the specified data extension by providing its ID`getDataExtension`	GET	Required Scopes
Update the fields in a data extension`updateDataExtension`	PATCH	Required Scopes
Updates a field in a data extension`updateDataExtensionField`	PATCH	Required Permission Scope

Domain Verification8

Create a domain`createDomain`	POST	Creates an email or domain record.
Create domains in bulk`createDomainsBulk`	POST	Creates multiple sender email address records.
Delete an address or domain`deleteDomain`	POST	Deletes an email address or domain record.
Get domains`getDomains`	GET	Retrieves a list of email addresses and domains that can be used to send email from a Marketing Cloud Engagement account.
Push registered domains to other business units`pushRegisteredDomains`	POST	Makes one or more registered domains available in other business units (BUs) that share an Enterprise ID (EID).
Register an email domain`registerDomain`	POST	Registers a new domain to use for sending email.
Retrieve a domain verification token`retrieveDomainVerificationToken`	POST	Retrieves a verification token for a domain.
Update an address or domain`updateDomain`	POST	Updates the status of the IsSendable field for an email address or domain record.

Event Notification12

Creates a single subscription. A subscription indicates which event types to receive notifications for and which`createSubscription`	POST	Creates a single subscription.
DELETE /platform/v1/ens-callbacks/{callbackId}`deleteCallback`	DELETE	DELETE /platform/v1/ens-callbacks/{callbackId}
DELETE /platform/v1/ens-subscriptions/{subscriptionId}`deleteSubscription`	DELETE	DELETE /platform/v1/ens-subscriptions/{subscriptionId}
GET /platform/v1/ens-callbacks/{callbackId}`getCallback`	GET	GET /platform/v1/ens-callbacks/{callbackId}
GET /platform/v1/ens-subscriptions-by-cb/{callbackId}`getAllSubscriptionsForCallback`	GET	GET /platform/v1/ens-subscriptions-by-cb/{callbackId}
GET /platform/v1/ens-subscriptions/{subscriptionId}`getSubscription`	GET	GET /platform/v1/ens-subscriptions/{subscriptionId}
PUT /platform/v1/ens-callbacks`updateCallback`	PUT	PUT /platform/v1/ens-callbacks
PUT /platform/v1/ens-subscriptions`updateSubscription`	PUT	PUT /platform/v1/ens-subscriptions
Regenerates a signature key for a given callback. Regenerating a signature key deactivates the existing key`regenerateSignatureKey`	PUT	Regenerates a signature key for a given callback.
Registers a new callback to receive event notifications. You must register and verify your callback before you use it`createCallback`	POST	Registers a new callback to receive event notifications.
Retrieves details about all registered callbacks`getAllCallbacks`	GET	Retrieves details about all registered callbacks.
Verifies a callback so that it can receive notifications`verifyCallback`	POST	Verifies a callback so that it can receive notifications.

File Transfer Locations6

Create a new File Transfer Location in your account`createAFileTransferLocation`	POST	This method creates a new file location.
Deactivate a file transfer location identified by customerKey`deleteAFileTransferLocation`	DELETE	This method deactivates a file location based on a given customer key.
Get a file transfer location identified by customerKey`getAFileTransferLocation`	GET	This method returns a single file location for the given customer key.
Get all file transfer locations for the current MID`getAllFileTransferLocations`	GET	This method returns one or more file locations that are owned by, or reside under your member identification code (MID).
Update a file transfer location identified by customerKey`updateAFileTransferLocation`	PATCH	This method updates a file location based on a given customer key.
Validate a file transfer location schema passed in request body`validateAFileTransferLocation`	POST	This method validates a file location.

Journeys and Events28

Messaging2

GET /messaging/v1/messageDefinitionSends/key:{key}/deliveryRecords`messageDefinitionSendsDeliveryRecords`	GET	GET /messaging/v1/messageDefinitionSends/key:{key}/deliveryRecords
POST /messaging/v1/messageDefinitionSends/{triggeredSendDefinitionId}/send`messageDefinitionSends`	POST	POST /messaging/v1/messageDefinitionSends/{triggeredSendDefinitionId}/send

Nested Tags8

Add tags to objects to help identify and categorize them. An object can have multiple tags, and a tag can be associated`createTags`	POST	Add tags to objects to help identify and categorize them.
Creates a tag that can be associated with any object that accepts tagging. The tag must contain a unique name. The tag`createNestedTags`	POST	Creates a tag that can be associated with any object that accepts tagging.
DELETE /hub/v1/nestedtags/{tagId}`deleteNestedTags`	DELETE	DELETE /hub/v1/nestedtags/{tagId}
GET /hub/v1/nestedtags`getNestedTags`	GET	GET /hub/v1/nestedtags
GET /hub/v1/nestedtags/{tagId}`getNestedTagById`	GET	GET /hub/v1/nestedtags/{tagId}
PUT /hub/v1/nestedtags/{tagId}`updateNestedTags`	PUT	PUT /hub/v1/nestedtags/{tagId}
Updates an existing tag. Provide only the tag fields to be changed`patchNestedTags`	PATCH	Updates an existing tag.
Use this resource to delete multiple tag associations at one time`deleteTags`	POST	Use this resource to delete multiple tag associations at one time.

Platform11

Creates or imports an encryption key. To create a key, the data at rest encryption feature must be enabled`createAnEncryptionKey`	POST	Creates or imports an encryption key.
Deletes an encryption key`deleteAnEncryptionKey`	DELETE	Deletes an encryption key.
Queue the rotation of an encryption key`rotateAnEncryptionKey`	PUT	Queue the rotation of an encryption key.
Retrieve a list of endpoints for Marketing Cloud Engagement services, such as the authentication, REST API, SOAP API`getEndpoints`	GET	Retrieve a list of endpoints for Marketing Cloud Engagement services, such as the authentication, REST API, SOAP API, and FTP servers.
Retrieve all of the encryption keys associated with an account. To retrieve this data, the data at rest encryption`getEncryptionKeys`	GET	Retrieve all of the encryption keys associated with an account.
Retrieve an endpoint URL for a specific service, such as REST or SOAP API`getEndpoint`	GET	Retrieve an endpoint URL for a specific service, such as REST or SOAP API.
Retrieve an existing encryption key by providing its ID`retrieveAnEncryptionKeyById`	GET	Retrieve an existing encryption key by providing its ID.
Retrieve and create an RSA 4096 wrapping key`getAWrappingKey`	GET	This feature isn't enabled by default.
Retrieve information about settings that apply to your account`getAccountSettings`	GET	Retrieves the status of the Einstein Data Pooling business rule in Marketing Cloud Engagement.
Retrieves information about the key types and key lengths that your account supports. To retrieve this information,`getKeyTypes`	GET	Retrieves information about the key types and key lengths that your account supports.
Returns information about an authentication token`getAuthenticationTokenInformation`	GET	Returns information about an authentication token.

Push27

Security4

Delete HTTP Security Headers`deleteHttpSecurityHeaders`	DELETE	Delete HTTP Security Headers
Get All HTTP Security Headers`getAllHttpSecurityHeaders`	GET	Get All HTTP Security Headers
Get HTTP Security Headers`getHttpSecurityHeaders`	GET	Get HTTP Security Headers
Update HTTP Security Headers`updateHttpSecurityHeaders`	POST	Update HTTP Security Headers

SMS21

Transactional Messaging - Email11

Create a long-living send definition object that references the email template, subscriber list, sending options`createEmailSendDefinition`	POST	A send definition is referenced in the transactional messaging API when you send a triggered message to recipients.
Delete an email send definition by specifying its key`deleteEmailSendDefinitionByKey`	DELETE	Delete an email send definition by specifying its key.
Deletes the queue for a send definition`deleteQueueMetrics`	DELETE	Deletes the queue for a send definition.
Get a list of all email send definitions. You can filter and sort the results by including query parameters`retrieveAllEmailSendDefinitions`	GET	Get a list of all email send definitions.
Get the content of an email send definition by specifying its key`retrieveEmailSendDefinitionByKey`	GET	Get the content of an email send definition by specifying its key.
Get the queue metrics for an email send definition by specifying its key`retrieveQueueMetrics`	GET	Get the queue metrics for an email send definition by specifying its key.
Gets a paginated list of messages that weren't sent, ordered from oldest to newest`retrieveUnsentMessages`	GET	Gets a paginated list of messages that weren't sent, ordered from oldest to newest.
Retrieves the send status for an email`retrieveStatusOfAnEmailMessage`	GET	Requests to this endpoint are rate-limited.
Send an email to a single recipient by specifying a message key`sendEmailMessageToASingleRecipient`	POST	Send an email to a single recipient by specifying a message key.
Send an email to multiple recipients by specifying a send definition. You can send messages to up to 2,000 recipients`sendEmailMessageToMultipleRecipients`	POST	Send an email to multiple recipients by specifying a send definition.
Update an email send definition by specifying its key`updateEmailSendDefinition`	PATCH	Update an email send definition by specifying its key.

Transactional Messaging - OTT8

Create an OTT send definition used to make final message sends`createAnOttSendDefinition`	POST	Create an OTT send definition used to make final message sends.
Delete a message definition. You can't restore a deleted definition. The deleted definition is archived, and a delete`deleteAnOttSendDefinitionByKey`	DELETE	Delete a message definition.
Download rich media inbound messages`downloadRichMediaInboundMessages`	GET	Download rich media inbound messages using the media 'id' received in the ENS notification.
Get a list of OTT send definitions. The number of records that the method returns is based on the $pageSize and $page`getAllSendDefinitions`	GET	Get a list of OTT send definitions.
Get message send status for a recipient`getMessageSendStatusForRecipient`	GET	This method returns the send status for a message.
Retrieve the send definition configuration details for a definition key`getSendDefinitionByDefinitionKey`	GET	Retrieve the send definition configuration details for a definition key.
Send a message to multiple recipients using a send definition`sendMessageToMultipleRecipients`	POST	You can provide a messageKey in the request; otherwise, the messageKey is automatically generated in the response.
Update an OTT send definition using the definition key. You can update only the status of the send definition`updateAnOttSendDefinition`	PATCH	Update an OTT send definition using the definition key.

Transactional Messaging - Push7

Create a transactional push send definition`createAPushSendDefinition`	POST	Required Permission Scope
Delete a transactional push send definition`deleteAPushSendDefinition`	DELETE	Required Permission Scope
Retrieve a list of transactional push send definitions in your account`getPushSendDefinitions`	GET	Required Permission Scope
Retrieve details of a transactional push send definition`getPushSendDefinitionDetails`	GET	Required Permission Scope
Retrieve the status of a transactional push notification`getTransactionalPushNotificationStatus`	GET	Required Permission Scope
Send a transactional push notification to one or more subscribers or devices`sendATransactionalPushNotification`	POST	Required Permission Scope
Update a transactional push send definition`updateAPushSendDefinition`	PATCH	Required Permission Scope

Transactional Messaging - SMS11

Creates an SMS send definition`createSMSSendDefinition`	POST	Creates an SMS send definition.
DELETE /messaging/v1/sms/definitions/{definitionKey}`deleteSMSMessageDefinition`	DELETE	DELETE /messaging/v1/sms/definitions/{definitionKey}
Deletes the queue for a send definition. The send definition must be inactive`deleteSMSQueuedMessagesForDefinition`	DELETE	Deletes the queue for a send definition.
GET /messaging/v1/sms/definitions`getSMSDefinitions`	GET	GET /messaging/v1/sms/definitions
Gets a paginated list of messages that weren't sent, ordered from oldest to newest`getSMSMessagesNotSent`	GET	Gets a paginated list of messages that weren't sent, ordered from oldest to newest.
PATCH /messaging/v1/sms/definitions/{definitionKey}`updateSMSMessageDefinition`	PATCH	PATCH /messaging/v1/sms/definitions/{definitionKey}
Retrieves metrics for the messages associated with a send definition, including messages that haven't been processed`getSMSQueueMetricsForDefinition`	GET	Retrieves metrics for the messages associated with a send definition, including messages that haven't been processed yet.
Retrieves the send definition configuration details for a definition key`getSMSSendDefinition`	GET	Retrieves the send definition configuration details for a definition key.
Retrieves the send status for an SMS message`getSMSSendStatusForRecipient`	GET	Retrieves the send status for an SMS message.
Sends a message to a single recipient using a send definition`sendSMSMessageSingleRecipient`	POST	Sends a message to a single recipient using a send definition.
Sends an SMS message to multiple recipients using a send definition`sendSMSMessageMultipleRecipients`	POST	Sends an SMS message to multiple recipients using a send definition.

Workflow Teams4

Creates a user role to assign to a workflow role`createWorkflowTeamUser`	POST	Creates a user role to assign to a workflow role.
GET /hub/v1/workflowteams/{objecttype}`workflowTeams`	GET	GET /hub/v1/workflowteams/{objecttype}
POST /hub/v1/workflowitems/{workflowItemid}/transitions`transitionWorkflowItem`	POST	POST /hub/v1/workflowitems/{workflowItemid}/transitions
Removes a user assigned to a workflow role`deleteWorkflowTeamuser`	DELETE	Removes a user assigned to a workflow role.

Adds consent management information to contact records by contact ID for data protection and privacy concerns`addContactPreferencesById`	POST	Adds consent management information to contact records by contact ID for data protection and privacy concerns.
Asynchronously deletes a contact when provided with its contact ID. Use the OperationID value returned to check`deleteByContactIDs`	POST	Asynchronously deletes a contact when provided with its contact ID.
Asynchronously deletes a contact when provided with its contact key. Use the OperationID value returned to check`deleteByContactKeys`	POST	Asynchronously deletes a contact when provided with its contact key.
Creates or returns a contact using the Contact Key and Contact Type provided in the payload`establishContactsDetail`	POST	Creates or returns a contact using the Contact Key and Contact Type provided in the payload.
Deletes contacts based on specified list reference value. This operations runs asynchronously. Use the OperationID`deleteByListReference`	POST	Deletes contacts based on specified list reference value.
GET /contacts/v1/contacts/actions/delete/status?operationID=`contactsDeleteStatus`	GET	GET /contacts/v1/contacts/actions/delete/status?operationID=
GET /contacts/v1/contacts/actions/restrict/status?operationID=`contactsRestrictStatus`	GET	GET /contacts/v1/contacts/actions/restrict/status?operationID=
GET /contacts/v1/contacts/analytics/deleterequests/summary`contactsDeleteRequestsSummary`	GET	GET /contacts/v1/contacts/analytics/deleterequests/summary
GET /contacts/v1/contacts/deleteOperations`getListOfContactDeleteOperations`	GET	GET /contacts/v1/contacts/deleteOperations
GET /contacts/v1/contacts/id:{contactId}/Preferences`getContactPreferencesById`	GET	GET /contacts/v1/contacts/id:{contactId}/Preferences
GET /contacts/v1/contacts/key:{contactKey}/Preferences`getContactPreferencesByKey`	GET	GET /contacts/v1/contacts/key:{contactKey}/Preferences
GET /contacts/v1/customObject/{id}/isUsedInContacts`getCustomObject`	GET	GET /contacts/v1/customObject/{id}/isUsedInContacts
GET /contacts/v1/customobjectfield/{id}/relationships`retrieveCustomObjectFieldRelationships`	GET	GET /contacts/v1/customobjectfield/{id}/relationships
GET /contacts/v1/schema`schemasCollection`	GET	GET /contacts/v1/schema
GET /contacts/v1/schemas/{schemaId}/attributeGroups`retrieveAttributeGroups`	GET	GET /contacts/v1/schemas/{schemaId}/attributeGroups
GET /contacts/v1/schemas/{schemaId}/attributeGroups/{id}`retrieveAttributeGroupsID`	GET	GET /contacts/v1/schemas/{schemaId}/attributeGroups/{id}
POST /contacts/v1/addresses/search/{attributeName}`fetchContactsAddressesBySearchCriteria`	POST	POST /contacts/v1/addresses/search/{attributeName}
POST /contacts/v1/attributeGroups/population`createPopulationAttributeGroup`	POST	POST /contacts/v1/attributeGroups/population
POST /contacts/v1/attributeSets/{id}`attributeSetsDataIDInsert`	POST	POST /contacts/v1/attributeSets/{id}
POST /contacts/v1/contacts`createContacts`	POST	POST /contacts/v1/contacts
POST /contacts/v1/contacts/actions/delete/configSettings`contactsDeleteConfigStatus`	POST	POST /contacts/v1/contacts/actions/delete/configSettings
POST /contacts/v1/contacts/actions/delete/options`getDeleteOptions`	POST	POST /contacts/v1/contacts/actions/delete/options
POST /contacts/v1/contacts/actions/restrict?type=ids`restrictContactId`	POST	POST /contacts/v1/contacts/actions/restrict?type=ids
POST /contacts/v1/contacts/actions/restrict?type=keys`restrictContactKey`	POST	POST /contacts/v1/contacts/actions/restrict?type=keys
POST /contacts/v1/contacts/actions/restrict?type=listReference`restrictContactListreference`	POST	POST /contacts/v1/contacts/actions/restrict?type=listReference
POST /contacts/v1/contacts/preferences`addContactPreferences`	POST	POST /contacts/v1/contacts/preferences
POST /contacts/v1/contacts/preferences/search?ReferenceType={ReferenceType}`searchContactPreferencesByReferenceType`	POST	POST /contacts/v1/contacts/preferences/search?ReferenceType={ReferenceType}
POST /contacts/v1/operations/delete/{operationID}/retry`retryContactDelete`	POST	POST /contacts/v1/operations/delete/{operationID}/retry
POST /contacts/v1/operations/restrict/{operationID}/retry`retryContactRestrict`	POST	POST /contacts/v1/operations/restrict/{operationID}/retry
POST /interaction/v1/interactions/contactexit`contactExitRequest`	POST	POST /interaction/v1/interactions/contactexit
POST /interaction/v1/interactions/contactexit/status`contactExitStatus`	POST	POST /interaction/v1/interactions/contactexit/status
Provides a list of journeys and journey versions for a list of contact keys`contactMembershipRequest`	POST	Provides a list of journeys and journey versions for a list of contact keys.
Retrieve the contact key for one or more email addresses. This resource is helpful for situations where you need`retrieveContactKey`	POST	Retrieve the contact key for one or more email addresses.
Retrieve the number of contacts who meet a set of search criteria`fetchContactsAddressesCountSearchCriteria`	POST	Retrieve the number of contacts who meet a set of search criteria.
Retrieves a collection of attribute value containers or the data rows of a specified attribute set by name`attributeSetsDataName`	GET	Retrieves a collection of attribute value containers or the data rows of a specified attribute set by name.
Retrieves all attribute set definition from your contact data model`retrieveAllAttributeSetDefinitions`	GET	Retrieves all attribute set definition from your contact data model.
Retrieves an attribute set definition from your contact data model`retrieveAttributeSetDefinitions`	GET	Retrieves an attribute set definition from your contact data model.
Retrieves details of contact delete requests for a date range`contactsDeleteRequestsDetails`	GET	Retrieves details of contact delete requests for a date range.
Updates a collection of attribute value containers or the data rows of a specified attribute set by ID or name`attributeSetsDataIDUpdate`	PATCH	Updates a collection of attribute value containers or the data rows of a specified attribute set by ID or name.
Updates a contact record`updateContacts`	PATCH	Updates a contact record.

Checks the status of a publication`getPublishStatus`	GET	Checks the status of a publication.
Create an Event Definition, which contains the name and data schema for an event. The resource uses this key`createEventDefinition`	POST	Create an Event Definition, which contains the name and data schema for an event.
DELETE /interaction/v1/eventDefinitions/{id}`deleteEventDefinition`	DELETE	DELETE /interaction/v1/eventDefinitions/{id}
DELETE /interaction/v1/interactions/{id}`deleteInteractionById`	DELETE	DELETE /interaction/v1/interactions/{id}
Downloads journey history to a file. You can specify which fields are returned. The maximum file size is 1 GB, but you`downloadJourneyHistory`	POST	Downloads journey history to a file.
Enter a batch of subscribers into a journey or release a batch of subscribers from a wait event asynchronously`enterContactsIntoJourneyInBatches`	POST	Enter a batch of subscribers into a journey or release a batch of subscribers from a wait event asynchronously.
GET /interaction/v1/eventDefinitions/{id}`getEventDefinition`	GET	GET /interaction/v1/eventDefinitions/{id}
GET /interaction/v1/interactions/{id}`getInteractionById`	GET	GET /interaction/v1/interactions/{id}
GET /interaction/v1/rest`restDiscovery`	GET	GET /interaction/v1/rest
Insert subscribers into a journey synchronously`postEvent`	POST	Insert subscribers into a journey synchronously.
Pause a journey that's currently running by specifying its external key. To pause a journey by specifying its ID, use`journeyPauseByDefinitionKey`	POST	Pause a journey that's currently running by specifying its external key.
Pause a journey that's currently running by specifying its ID. To pause a journey by specifying its external key, use`journeyPauseByDefinitionId`	POST	Pause a journey that's currently running by specifying its ID.
POST /interaction/v1/interactions`postCreateInteraction`	POST	POST /interaction/v1/interactions
Post /interaction/v1/interactions/contactexit`interactionContactExitRequest`	POST	Post /interaction/v1/interactions/contactexit
Post /interaction/v1/interactions/contactexit/status`interactiveContactExitStatus`	POST	Post /interaction/v1/interactions/contactexit/status
POST /interaction/v1/interactions/publishAsync/{id}?versionNumber={versionNumber}`postPublishInteractionById`	POST	POST /interaction/v1/interactions/publishAsync/{id}?versionNumber={versionNumber}
POST /interaction/v1/interactions/resume/key:{definitionKey}?versionNumber={versionNumber}`journeyResumeByDefinitionKey`	POST	POST /interaction/v1/interactions/resume/key:{definitionKey}?versionNumber={versionNumber}
POST /interaction/v1/interactions/resume/{definitionID}?versionNumber={versionNumber}`journeyResumeByDefinitionId`	POST	POST /interaction/v1/interactions/resume/{definitionID}?versionNumber={versionNumber}
POST /interaction/v1/interactions/stop/{definitionId}?versionNumber={versionNumber}`postStopInteractionById`	POST	POST /interaction/v1/interactions/stop/{definitionId}?versionNumber={versionNumber}
Provides an estimate of the amount of time that journey history events trail behind actual journey events`getJourneyHistoryDownloadFreshness`	GET	Provides an estimate of the amount of time that journey history events trail behind actual journey events.
Retrieve a collection of event definitions`getEventDefinitions`	GET	Retrieve a collection of event definitions.
Retrieve a list of journeys`getInteractionCollection`	GET	Retrieve a list of journeys.
Retrieve the status of contacts that were inserted into a journey using the POST method . Use this operation`getStatusOfContacts`	GET	Retrieve the status of contacts that were inserted into a journey using the POST method .
Retrieves an audit log for one or all versions of a journey by specifying its external key. You can specify different`getInteractionAuditLogByKey`	GET	Retrieves an audit log for one or all versions of a journey by specifying its external key.
Retrieves an audit log for one or all versions of a journey by specifying its ID. You can specify different actions`getInteractionAuditLog`	GET	Retrieves an audit log for one or all versions of a journey by specifying its ID.
Returns an estimate of the number of rows that the journey history download request generates for a given query.`getJourneyHistoryDownloadEstimate`	POST	Returns an estimate of the number of rows that the journey history download request generates for a given query.
Updates a journey version. To call this resource, assign your API Integration the Automation \| Interactions \| Read`putUpdateInteraction`	PUT	Updates a journey version.
Updates an event definition by ID or key. Once an event definition is created, only a few properties can be updated.`updateEventDefinition`	PUT	Updates an event definition by ID or key.

Broadcast a push message to all users of a push-enabled app`sendAMessageToAllUsers`	POST	Broadcast a push message to all users of a push-enabled app.
Create a new geofenced or beacon-based location`createALocation`	POST	Create a new geofenced or beacon-based location.
Create a push message`createAPushMessage`	POST	Required Permission Scope
Delete a push message in your account`deleteAPushMessage`	DELETE	Delete a push message in your account.
Delete a specific app key by specifying its value`deleteAnAppKey`	DELETE	Delete a specific app key by specifying its value.
Delete a specific location by providing its ID`deleteALocation`	DELETE	Delete a specific location by providing its ID.
Delete the custom keys for an app. A successful deletion request removes all of the keys for the app`deleteAppKeys`	DELETE	Delete the custom keys for an app.
Modify the details of an existing location`updateALocation`	PUT	Modify the details of an existing location.
Refresh a list of recipients in MobilePush`refreshAList`	POST	This POST request doesn't require a request body.
Retrieve a list of all applications in an account`getApps`	GET	Retrieve a list of all applications in an account.
Retrieve a list of custom keys for an app`getAppKeys`	GET	Retrieve a list of custom keys for an app.
Retrieve all locations in your account`getLocations`	GET	Retrieve all locations in your account.
Retrieve all push messages in your account`getPushMessages`	GET	Required Permission Scope
Retrieve details of a specific location`getALocation`	GET	Retrieve details of a specific location.
Retrieve information about a specific app by providing its ID`getAnAppById`	GET	Retrieve information about a specific app by providing its ID.
Retrieve the status of a MobilePush list refresh request`getListRefreshStatus`	GET	Retrieve the status of a MobilePush list refresh request.
Retrieve the status of push messages that were sent to contacts based on their tags`getMessagetagDeliveryStatus`	GET	Retrieve the status of push messages that were sent to contacts based on their tags.
Retrieve the status of push messages that were sent to contacts who are on a MobilePush list`getMessagelistDeliveryStatus`	GET	Retrieve the status of push messages that were sent to contacts who are on a MobilePush list.
Retrieve the status of push messages that were sent to specific users of a mobile app`getMessagecontactDeliveryStatus`	GET	Retrieve the status of push messages that were sent to specific users of a mobile app.
Retrieve the status of push messages that were sent to users of an app`getMessageappDeliveryStatus`	GET	Retrieve the status of push messages that were sent to users of an app.
Retrieves a single push message in your account`getAPushMessageById`	GET	Retrieves a single push message in your account.
Send a batch of push messages to specific users by specifying tags or device tokens`sendABatchMessage`	POST	Send a batch of push messages to specific users by specifying tags or device tokens.
Send a push message to all contacts in a MobilePush list`sendAMessageToAList`	POST	Send a push message to all contacts in a MobilePush list.
Send a push message to all users of a push-enabled app who have specific tags`sendAMessageToTaggedUsers`	POST	The request body must include the inclusionTags or exclusionTags array, or both.
Send a push message to specific users of an app by specifying their device tokens or subscriber keys`sendAMessageToSpecificDevices`	POST	Send a push message to specific users of an app by specifying their device tokens or subscriber keys.
Update the content or details of a push message`updateAPushMessage`	PUT	Update the content or details of a push message.
Update the custom keys for an app. When you update the keys for an app, the existing keys are removed and replaced`updateAppKeys`	PUT	Update the custom keys for an app.

DELETE /sms/v1/keyword/{keywordId}`deleteKeywordViaKeywordId`	DELETE	DELETE /sms/v1/keyword/{keywordId}
DELETE /sms/v1/keyword/{keyword}/{longCode}`deleteKeywordViaKeywordLongCode`	DELETE	DELETE /sms/v1/keyword/{keyword}/{longCode}
DELETE /sms/v1/keyword/{keyword}/{shortCode}/{countryCode}`deleteKeywordViaKeywordShortCodeCountryCode`	DELETE	DELETE /sms/v1/keyword/{keyword}/{shortCode}/{countryCode}
Generates a .csv file that contains information regarding SMS message delivery for a specific MessageList.`importSendDeliveryReport`	POST	Generates a .csv file that contains information regarding SMS message delivery for a specific MessageList.
GET /sms/v1/automation/importSend/{tokenid}/status`importSendStatus`	GET	GET /sms/v1/automation/importSend/{tokenid}/status
GET /sms/v1/contacts/queueImport/{id}/status/{tokenId}`getContactImportStatus`	GET	GET /sms/v1/contacts/queueImport/{id}/status/{tokenId}
GET /sms/v1/messageContact/{messageId}/history/{tokenId}/mobileNumber/{mobileNumber}`getMessageContactHistory`	GET	GET /sms/v1/messageContact/{messageId}/history/{tokenId}/mobileNumber/{mobileNumber}
GET /sms/v1/queueMO/deliveries/{tokenId}`getQueueMODelivery`	GET	GET /sms/v1/queueMO/deliveries/{tokenId}
GET /sms/v1/queueMO/history/{tokenId}`getQueueMOHistory`	GET	GET /sms/v1/queueMO/history/{tokenId}
POST /sms/v1/automation/importSend`importSend`	POST	POST /sms/v1/automation/importSend
POST /sms/v1/contacts/queueImport/{id}`queueContactImport`	POST	POST /sms/v1/contacts/queueImport/{id}
POST /sms/v1/contacts/refreshList/{id}`postRefreshSMSAudience`	POST	POST /sms/v1/contacts/refreshList/{id}
POST /sms/v1/contacts/subscriptions`contactsSubscriptions`	POST	POST /sms/v1/contacts/subscriptions
POST /sms/v1/keyword`createKeyword`	POST	POST /sms/v1/keyword
POST /sms/v1/messageContact/{id}/send`postMessageContactSend`	POST	POST /sms/v1/messageContact/{id}/send
POST /sms/v1/messageList/{id}/deliveryReport/{tokenId}`messageListDeliveryReport`	POST	POST /sms/v1/messageList/{id}/deliveryReport/{tokenId}
POST /sms/v1/messageList/{id}/send`postMessageList`	POST	POST /sms/v1/messageList/{id}/send
POST /sms/v1/queueMO`postQueueMO`	POST	POST /sms/v1/queueMO
Retrieves the overall delivery status of a message to a contact and the standard SMS status codes and descriptions`getMessageContactDelivery`	GET	Retrieves the overall delivery status of a message to a contact and the standard SMS status codes and descriptions.
Retrieves the refresh list status`getRefreshSMSAudience`	GET	Retrieves the refresh list status.
Returns status for a message sent to a group of mobile numbers`getMessageList`	GET	Returns status for a message sent to a group of mobile numbers.