Google Groups
API actions for the Google Groups integration.
Google Groups
Manage Google Groups and membership.
Add member
Add a member to a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
member_email | string | Yes | Email address of the member to add |
role | string | No | Role for the member (OWNER, MANAGER, or MEMBER) |
Response
"user@example.com"Create group
Create a new Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
email | string | Yes | Email address for the new group |
name | string | Yes | Display name for the group |
description | string | No | Description of the group |
Response
"01abc234def56789"Delete group
Delete a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
Response
trueGet group
Retrieve details of a specific Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
Response
{
"description": "All engineering staff",
"email": "engineering@example.com",
"id": "01abc234def56789",
"name": "Engineering Team"
}List groups
Retrieve all Google Groups for the connected account.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
page_size | number | No | Maximum number of groups to return |
Response
[
{
"directMembersCount": "15",
"email": "engineering@example.com",
"id": "01abc234def56789",
"name": "Engineering Team"
}
]List members
List all members of a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
page_size | number | No | Maximum number of members to return |
Response
[
{
"email": "user@example.com",
"id": "112233445566778899",
"role": "MEMBER",
"type": "USER"
}
]Remove member
Remove a member from a Google Group.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
member_email | string | Yes | Email address of the member to remove |
Response
trueUpdate group
Update an existing Google Group's name, description, or email.
Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
group_key | string | Yes | Group email address or unique ID |
name | string | No | New display name for the group |
description | string | No | New description for the group |
new_email | string | No | New email address for the group |
Response
"01abc234def56789"