Groups
Use this API to create, update and delete groups; and manage their contacts.
Methods
Invoke via \Components\Customers\Groups::method()
Click a method name to copy it.
Adds a contact to a group
Deletes a record from the database
Parameters
$strGroupId
string
A record's group_id
Return
Returns true if record existed and was deleted, otherwise false
Gets a record from the database
Parameters
$strGroupId
string
A record's group_id
Return a set of records from the database
Returns all groups for a contact
Returns all group ids for a contact
Returns all groups nested directly under a group
Gets a single field from a record
Parameters
$strGroupId
string
A record's group_id
Returns all of the contacts in a specific group
Returns the number of contacts in a group
Returns the number of records in the database (matching the filter if specified)
Determines whether a contact is a part of a group
Return
Is contact in group
Removes a contact from a group
Saves a record into the database
Saves a specific column of a row into a database
Parameters
$strGroupId
string
A record's group_id
Return
Array of
Groups that match the search query.
