Campaign Response Supported Operations

The following operations can be used with campaign response records:

Note:

You can also use the asynchronous equivalents of SOAP web services list operations. For information about asynchronous operations, see SOAP Web Services Asynchronous Operations. For more information about request processing, see Synchronous Versus Asynchronous Request Processing.

Behavior of the Add and Update Operations

The information on a campaign response record cannot be changed, either in the user interface or when using SOAP web services. The only change possible is to add lines to the record’s sublist. Further, if you attempt to add a record using a combination of fields that is not unique, the system does not add a new record. It adds a sublist line to an existing record.

To better understand this, consider how these records are created and represented in the user interface. Campaign responses are listed on the entity record with which they are associated. Specifically, they are listed on the Campaigns subtab of the Marketing subtab.

When you create a campaign response for a campaign/event combination that is not already represented the entity’s subtab, the system adds a line of data, along with an Update Status link. For any entity, a particular campaign/event combination can be represented only one time on this subtab. For example, in the preceding screenshot, three campaign responses are listed. Note that each has a unique campaign/event combination.

If you click the Update Status link, the system displays the Campaign Response window. This window includes a sublist labeled Response Detail. This sublist includes a line showing the original details you specified when you created the record (shown in the red box in the following screenshot). The window also includes a form for entering more details.

If you enter new data on the form and click Save New Response, the system adds a new line to the Response Detail sublist. Similarly, if you cancel out of this screen and click the Add Response button on the Campaigns tab, but you use the form to specify the same campaign and event as an existing campaign response record, the system adds a new line to the Response Detail sublist of the existing record. It does not create a new line on the Campaigns subtab. For example, in the illustration below, two new lines have been added to an existing record.

SOAP web services mimic this behavior: Any update you make to an existing record results in a new line on the existing campaign response record. Existing data is not changed. Similarly, if you use the add operation but name the same combination of entity, campaign, and event as has already been specified on an existing campaign response, the system adds a line to that same record. It does not create a new record.

Note also that one field — the campaignResponseDate field — is treated differently depending on whether you are doing an add, update, or get operation. For details, see Working with the campaignResponseDate Field.

Remove Link Is Not Supported in SOAP Web Services

The UI for this record includes a Remove link, which is available for those records that were created manually in the UI or through SOAP web services (in contrast to responses created automatically by the system, which do not have this link). However, you can never use SOAP web services to remove campaign responses, regardless of how they were added.

Behavior of the Add and Update Operations

Remove Link Is Not Supported in SOAP Web Services

Related Topics