|
|
Whitebeam Template Reference Documentation
|
Contact Template
unlinkContacts()
- Available since version 0.9.36 Bulk remove contact records from a community or OU
Syntax
number = rb.contact.unlinkContacts(parent, type)
Parameters
The 'unlinkContacts' method takes 2 parameters:
| Name | Type/Value | Range/Length | Description | | parent | number | | Required. The contact ID (OU or Community) from which contact records are to be removed. | | type | string | | Optional. Type of things to be removed. Set to 'INDIVIDUAL', 'COMMUNITY' or 'OU'. If not specified then removes all linked items. |
Results
The 'unlinkContacts' method returns number:
| Type/Value | Range/Length | Description |
| number |
| Returns a count of the number of items that have been removed. |
Remarks unlinkContacts() is used to un-associate contact records associated with a specific community or OU Note This method is new to release 0.9.36. |
|
|
(loadtime : 82ms) |
