# GroupControllerApi
All URIs are relative to https://api.mailslurp.com
| Method | HTTP request | Description |
|---|---|---|
| addContactsToGroup | PUT /groups/{groupId}/contacts | Add contacts to a group |
| createGroup | POST /groups | Create a group |
| deleteGroup | DELETE /groups/{groupId} | Delete group |
| getAllGroups | GET /groups/paginated | Get all Contact Groups in paginated format |
| getGroup | GET /groups/{groupId} | Get group |
| getGroupWithContacts | GET /groups/{groupId}/contacts | Get group and contacts belonging to it |
| getGroupWithContactsPaginated | GET /groups/{groupId}/contacts-paginated | Get group and paginated contacts belonging to it |
| getGroups | GET /groups | Get all groups |
| removeContactsFromGroup | DELETE /groups/{groupId}/contacts | Remove contacts from a group |
# addContactsToGroup
GroupContactsDto addContactsToGroup(groupId, updateGroupContactsOption)
Add contacts to a group
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
| updateGroupContactsOption | UpdateGroupContacts | updateGroupContactsOption |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# createGroup
GroupDto createGroup(createGroupOptions)
Create a group
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| createGroupOptions | CreateGroupOptions | createGroupOptions |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
# deleteGroup
deleteGroup(groupId)
Delete group
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
# Return type
null (empty response body)
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
# getAllGroups
PageGroupProjection getAllGroups(page, size, sort)
Get all Contact Groups in paginated format
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | Integer | Optional page index in inbox list pagination | [optional] [default to 0] |
| size | Integer | Optional page size in inbox list pagination | [optional] [default to 20] |
| sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getGroup
GroupDto getGroup(groupId)
Get group
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getGroupWithContacts
GroupContactsDto getGroupWithContacts(groupId)
Get group and contacts belonging to it
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getGroupWithContactsPaginated
PageContactProjection getGroupWithContactsPaginated(groupId, page, size, sort)
Get group and paginated contacts belonging to it
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
| page | Integer | Optional page index in group contact pagination | [optional] [default to 0] |
| size | Integer | Optional page size in group contact pagination | [optional] [default to 20] |
| sort | String | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] [enum: ASC, DESC] |
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# getGroups
List getGroups()
Get all groups
# Parameters
This endpoint does not need any parameter.
# Return type
# Authorization
# HTTP request headers
- Content-Type: Not defined
- Accept: application/json
# removeContactsFromGroup
GroupContactsDto removeContactsFromGroup(groupId, updateGroupContactsOption)
Remove contacts from a group
# Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | UUID | groupId | [default to null] |
| updateGroupContactsOption | UpdateGroupContacts | updateGroupContactsOption |
# Return type
# Authorization
# HTTP request headers
- Content-Type: application/json
- Accept: application/json
