| Description | Manage Marketing Permissions |
| Name | ManageMarketingPermissionIn |
| Namespace | http://sap.com/xi/A1S/Global |
| Process Component Description | Campaign Management |
| Process Component Name | CampaignManagement |
| Process Component Namespace | http://sap.com/xi/AP/CRM/Global |
| Deploymnent Unit Description | Customer Relationship Management |
| Endpoint Activation | By Scoping of Process Component | Operations |
| Release Status | Deprecated |
An interface to replicate marketing permissions from a source system or file to a target system.
The web service interface ManageMarketingPermissionIn enables you to connect external applications to your SAP system and to create and edit marketing permissions in your system. The web service interface ManageMarketingPermissionIn is relevant if your company wants to access and manage marketing permissions data from external applications.
The web service interface ManageMarketingPermissionIn offers the operations MaintainBundle and CheckMaintainBundle.
This web service creates and updates only marketing permissions. It can't delete any data.
For each new business partner created the system also creates a new set of marketing permissions depending on the configuration. And for each deleted or deactivated the system also deletes the marketing permissions.
| The web service should always pass the channel permissions codes, because otherwise the extended XML handling resets the codes to Undefined. The code Undefined influences the addressability check in target groups depending on the configuration settings. |
Maintain all countries and communication channels requiring explicit opt-in.
Technical Prerequisites:
This web service must be activated by a communication arrangement maintained for the communication scenario Manage marketing permissions.
Existence of master data:
All master data are only referenced, and will not be created by the service. They must already exist in the system at the time the web service is called.
Marketing permissions can be created only when contacts are still there.
You can find general information about Web services, their structure and consumption in the Web Services documentation.
Create marketing permissions with initial marketing permissions codes enforcing the creation mode
Show full documentation
Show full documentation
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission actionCode="01">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
</MarketingPermission>
<MarketingPermission actionCode="01">
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002781</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2002</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>INT</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
Change marketing permission codes for existing marketing permissions
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission actionCode="04">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<MarketingPermissionCode>2</MarketingPermissionCode>
</ChannelPermission>
</MarketingPermission>
<MarketingPermission>
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002781</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<MarketingPermissionCode>2</MarketingPermissionCode>
</ChannelPermission>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2002</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>INT</CommunicationMediumTypeCode>
<MarketingPermissionCode>1</MarketingPermissionCode>
</ChannelPermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
Initialize marketing permission codes for existing marketing permissions
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission actionCode="04">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<MarketingPermissionCode></MarketingPermissionCode>
</ChannelPermission>
</MarketingPermission>
<MarketingPermission>
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002781</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<MarketingPermissionCode></MarketingPermissionCode>
</ChannelPermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
Change communication type codes for existing marketing permissions
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission actionCode="04">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<CommunicationTypePermission>
<ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID>
<CommunicationTypeCode>003</CommunicationTypeCode>
<SubscribedIndicator>false</SubscribedIndicator>
</CommunicationTypePermission>
</MarketingPermission>
<MarketingPermission>
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002781</BusinessPartnerInternalID>
<CommunicationTypePermission>
<ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID>
<CommunicationTypeCode>005</CommunicationTypeCode>
<SubscribedIndicator>true</SubscribedIndicator>
</CommunicationTypePermission>
<CommunicationTypePermission>
<ObjectNodeSenderTechnicalID>2002</ObjectNodeSenderTechnicalID>
<CommunicationTypeCode>003</CommunicationTypeCode>
<SubscribedIndicator>false</SubscribedIndicator>
</CommunicationTypePermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
|
| Description | Check marketing permissions |
| Name | CheckMaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check whether one or more marketing permission data can be created, updated, or deleted without errors using imported structured data.
The web service request- and response message types for 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 permissions |
| Name | MaintainBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create and update one or more marketing permission data using imported structured data.
The request message of the operation MaintainBundle contains a BasicMessageHeader node element as well as a MarketingPermission node element that contains the data to be created or updated. The detailed structure of the node will be explained in the following sub-chapters. The node can occur multiple times in the request message – this means that multiple marketing permissions can be created and updated through a single web service request.
The response message type of the operation MaintainBundle contains log items, processing information, and a campaign specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as ID and UUID.
The Marketing Permission message node consists of at least one element needed to identify existing marketing permissions.
UUID: Identifier of a marketing permission in the actual system.
AlternativeID : Alternative identifier of a marketing permission in the actual system.
BusinessPartnerUUID: Business partner UUID and alternative identifier of a marketing permission in the actual system
BusinessPartnerID: Business partner internal id and alternative identifier of a marketing permission in the actual system.
actionCode: The action code 03 (Delete) is not supported.
channelPermissionListCompleteTransmissionIndicator: Enforcing the complete transmission (value "true") is not allowed because this could imply a deletion of channel permissions.
communicationTypePermissionListCompleteTransmissionIndicator: Enforcing the complete transmission (value "true") is not allowed because this could imply a deletion of communication type permissions.
One of the identifiers has to be used for specifying a marketing permission which shall be created, updated or deleted.
BusinessPartnerID
BusinessPartnerUUID
UUID
AlternativeID
Either the BusinessPartnerID or the BusinessPartnerUUID is mandatory for the creation of marketing permissions.
The ChannelPermission message node contains information about the communication channel and the marketing permission code assigned to the communication channel.
CommunicationMediumTypeCode: The communication medium type code describes the communication channel. This element is mandatory.
MarketingPermissionCode: The marketing permission code describes the permission to each communication channel.
actionCode: The action code 03 (Delete) is not supported.
Codes for the CommunicationMediumTypeCode
| Code value | Code description |
|---|---|
| FAX | Fax |
| INT | |
| TEL | Telephone |
Codes for the MarketingPermissionCode
| Code value | Code description |
|---|---|
| 1 | Opt-In |
| 2 | Opt-Out |
| 3 | Undefined |
A text is unstructured, readable information that contains additional formatting. The type of text can be specified using the TypeCode. Marketing Permissions allow TypeCode 10006 "Detailed Description" only. This will be maintained automatically by the system and cannot be influenced by the service interface.
Language information is not stored.
ContentText: This element describes the unstructured data of the text.
Example
Add a detailed description text for the communication channel "FAX' to an existing marketing permission
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission>
<ChangeStateID>20140320084802.0103630</ChangeStateID>
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
An Attachment Folder is the collection of all documents attached to a marketing permission.
| Attributes | Description |
|---|---|
| DocumentListCompleteTransmissionIndicator | Refer „General Rules‟ section for more details. |
| actionCode | Refer „General Rules‟ section for more details. |
A document is an attachment that was assigned to the attachment folder and contains unstructured information, additional control, and monitoring information.
| Attributes | Description |
|---|---|
| DocumentListCompleteTransmissionIndicator | Refer „General Rules‟ section for more details. |
| actionCode | Refer „General Rules‟ section for more details. |
UUID: Universally unique identifier of the document
VisibleIndicator: Specifies whether a document is visible or not.
TypeCode: A coded representation of the document type. Most general attachments are of type '10001'.
MIMECode: A coded representation of the MIMECode of a document.
Name: Name of a document that identifies the document within its higher-level folder The Name is the same as the last component of the DocumentPathName. All characters (apart from the separator "/") are allowed in the name
AlternativeName: Language-independent name of a document.
Description: Language-independent description of a document.
ExternalLinkWebURI: Destination URI (if the link is external)
Only relevant when the document is an file
BinaryObject: Describes the unstructured data in binary form.
Example
Add two attachments to a marketing channel permission
<n0:MarketingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>26d10c30-b365-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission>
<ChangeStateID>20140320084802.0103630</ChangeStateID>
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>MPC01</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<MarketingPermissionCode>2</MarketingPermissionCode>
<DetailedDescriptionText>
<ContentText>Test A2X FAX, changed</ContentText>
</DetailedDescriptionText>
<AttachmentFolder DocumentListCompleteTransmissionIndicator="true">
<Document>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>2</CategoryCode>
<TypeCode>10001</TypeCode>
<MIMECode>text/plain</MIMECode>
<Name>New Text Document.txt</Name>
<AlternativeName>Test Document (txt)</AlternativeName>
<Description>This is a file attachment</Description>
<FileContent>
<BinaryObject mimeCode="text/plain">VGhpcyBpcyBhIHRlc3QgZG9jdW1lbnQu</BinaryObject>
</FileContent>
</Document>
<Document>
<VisibleIndicator>true</VisibleIndicator>
<CategoryCode>3</CategoryCode>
<TypeCode>10001</TypeCode>
<Name>www.testlink.com</Name>
<AlternativeName>Test Link</AlternativeName>
<Description>This is atest Link</Description>
<ExternalLinkWebURI>http://www.testlink.com</ExternalLinkWebURI>
<FileContentURI>http://www.testlink.com</FileContentURI>
</Document>
</AttachmentFolder>
</ChannelPermission>
</MarketingPermission>
</n0:MarketingPermissionBundleMaintainRequest_sync>
The CommunicationTypePermission message node contains information about the subscriptions for communication types.
CommunicationTypeCode: The communication type code describes the types of communications. This element is mandatory.
SubscribedIndicator: The indicator describes the subscription for each communication type code.
actionCode: The action code 03 (Delete) is not supported.
Codes for the CommunicationTypeCode
| Code value | Code description |
|---|---|
| 001 | Offers |
| 002 | Updates |
| 003 | Newsletters |
| 004 | Events |
| 005 | Surveys |
Request for checking the creation
<n0:MarketingPermissionRequestBundleCheckMaintainQuery_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<UUID>e1e52710-b34a-11e3-a5e2-0800200c9a66</UUID>
</BasicMessageHeader>
<MarketingPermission actionCode="01">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002761</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
<CommunicationTypePermission>
<ObjectNodeSenderTechnicalID>1002</ObjectNodeSenderTechnicalID>
<CommunicationTypeCode>005</CommunicationTypeCode>
<SubscribedIndicator>true</SubscribedIndicator>
</CommunicationTypePermission>
</MarketingPermission>
<MarketingPermission actionCode="01">
<ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID>
<BusinessPartnerInternalID>1002781</BusinessPartnerInternalID>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>FAX</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
<ChannelPermission>
<ObjectNodeSenderTechnicalID>2002</ObjectNodeSenderTechnicalID>
<CommunicationMediumTypeCode>INT</CommunicationMediumTypeCode>
<DetailedDescriptionText>
<ContentText>Detailed Description ....</ContentText>
</DetailedDescriptionText>
</ChannelPermission>
<CommunicationTypePermission>
<ObjectNodeSenderTechnicalID>2003</ObjectNodeSenderTechnicalID>
<CommunicationTypeCode>003</CommunicationTypeCode>
<SubscribedIndicator>false</SubscribedIndicator>
</CommunicationTypePermission>
</MarketingPermission>
</n0:MarketingPermissionRequestBundleCheckMaintainQuery_sync>
Response (creation ends successfully)
<n0:MarketingPermissionRequestBundleCheckMaintainResponse_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global" xmlns:prx="urn:sap.com:proxy:AXP:/1SAI/TAEF5C2E03981D7258854A4:804">
<MarketingPermission>
<ChangeStateID>20140324152709.3940030</ChangeStateID>
<ReferenceObjectNodeSenderTechnicalID>2000</ReferenceObjectNodeSenderTechnicalID>
<UUID>00163e05-ec34-1ed3-aced-1874e0e04b88</UUID>
</MarketingPermission>
<MarketingPermission>
<ChangeStateID>20140324152709.3940030</ChangeStateID>
<ReferenceObjectNodeSenderTechnicalID>1000</ReferenceObjectNodeSenderTechnicalID>
<UUID>00163e05-ec34-1ed3-aced-1874e0e02b88</UUID>
</MarketingPermission>
<Log/>
</n0:MarketingPermissionRequestBundleCheckMaintainResponse_sync>