Manipulate a List from another List

Adds, updates, deletes or replaces Members and content in a target List based on a source List.

It's possible to manipulate Tag, Counter and Data Lists through this API, but not Subscription, SQL or Target Lists. However the source List can be of any type.

The source List can be of a different type and have different column names, but this may require mapping the columns using the mapColumns attribute.

If updating List columns, both the source and destination List columns must be of the same type.
If a source value can't fit in a destination column then the value may be truncated.


The following actions can be specified for the target List:

  • ADD_OR_UPDATE
    Copies all Members from the source List across, inserting them if they don't exist, otherwise updating them.
    When updating a Counter List, it will either increase/decrease or replace the counter based on the replaceCounters attribute.
    When updating a Data List, it's possible to restrict which columns get updated through the updateColumns attribute.
    This option is not applicable to Tag Lists.
  • ADD_ONLY
    Inserts all Members from the source List which don't already exist in the target List, but do not touch any records that already exist.
  • UPDATE_ONLY
    Updates all Members that also exist in the source List, but does not add any Members.
    When updating a Counter List, it will either increase/decrease or replace the counter based on the replaceCounters attribute.
    When updating a Data List, it's possible to restrict which columns get updated through the updateColumns attribute.
    This option is not applicable to Tag Lists.
  • REPLACE_ALL
    Replaces the entire content of the target List with the Members of the source List.
    This is a convenience method, which corresponds to truncating the target List and then doing an ADD_ONLY from the source List.
  • REMOVE_COMMON
    Removes all Members from the target List which also exist in the source List.
  • REMOVE_MISSING
    Removes all Members from the target List which don't exist in the source List.

Language
Click Try It! to start a request and see the response here!