Whitebeam Template Reference Documentation
- Available since version 1.3.4
Deletes contacts that match the search criteria
number = rb.contact.bulkRemove(keywords, flags)
The 'bulkRemove' method takes 2 parameters:
|Name ||Type/Value ||Range/Length ||Description |
|keywords||array of strings||array of 0-10 keyword strings, of < 128 characters each ||Required. A list of up to 10 keywords to be searched for. Keywords are additive (that is to say that searches will match any entry which contains any of the keywords|
|flags||struct searchFlags||see definition ||Required. Flags, see definition of searchflags|
The 'bulkRemove' method returns number:
|Type/Value ||Range/Length ||Description |
||-1, 0, or a positive integer||count of contact records deleted from the database, or -1 to indicate that the search failed (invalid search parameters)
Calling parameters are exactly the same as the get and count methods.
Use this call to physically remove all contact records from the database that match the search criteria specified.
Note: only INDIVIDUALS can be deleted using this method. An attempt to remove communities or OUs will cause an exception
to be returned to the application.
The keywords array holds a list of all keywords to be searched for. Wildcards of %
(representing any length of unspecified characters) and _ (representing a single unspecified character) can be
used in the search. Only alphabetical characters and numbers may be used in a search.
(loadtime : 181ms)