Skill Level: Intermediate
Syntax of the request and response XML for PurgeData
If both databases share the same key definition, contacts are matched using the key. However, if the key definition is different, contacts are matched using email address.
It is suggested that Contacts be purged from a Flexible database by using an associated query or contact list as the Source. Specifying different Flexible databases for Target and Source does not result in any matches to be purged.
If a contact list is specified for the target, records are not deleted from the database; the contacts are only removed from the contact list.
A data job is created upon successful processing of the request. The data job performs the following:
- Remove contacts that are found in the target object that also exist in the source object.
- Create a new database or list that contains copies of the purged records.
This operation requires exposing the existing Purge functionality to the API with the following enhancements:
- Ability to specify a source query that is owned by the target parent (UI restricted).
- Ability to purge data from a target Contact List. Ability to purge a target database or Contact List by using the same object as the
The existing GetJobStatus operation can be used to determine the status of the data job.
Operation <PurgeData> Elements TARGET_ID The ID of the database, Suppression, Seed, Test, or Contact List being purged. ¬† SOURCE_ID The ID of the database, Suppression, Seed, Test, or Contact List, or Query that is used to
determine which records are deleted.Note: If a Query ID is specified, it must be a Classic Query. New Queries are not supported now.
<Envelope> <Body> <PurgeData> <TARGET_ID>87981</TARGET_ID> <SOURCE_ID>64987</SOURCE_ID> </PurgeData> </Body> </Envelope>
Response <RESULT> Elements SUCCESS TRUE if successful. ¬† JOB_ID Identifies the Acoustic Campaign Background Job that is created for the purge. Example
<Envelope> <Body> <RESULT> <SUCCESS>TRUE</SUCCESS> <JOB_ID>98784</JOB_ID> </RESULT> </Body> </Envelope>