Group API Details
The Group APIs help you to manage the Groups, members, member roles and individual settings and Group admin settings.
While using Domain related API, use the OAuth scope organization.groups.
| Purpose of Method | URL | Method Type | OAuth Scope | Purpose |
| To get all groups in the organization | /api/organization/<zoid>/groups | GET | organization.groups | Get the details of all the groups in the organization |
| To get the details of a particular group | /api/organization/<zoid>/groups/<groupId> | GET | Get the details of one of the groups in the organization | |
| To create a new group | /api/organization/<zoid>/groups | POST | Create a new group with the specified settings | |
| To enable Streams for a new group | /api/organization/<zoid>/groups/<groupId | PUT | Enable Streams for a specific group | |
| To add mail group members | /api/organization/<zoid>/groups/<groupId> | PUT | Add group members and define the respective roles | |
| To change status of members | /api/organization/<zoid>/groups/<zgid> | PUT | Change the status of a member added to a group | |
| To change member roles | /api/organization/<zoid>/groups/<groupId> | PUT | Change the role of a member in a group | |
| To change member details | /api/organization/<zoid>/groups/<zgid> | PUT | Change the details of a member in a group | |
| To delete the group members | /api/organization/<zoid>/groups/<zgid> | DELETE | Delete the individual members from a group | |
| To update group name | /api/organization/<zoid>/groups/<groupId> | PUT | Update the name of the group | |
| To change general and text settings | /api/organization/<zoid>/groups/<groupId> | PUT | Update the general and text settings of the group | |
| To change admin settings | /api/organization/<zoid>/groups/<groupId> | PUT | Change the administrator settings of the group | |
| To get mails for moderation | /api/organization/<zoid>/groups/<groupId>/messages | GET | Get the group emails that need to be moderated | |
| To get moderated mail content | /api/organization/<zoid>/groups/<groupId>/messages | GET | Get the content of the emails that have been moderated | |
| To moderate mail | /api/organization/<zoid>/groups/<groupId> | PUT | Moderate the email | |
| To add email alias | /api/organization/<zoid>/groups/<groupId> | PUT | Add the group email alias | |
| To remove email alias | /api/organization/<zoid>/groups/<groupId> | PUT | Remove the group email alias | |
| To delete a group | /api/organization/<zoid>/groups/<groupId> | DELETE | Delete a group |