ContactGroups
Create, update, delete and query Contact Groups.
Table Specific Information
Select
The ContactGroups table supports the Id and MemberCount columns in the WHERE clause. The supported operators are '=, in' for Id and '=' for MemberCount.
For example:
SELECT * FROM [ContactGroups] WHERE Id = 'myContacts' SELECT * FROM [ContactGroups] WHERE Id = '45a15a878be3580a' SELECT * FROM [ContactGroups] WHERE Id = '4fe7dbbd0d26cc95' AND MemberCount = 10
INSERT
To create a new ContactGroup, the Name is required. You can also insert data to ClientData columns
INSERT INTO [ContactGroups] (Name) VALUES ('Contacts Group Test')
To insert ClientData for a contactGroup, you can use the #TEMP table or create the JSON structure to provide the values to insert.
INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 1', 'sfsdfsds45rf') INSERT INTO ClientData#TEMP (ClientDataKey, ClientDataValue) VALUES ('Client Data 2', '2jfk24g78w2jbdk') INSERT INTO ContactGroups (Name, ClientData) VALUES ('Insert ClientData to a Contact Group 2', 'ClientData#TEMP')
INSERT INTO ContactGroups (Name, ClientData) VALUES ('Testing Insert ClientData in Contact Group via client data columns', '[{"key": "Client Data 1","value": "sdfjkbq36"},{"key": "Client Data 2","value": "df32jkbk"}]')
Update
You can update the Name, ClientData of a ContactGroups row (except for System Groups (GroupType As SYSTEM_CONTACT_GROUP) like My Contacts, Coworkers, and Friends) by specifying the Id column.
UPDATE [ContactGroups] SET Name = 'Salsa Friends' WHERE Id = '674ddb258de3ef81'
Delete
To delete a ContactGroup, the Id is required.
DELETE FROM [ContactGroups] WHERE Id = '674ddb258de3ef81'
Columns
Name | Type | ReadOnly | Description |
Id [KEY] | String | True |
The Id of the contact group. |
ResourceName | String | True |
The ResourceName of the contact group. |
ETag | String | True |
The HTTP entity tag of the resource. |
Name | String | False |
The name of the contact group. |
GroupType | String | True |
The contact group type. |
FormattedName | String | True |
The group name formatted in the viewer's account locale. |
MemberCount | Integer | True |
The total number of contacts in the group irrespective of max members in specified in the request. |
MemberResourceNames | String | True |
The list of contact person resource names that are members of the contact group. |
MetadataUpdatedTime | Datetime | True |
The metadata of the contact group. |
MetadataDeleted | Boolean | True |
The metadata of the contact group. |
ClientData | String | False |
The group's client data. |
Pseudo-Columns
Pseudo column fields are used in the WHERE clause of SELECT statements and offer a more granular control over the tuples that are returned from the data source.
Name | Type | Description |
ClientDataKey | String |
The client specified key of the client data. |
ClientDataValue | String |
The client specified value of the client data. |