| Description | Manage Marketing Campaign Inbounds |
| Name | ManageCampaignInboundIn |
| 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 campaign inbounds from a source system or file to a target system.
Marketing campaign inbounds are failed delivery status notifications (bounces) and requests to subscribe or unsubscribe for marketing campaigns. This web service is used to maintain all kinds of campaign inbound data by external consumers.
The web service provides six operations.
Bounces
The MaintainFailedDeliveryStatusBundle operation is used to update one or more instances of marketing campaign outbounds with the error codes of bounces (failed delivery status notifications) whereas the CheckMaintainFailedDeliveryStatusBundle operation is used to check if one or more marketing campaign outbounds could be updated. Both operations are used after a marketing campaign has been executed in an external system (bounces appearing after the marketing campaign execution).
Deprecated! Subscribe/Unsubscribe use service interface "Manage Marketing Permission In" instead!
The MaintainMailingPermissionBundle operation is used to update one or more instances of marketing campaigns with a mailing permission which controls the usage of customers or contact persons for new campaigns (subscribe/unsubscribe). The CheckMaintainMailingPermissionBundle is used to check if one or more marketing campaigns could be updated.
Hyperlink Clicks and E-mail Opens
The MaintainReactionBundle operation is used to update one or more instances of marketing campaigns with the person or company's reaction to a marketing campaign, either because they are contacted directly or because they respond to an unspecific campaign, for example, a promotion campaign for a product that was bought and contains a response code that the person can use to participate. The CheckMaintainReactionBundle is used to check if one or more marketing campaigns could be updated.
Technical Prerequisites:
This web service must be activated by a communication arrangement maintained for the communication scenario Manage campaign outbounds.
For performance reasons we recommend to upload 100 to 500 inbounds.
The web service does not support more than 1000 inbounds in one call.
Existence of transactional data:
Marketing campaigns and marketing campaign outbounds referred in the inbound service interface must exist in the system, this service does not create or delete any marketing campaigns and marketing campaign outbounds. Only the update of marketing campaign outbounds is supported.
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:
Customers
Contact Persons
Example
The following code snippet illustrates the usages of action codes. It requests the creation of new outbound instance and returns an error message if the instance exists already.
Show full documentation
Show full documentation
<Outbound actionCode="01">
<CustomerInternalID>4711</CustomerInternalID>
<ContactPersonInternalID>4712</ContactPersonInternalID>
<MailSystemErrorCode>5.1.6</MailSystemErrorCode>
<CommunicationDataUsageDeniedIndicator>false
</Outbound>
The processing of node elements is not supported because all service operations of this interface allow the update only.
Only the element MailSystemErrorCode of the marketing campaign outbound is updated. The CommunicationDataUsageDeniedIndicator is determined internally but all other elements (not contained) remain unchanged.
...
<Campaign>
<ID>1112</ID>
<Outbound>
<CustomerInternalID>A2001</CustomerInternalID>
<ContactPersonInternalID>CP2002</ContactPersonInternalID>
<CommunicationDataUsageDeniedIndicator>false</CommunicationDataUsageDeniedIndicator>
</Outbound>
<Outbound>
<CustomerInternalID>A2010</CustomerInternalID>
<ContactPersonInternalID>CP2012</ContactPersonInternalID>
<CommunicationDataUsageDeniedIndicator>true</CommunicationDataUsageDeniedIndicator>
</Outbound>
</Campaign>
...
You can find general information about Web services, their structure and consumption in the Web Services documentation.
A typical use case for using this web service is the execution of marketing campaigns in external systems. The information about the identifiers of customers and contact persons and any error information of bounces or requests to subscribe/unsubscribe are transmitted back to the system by using this web service:
Create marketing campaigns and export marketing campaigns to external systems.
Execute marketing campaign in external systems.
Transmit information about customers, contact persons and status back to the system (service interface ManageCampaignOutboundIn).
Use one of the specific operations of actual service interface (ManageCampaignInboundIn) for processing of bounces or to subscribe/unsubscribe or for tracking of hyperlink clicks and email opens.
Example
Process bounces based on the marketing campaign executed in an external system.
Request
<n0:CampaignFailedDeliveryStatusBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID>00163E01277C1EE186B9834511A002AB</ID> </BasicMessageHeader> <Campaign> <ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID> <ID>1112</ID> <Outbound> <ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2001</CustomerInternalID> <ContactPersonInternalID>CP2002</ContactPersonInternalID> <MailSystemErrorCode>5.1.2</MailSystemErrorCode> <CommunicationDataUsageDeniedIndicator>true</CommunicationDataUsageDeniedIndicator> </Outbound> <Outbound> <ObjectNodeSenderTechnicalID>1002</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2010</CustomerInternalID> <ContactPersonInternalID>CP2012</ContactPersonInternalID> <MailSystemErrorCode>5.1.3</MailSystemErrorCode> <CommunicationDataUsageDeniedIndicator>false</CommunicationDataUsageDeniedIndicator> </Outbound> <Outbound> <ObjectNodeSenderTechnicalID>1003</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2020</CustomerInternalID> <ContactPersonInternalID>CP2022</ContactPersonInternalID> <MailSystemErrorCode>5.1.6</MailSystemErrorCode> <CommunicationDataUsageDeniedIndicator>false</CommunicationDataUsageDeniedIndicator> </Outbound> </Campaign> </n0:CampaignFailedDeliveryStatusBundleMaintainRequest_sync>
Response (request has been processed successfully)
<nm:CampaignFailedDeliveryStatusBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global"> <Campaign> <ChangeStateID>20120820084802.0103630</ChangeStateID> <ReferenceObjectNodeSenderTechnicalID>1000</ReferenceObjectNodeSenderTechnicalID> <UUID>00163e02-8b34-1ed1-bad4-6ecb99649077</UUID> <ID>1112</ID> </Campaign> <Log/> </nm:CampaignFailedDeliveryStatusBundleMaintainConfirmation_sync>
Response (processing failed)
<nm:CampaignFailedDeliveryStatusBundleMaintainConfirmation_sync xmlns:nm="http://sap.com/xi/SAPGlobal20/Global"> <Log> <MaximumLogItemSeverityCode>3</MaximumLogItemSeverityCode> <Item> <TypeID>001(/CM_A2X_MNG_CMPG_OUTB/)</TypeID> <CategoryCode>SEI.SCV</CategoryCode> <SeverityCode>3</SeverityCode> <ReferenceObjectNodeSenderTechnicalID> 1001</ReferenceObjectNodeSenderTechnicalID> <Note>Account A2001 does not exist</Note> </Item> <Item> <TypeID>002(/CM_A2X_MNG_CMPG_OUTB/)</TypeID> <CategoryCode>SEI.SCV</CategoryCode> <SeverityCode>3</SeverityCode> <ReferenceObjectNodeSenderTechnicalID> 1001</ReferenceObjectNodeSenderTechnicalID> <Note>Contact person CP2002 does not exist</Note> </Item> ... </Log> </nm:CampaignFailedDeliveryStatusBundleMaintainConfirmation_sync>
Process requests to subscribe or unsubscribe based on the marketing campaign executed in an external system.
Request
<n0:CampaignMailingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID>00163E01277C1EE186B9834511A002AB</ID> </BasicMessageHeader> <Campaign> <ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID> <ID>1112</ID> <Outbound> <ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2001</CustomerInternalID> <ContactPersonInternalID>CP2002</ContactPersonInternalID> <MailingPermissionDeniedIndicator>true</MailingPermissionDeniedIndicator> </Outbound> <Outbound> <ObjectNodeSenderTechnicalID>1002</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2010</CustomerInternalID> <ContactPersonInternalID>CP2012</ContactPersonInternalID> <MailingPermissionDeniedIndicator>true</MailingPermissionDeniedIndicator> </Outbound> <Outbound> <ObjectNodeSenderTechnicalID>1003</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2020</CustomerInternalID> <ContactPersonInternalID>CP2022</ContactPersonInternalID> <MailingPermissionDeniedIndicator>false</MailingPermissionDeniedIndicator> </Outbound> </Campaign> </n0:CampaignMailingPermissionBundleMaintainRequest_sync>
| Description | Maintain campaign mailing permission data (subscriptions) - (deprecated) |
| Name | MaintainMailingPermissionBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create, update or delete one or more campaign mailing permission data using imported structured data.
Deprecated, use service interface "Manage Marketing Permission In" instead!
Marketing campaign mailing permission data (subscriptions) controls the usage of customers or contact person contact data for new marketing campaigns (subscribe, unsubscribe). Both operations MaintainMailingPermissionBundle and CheckMaintainMailingPermissionBundle processes the request for changing the marketing campaign mailing permission data.
The request message of the operation MaintainMailingPermissionBundle contains a BasicMessageHeader node element, as well as a Campaign node element containing the marketing campaign outbound data to be updated.
The detailed structure of the campaign node will be explained in the following sub-chapters. The campaign node can occur multiple times in the request message, meaning that outbound data for multiple marketing campaigns be created, updated or deleted by a single web service call.
The response message of the operation MaintainMailingPermissionBundle contains log items, processing information, and a marketing campaign-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as marketing campaign ID and marketing campaign UUID (Note: Identifiers of marketing campaigns not of marketing campaign outbounds).
Both operations MaintainMailingPermissionBundle and CheckMaintainMailingPermissionBundle are allowed for one of the marketing campaign execution type codes only:
| 1 | E-Mail using file export |
| 2 | Fax using file export |
| 3 | Letter using file export |
| 4 | Phone Call using file export |
| 7 | External Execution |
The Campaign message node consists of two elements needed to identify existing marketing campaigns.
ID: Identifier of a marketing campaign in the actual system
ReferenceID: Identifier for a unique reference to a marketing campaign in an external system.
Either ID or ReferenceID has to be used for specifying a marketing campaign which shall be updated.
Only the value 06 (No Action) is allowed for action codes. If the external application does not pass the action code 06 it will be defaulted.
The Outbound message node contains information about the customer and contact persons addressed by the marketing campaign including the indicator for controlling the usage of customers or contact person contact data for new marketing campaigns (subscribe, unsubscribe).
CustomerUUID, CustomerInternalID: Identifier of a customer; specify either the customer UUID or the customer internal ID
ContactPersonUUID, ContactPersonInternalID: Identifier of a contact person; specify either the contact person UUID or the contact person internal ID.
MailingPermissionDeniedIndicator: The indicator marks customer or contact persons that are excluded for any marketing campaigns.
actionCode: Only the action code 02 (Update) is supported.
Few elements are mandatory for the identification of marketing campaigns outbound instances. Please specify one of the customer and contact person identifiers. Valid elements for identification of marketing campaign outbound instances are:
One of the customer identifiers (UUID or InternalID) and one of the contact person identifiers (UUID or InternalID) or
One of the customer identifiers (UUID or InternalID) in case the outbound instance does not have a contact person
The element MailingPermissionDeniedIndicator is mandatory. The value true excludes the customer or contact person from any marketing campaigns and the value false removes the previous subscription cancellation. Customers or contact persons can be used in any marketing campaigns again when the unsubscribe operation has been reverted once:
| Time | Campaign | Life Cycle Status | Behavior |
|---|---|---|---|
| X | 1 | Active | Unsubscribtion for customer or contact person 2020 |
| X | 2 | Planned | Exclude customer or contact person 2020 during the execution |
| X | 3 | Active | Active marketing campaigns are not affected, customer or contact person 2020 has been contacted already |
| X+1 | 4 | Active | Subscription for customer or contact person 2020 |
| X+1 | 5 | Planned | Customer or contact person 2020 could be contacted again during the execution |
The existence of a customer and a contact person in an outbound instance specifies the object for processing the request:
| Customer ID/UUID | Contact person ID/UUID | Object |
|---|---|---|
| Specified | Specified | Subscription belongs to the contact person of the customer |
| Specified | Empty | Subscription belongs to the customer |
| Empty | Specified | Not allowed |
Process requests to subscribe/unsubscribe for marketing campaigns based on marketing campaigns executed in an external system.
<n0:CampaignMailingPermissionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID>00163E01277C1EE186B9834511A002AB</ID> </BasicMessageHeader> <Campaign> <ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID> <ID>1112</ID> <Outbound> <ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2001</CustomerInternalID> <ContactPersonInternalID>CP2002</ContactPersonInternalID> <MailingPermissionDeniedIndicator>true</MailingPermissionDeniedIndicator> </Outbound> <Outbound> <ObjectNodeSenderTechnicalID>1002</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2010</CustomerInternalID> <ContactPersonInternalID>CP2012</ContactPersonInternalID> <MailingPermissionDeniedIndicator>false</MailingPermissionDeniedIndicator> </Outbound> </Campaign> <Campaign> <ObjectNodeSenderTechnicalID>2000</ObjectNodeSenderTechnicalID> <ID>1114</ID> <Outbound> <ObjectNodeSenderTechnicalID>2001</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2020</CustomerInternalID> <ContactPersonInternalID>CP2022</ContactPersonInternalID> <MailingPermissionDeniedIndicator>true</MailingPermissionDeniedIndicator> </Outbound> </Campaign> </n0:CampaignMailingPermissionBundleMaintainRequest_sync>
| Description | Maintain campaign failed delivery status data (bounces) |
| Name | MaintainFailedDeliveryStatusBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create, update or delete one or more campaign failed delivery status data using imported structured data.
Marketing campaign failed delivery status data (bounces) represent error codes and error reasons of e-mails sent to customers or contact person by mailing marketing campaigns.
Both operations MaintainFailedDeliveryStatusBundle and CheckMaintainFailedDeliveryStatusBundle processes the request to set the marketing campaign failed delivery status data after a marketing campaign has been executed in an external system (bounces appearing after the marketing campaign execution always). But the operations of the service ManageCampaignOutboundIn shall be used for errors noted during the marketing campaign execution, for example, e-mail address is missing.
The request message of the operation MaintainFailedDeliveryStatusBundle contains a BasicMessageHeader node element, as well as a Campaign node element containing the marketing campaign outbound data to be updated.
The detailed structure of the campaign node will be explained in the following sub-chapters. The campaign node can occur multiple times in the request message, meaning that outbound data for multiple marketing campaigns be created, updated or deleted by a single web service call.
The response message of the operation MaintainFailedDeliveryStatusBundle contains log items, processing information, and a marketing campaign-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as marketing campaign ID and marketing campaign UUID (Note: Identifiers of marketing campaigns not of marketing campaign outbounds).
Both operations MaintainFailedDeliveryStatusBundle and CheckMaintainFailedDeliveryStatusBundle are allowed for marketing campaign execution type code External Execution only.
The Campaign message node consists of two elements needed to identify existing marketing campaigns.
ID: Identifier of a marketing campaign in the actual system
ReferenceID: Identifier for a unique reference to a marketing campaign in an external system.
Either ID or ReferenceID has to be used for specifying a marketing campaign which shall be updated.
Only the value 06 (No Action) is allowed for action codes. If the external application does not pass the action code 06 it will be defaulted.
The Outbound message node contains information about the customer and contact persons addressed by the marketing campaign including the error codes and error reasons of a failed e-mail communication.
CustomerUUID, CustomerInternalID: Identifier of a customer; specify either the customer UUID or the customer internal ID
ContactPersonUUID, ContactPersonInternalID: Identifier of a contact person; specify either the contact person UUID or the contact person internal ID.
MailSystemErrorCode: Code for mail system errors according to the RFC 3463.
CommunicationDataUsageDeniedIndicator: The indicator marks the e-mail address of the customer or the contact person as invalid. This means that the e-mail address cannot be used for any mailings.
ActionCode: Only the action code 02 (Update) is supported.
FailedDeliveryStatusDateTime: Time stamp when the delivery of the sent e-mail message failed. The input of the failed delivery status date time is a time stamp (time zone UTC) in the format CCYY-MM-DDThh:mm:ss(.sss)Z
Few elements are mandatory for the identification of marketing campaigns outbound instances. Please specify one of the customer and contact person identifiers. Valid elements for identification of marketing campaign outbound instances are:
One of the customer identifiers (UUID or InternalID) and one of the contact person identifiers (UUID or InternalID) or
One of the customer identifiers (UUID or InternalID) in case the outbound instance does not have a contact person
The element MailSystemErrorCode is mandatory. In case the element CommunicationDataUsageDeniedIndicator is not in the request message then the MailSystemErrorCode determines the CommunicationDataUsageDeniedIndicator internally dependent on the error code.
| Mail System Error Code | Communication Data Usage Denied Indicator | Outbound Communication Status Code |
|---|---|---|
| 2.xxx.yyy | Not relevant | Not affected |
| 4.1.yyy | True | "3" |
| 5.1.yyy | True | "3" |
| 4.xxx.yyy | Apply if value {{TRUE}} | "3" |
| 5.xxx.yyy | Apply if value {{TRUE}} | "3" |
If the CommunicationDataUsageDeniedIndicator has the value TRUE then it overrules this behavior for all appearances of the MailSystemErrorCode except for {{2.xxx.yyy}.
The existence of a customer and a contact person in an outbound instance specifies the object for processing the request:
| Customer ID/UUID | Contact person ID/UUID | Object |
|---|---|---|
| Specified | Specified | Bounce belongs to the e-mail address of the contact contact person of the customer |
| Specified | Empty | Bounce belongs to the e-mail address of the customer |
| Empty | Specified | Not allowed |
Code lists
Codes for the MailSystemErrorCode
The syntax of the codes is defined (according to the RFC 3463) as:
| class | . | subject | . | detail |
|---|---|---|---|---|
| "2"/"4"/"5" | . | minLength = "1", maxLength = "3" | . | minLength = "1", maxLength = "3" |
Examples: 4.1.2, 5.1.1
Process bounces based on the marketing campaign executed in an external system.
<n0:CampaignFailedDeliveryStatusBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global"> <BasicMessageHeader> <ID>00163E01277C1EE186B9834511A002AB</ID> </BasicMessageHeader> <Campaign> <ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID> <ID>1112</ID> <Outbound> <ObjectNodeSenderTechnicalID>1001</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2001</CustomerInternalID> <ContactPersonInternalID>CP2002</ContactPersonInternalID> <MailSystemErrorCode>5.1.2</MailSystemErrorCode> <CommunicationDataUsageDeniedIndicator>true</CommunicationDataUsageDeniedIndicator> </Outbound> <Outbound> <!-- Denied indicator overules the error code --> <ObjectNodeSenderTechnicalID>1002</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2010</CustomerInternalID> <ContactPersonInternalID>CP2012</ContactPersonInternalID> <MailSystemErrorCode>5.1.3</MailSystemErrorCode> <CommunicationDataUsageDeniedIndicator>false</CommunicationDataUsageDeniedIndicator> </Outbound> <Outbound> <!-- Error code determines the denied indicator --> <ObjectNodeSenderTechnicalID>1003</ObjectNodeSenderTechnicalID> <CustomerInternalID>A2020</CustomerInternalID> <ContactPersonInternalID>CP2022</ContactPersonInternalID> <MailSystemErrorCode>5.1.6</MailSystemErrorCode> </Outbound> </Campaign> </n0:CampaignFailedDeliveryStatusBundleMaintainRequest_sync>
| Description | Check campaign failed delivery status data (bounces) |
| Name | CheckMaintainFailedDeliveryStatusBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check whether one or more campaign failed delivery status data can be created, updated, or deleted without errors using imported structured data.
Marketing campaign failed delivery status data (bounces) represent error codes and error reasons of e-mails sent to customers or contact person by mailing campaigns.
The web service request and response message types of the CheckMaintainFailedDeliveryStatusBundle operation are the same as those of the MaintainFailedDeliveryStatusBundle operation. The explanations given can therefore also be applied to the CheckMaintainFailedDeliveryStatusBundle operation.
| Description | Check campaign mailing permission data (subscriptions) - (deprecated) |
| Name | CheckMaintainMailingPermissionBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check whether one or more campaign mailing permission data can be created, updated, or deleted without errors using imported structured data.
Deprecated, use service interface "Manage Marketing Permission In" instead!
Marketing campaign mailing permission data (subscriptions) controls the usage of customers or contact person contact data for new marketing campaigns (subscribe, unsubscribe).
The web service request and response message types of the CheckMaintainMailingPermissionBundle operation are the same as those of the MaintainMailingPermissionBundle operation. The explanations given can therefore also be applied to the CheckMaintainMailingPermissionBundle operation.
| Description | Maintain campaign reaction data |
| Name | MaintainReactionBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To create one or more marketing campaign reaction data using imported structured data.
The marketing campaign reaction data describes a persons or a company's reaction to a marketing campaign, either because they are contacted directly or because they respond to an unspecific campaign, for example, a promotion campaign for a product that was bought and contains a response code that the person can use to participate.
Both operations MaintainReactionBundle and CheckMaintainReactionBundle processes the request for creation of marketing campaign reactions after a marketing campaign has been executed in an external system.
The request message of the operation MaintainReactionBundle consists of a BasicMessageHeader node element, as well as a Campaign node element containing the marketing campaign reaction data to be created.
The detailed structure of the campaign node will be explained in the following sub-chapters. The campaign node can occur multiple times in the request message, meaning that reaction data for multiple marketing campaigns be created by a single web service call.
The response message of the operation MaintainReactionBundle contains log items, processing information, and a marketing campaign-specific node with ReferenceObjectNodeSenderTechnicalID, ChangeStateID, as well as marketing campaign ID and marketing campaign UUID (Note: Identifiers of marketing campaigns itself not of marketing campaign reactions).
Both operations MaintainReactionBundle and CheckMaintainReactionBundle are allowed for marketing campaign execution type code External Execution only.
The Campaign message node consists of two elements needed to identify existing marketing campaigns.
ID: Identifier of a marketing campaign in the actual system
ReferenceID: Identifier for a unique reference to a marketing campaign in an external system.
Either ID or ReferenceID has to be used for specifying a marketing campaign which shall be updated.
Only the value 06 (No Action) is allowed for action codes. If the external application does not pass the action code 06 it will be defaulted.
The inboundBusinessTransactionDocumentReferenceListCompleteTransmissionIndicator implementing the list processing concept is "false" always, because the list processing is not supported (only creation of new reaction data).
The InboundBusinessTransactionDocumentReference message node contains information about the customer and contact persons addressed by the marketing campaign including data for tracking of reactions.
CustomerUUID, CustomerInternalID: Identifier of a customer; specify either the customer UUID or the customer internal ID
ContactPersonUUID, ContactPersonInternalID: Identifier of a contact person; specify either the contact person UUID or the contact person internal ID.
CreationDateTime: Original reaction creation time stamp, the input of the creation date time is a time stamp (time zone UTC) in the format CCYY-MM-DDThh:mm:ss(.sss)Z. This element is mandatory.
CampaignReactionTypeCode: The reaction type code describes a persons or a company's reaction to a marketing campaign, either because they are contacted directly or because they respond to an unspecific campaign. This element is mandatory.
ReactionTracking: Used for tracking of link clicks only. It specifies the hyperlink that has been clicked in the marketing campaign e-mail.
actionCode: Only the action code 01 (Create) is supported.
Few elements are mandatory for the identification of marketing campaigns outbound instances. Please specify one of the customer and contact person identifiers. Valid elements for identification of marketing campaign outbound instances are:
One of the customer identifiers (UUID or InternalID) and one of the contact person identifiers (UUID or InternalID) or
One of the customer identifiers (UUID or InternalID) in case the outbound instance does not have a contact person
The system also allows the creation of reactions without a reference to marketing campaign outbound instances, but all rules regarding the customer and contact person identifiers remains unchanged (see above).
Codes for the CampaignReactionTypeCode
| Code value | Code description |
|---|---|
| 20 | E-mail opened |
| 21 | Link clicked |
The ReactionTracking message node tracks the hyperlinks clicks. It requires either a valid target link UUID or a valid target link web URI. Both have to be maintained in the marketing campaign execution node first before the marketing campaign starts.
TargetLinkUUID: Unique identifier of the target link as defined in the Tracking Link node of the marketing campaign.
TargetLinkWebURI: URI of the target link as defined in the Tracking Link node of the marketing campaign.
Either the target link UUID or the target link URI has to be specified. In case that both are specified the target link UUID only is used.
Process reactions based on the marketing campaign executed in an external system.
<n0:CampaignReactionBundleMaintainRequest_sync xmlns:n0="http://sap.com/xi/SAPGlobal20/Global">
<BasicMessageHeader>
<ID>00163E01277C1EE186B9834511A002AB</ID>
</BasicMessageHeader>
<Campaign actionCode="06" inboundBusinessTransactionDocumentReferenceListCompleteTransmissionIndicator="false">
<ObjectNodeSenderTechnicalID>1000</ObjectNodeSenderTechnicalID>
<ID>2831</ID>
<InboundBusinessTransactionDocumentReference actionCode="01">
<ObjectNodeSenderTechnicalID>1011</ObjectNodeSenderTechnicalID>
<CustomerUUID>00300571-CE9B-1DED-89DE-4402AB375EC4</CustomerUUID>
<ContactPersonUUID>00300571-CE9B-1DED-89DE-389FE45C1EC4</ContactPersonUUID>
<CreationDateTime>2013-02-15T12:00:00.1234567Z</CreationDateTime>
<CampaignReactionTypeCode>21</CampaignReactionTypeCode>
<ReactionTracking actionCode="01">
<TargetLinkWebURI>http://www.sap.com</TargetLinkWebURI>
</ReactionTracking>
</InboundBusinessTransactionDocumentReference>
<InboundBusinessTransactionDocumentReference actionCode="01">
<ObjectNodeSenderTechnicalID>1012</ObjectNodeSenderTechnicalID>
<CustomerUUID>00300571-CE9B-1DED-89DE-4B7CA3968564</CustomerUUID>
<ContactPersonUUID>00300571-CE9B-1DDD-89DE-2DBB185F5BDF</ContactPersonUUID>
<CreationDateTime>2013-02-15T12:01:00.1234567Z</CreationDateTime>
<CampaignReactionTypeCode>21</CampaignReactionTypeCode>
<ReactionTracking actionCode="01">
<TargetLinkUUID>00163E02-8B2E-1ED2-9D9D-BBF8587FD734</TargetLinkUUID>
</ReactionTracking>
</InboundBusinessTransactionDocumentReference>
<InboundBusinessTransactionDocumentReference actionCode="01">
<ObjectNodeSenderTechnicalID>1013</ObjectNodeSenderTechnicalID>
<CustomerInternalID>MC9785</CustomerInternalID>
<ContactPersonInternalID>MCP9785</ContactPersonInternalID>
<CreationDateTime>2013-02-15T12:02:00.1234567Z</CreationDateTime>
<CampaignReactionTypeCode>20</CampaignReactionTypeCode>
</InboundBusinessTransactionDocumentReference>
</Campaign>
</n0:CampaignReactionBundleMaintainRequest_sync>
| Description | Check campaign reaction data |
| Name | CheckMaintainReactionBundle |
| Synchronous | yes |
| Release Status | Deprecated |
To check whether one or more marketing campaign reaction data can be created without errors using imported structured data.
The marketing campaign reaction data describes a persons or a company's reaction to a marketing campaign, either because they are contacted directly or because they respond to an unspecific campaign, for example, a promotion campaign for a product that was bought and contains a response code that the person can use to participate.
The web service request and response message types of the CheckMaintainReactionBundle operation are the same as those of the MaintainReactionBundle operation. The explanations given can therefore also be applied to the CheckMaintainReactionBundle operation.