| Description | Manage Marketing Consent |
| Name | ManageMarketingConsentIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Business Partner Data Management |
| Process Component Name | BusinessPartnerDataManagement |
| Process Component Namespace | http://sap.com/xi/AP/FO/BusinessPartner/Global |
| Deployment Unit Description | Foundation |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Not Released |
An interface to change marketing consent data for business partner.
The web service interface Manage Marketing Consent In enables you to connect external applications to your SAP Business ByDesign system and to create and edit marketing channel and its permission in your system. The web service interface Manage Marketing Consent In is relevant if your company wants to access and manage marketing consent data from external applications.
The web service interface Manage Marketing Consent In offers the operations MaintainBundle and CheckMaintainBundle.
Example of a simple web service request:
The following request provides a basic MaintainBundle operation which updates Marketing Consent data. For a business partner there always exists a set of marketing consent data. Thus, creation of marketing consent data for a business partner is not necessary and the action code for marketing consent is always "02". When a new business partner is created there is a set of initial marketing consent data.
In the following marketing consent data for a business partner can be initially maintained containing permission for communication channels. This means that the general contact permission is allowed (code value 1), permission channels for Email(INT) and telephone(TEL) will be created:
<n0:MarketingConsentBundleMaintainRequest_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID>1234567890ABCDEF0123456789ABCDEF</ID> </BasicMessageHeader> <MarketingConsent MarketingConsentChannelPermissionListCompleteTransmissionIndicator="true" ActionCode="02"> <BusinessPartnerInternalID>10000123</BusinessPartnerInternalID> <MarketingConsentGeneralContactPermission>1</MarketingConsentGeneralContactPermission> <MarketingConsentChannelPermission ActionCode="01"> <MarketingConsentCommunicationChannelTypeCode>INT</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>1</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> <MarketingConsentChannelPermission ActionCode="01"> <MarketingConsentCommunicationChannelTypeCode>TEL</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>2</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> </MarketingConsent> </n0:MarketingConsentBundleMaintainRequest_Sync>
Response of the above request:
The response below provides the business partner UUID and ID as InternalID in case the marketing consent data is updated successfully.
<n0:MarketingConsentBundleMaintainConfirmation xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:ACL:/1SAI/TAS556AD5BE6B43F9AC7541:804"> <MarketingConsent> <ReferenceObjectNodeSenderTechnicalID> 20180301173048.3340430</ReferenceObjectNodeSenderTechnicalID> <ChangeStateID></ChangeStateID> <BusinessPartnerUUID>00163e07-3d66-1ed8-86e0-3832a6dc26a0</BusinessPartnerUUID> <BusinessPartnerInternalID>10000123</BusinessPartnerInternalID> </MarketingConsent> <Log/> </n0:MarketingConsentBundleMaintainConfirmation>
The following request updates General Contact permission for a business partner and changes permission for each channel:
<n0:MarketingConsentBundleMaintainRequest_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <MarketingConsent MarketingConsentChannelPermissionListCompleteTransmissionIndicator="true" ActionCode="02"> <BusinessPartnerInternalID>10000123</BusinessPartnerInternalID> <MarketingConsentGeneralContactPermission>2</MarketingConsentGeneralContactPermission> <MarketingConsentChannelPermission ActionCode="02"> <MarketingConsentCommunicationChannelTypeCode>INT</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>2</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> <MarketingConsentChannelPermission ActionCode="01"> <MarketingConsentCommunicationChannelTypeCode>TEL</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>3</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> </MarketingConsent> </n0:MarketingConsentBundleMaintainRequest_Sync>
In order to change only one communication channel, delete one channel and/or add further channels in one request the MarketingConsentChannelPermissionListCompleteTransmissionIndicator has to be set to false. The following request sets the general contact permission to disallowed (2), deletes the communication channel for Email (INT), sets contact permission for telephonee (TEL) to allowed (1) and creates further communication channel FAX.
<n0:MarketingConsentBundleMaintainRequest_Sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> </BasicMessageHeader> <MarketingConsent MarketingConsentChannelPermissionListCompleteTransmissionIndicator="false" ActionCode="02"> <BusinessPartnerInternalID>10000123</BusinessPartnerInternalID> <MarketingConsentGeneralContactPermission>2</MarketingConsentGeneralContactPermission> <MarketingConsentChannelPermission ActionCode="05"> <MarketingConsentCommunicationChannelTypeCode>INT</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>2</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> <MarketingConsentChannelPermission ActionCode="02"> <MarketingConsentCommunicationChannelTypeCode>TEL</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>1</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> <MarketingConsentChannelPermission ActionCode="01"> <MarketingConsentCommunicationChannelTypeCode>FAX</MarketingConsentCommunicationChannelTypeCode> <MarketingConsentContactAllowedCode>1</MarketingConsentContactAllowedCode> <Details>Created via Web service from external application ABC</Details> </MarketingConsentChannelPermission> </MarketingConsent> </n0:MarketingConsentBundleMaintainRequest_Sync>
| Description | Check marketing consents |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To check if marketing consent can be edited without errors.
The web service request and response message types of the CheckMaintainBundle operation are the same as those of the MaintainBundle operation.
The explanations given can therefore also be applied to the CheckMaintainBundle operation.
| Description | Maintain marketing consents |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Released |
To create, update, or delete marketing consent data for business partner.
The request message of the operation MaintainBundle contains a _BasicMessageHeader node element as well as a MarketingConsent node element that contains the marketing consent data to be created or updated. The marketing consent node can occur multiple times in the request message meaning that multiple marketing consent data of corresponding business partner can be created and updated by a single web service request.
The response message of the operation MaintainBundle contains log items, processing information and a marketing consent-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as business partner UUID.
Show full documentation
Show full documentation