GroupControllerApi

All URIs are relative to https://api.mailslurp.com

MethodHTTP requestDescription
addContactsToGroupPUT /groups/{groupId}/contactsAdd contacts to a group
createGroupPOST /groupsCreate a group
deleteGroupDELETE /groups/{groupId}Delete group
getAllGroupsGET /groups/paginatedGet all Contact Groups in paginated format
getGroupGET /groups/{groupId}Get group
getGroupWithContactsGET /groups/{groupId}/contactsGet group and contacts belonging to it
getGroupWithContactsPaginatedGET /groups/{groupId}/contacts-paginatedGet group and paginated contacts belonging to it
getGroupsGET /groupsGet all groups
removeContactsFromGroupDELETE /groups/{groupId}/contactsRemove contacts from a group

addContactsToGroup

GroupContactsDto addContactsToGroup(groupId, updateGroupContactsOption)

Add contacts to a group

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption

Return type

GroupContactsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

createGroup

GroupDto createGroup(createGroupOptions)

Create a group

Parameters

NameTypeDescriptionNotes
createGroupOptionsCreateGroupOptionscreateGroupOptions

Return type

GroupDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

deleteGroup

deleteGroup(groupId)

Delete group

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]

Return type

null (empty response body)

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

getAllGroups

PageGroupProjection getAllGroups(before, page, since, size, sort)

Get all Contact Groups in paginated format

Parameters

NameTypeDescriptionNotes
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page in list pagination[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size in list pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageGroupProjection

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroup

GroupDto getGroup(groupId)

Get group

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]

Return type

GroupDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupWithContacts

GroupContactsDto getGroupWithContacts(groupId)

Get group and contacts belonging to it

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]

Return type

GroupContactsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

getGroupWithContactsPaginated

PageContactProjection getGroupWithContactsPaginated(groupId, before, page, since, size, sort)

Get group and paginated contacts belonging to it

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]
beforeDateFilter by created at before the given timestamp[optional] [default to null]
pageIntegerOptional page in group contact pagination[optional] [default to 0]
sinceDateFilter by created at after the given timestamp[optional] [default to null]
sizeIntegerOptional page size in group contact pagination[optional] [default to 20]
sortStringOptional createdAt sort direction ASC or DESC[optional] [default to ASC] [enum: ASC, DESC]

Return type

PageContactProjection

Authorization

API_KEY

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

List

Authorization

API_KEY

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

removeContactsFromGroup

GroupContactsDto removeContactsFromGroup(groupId, updateGroupContactsOption)

Remove contacts from a group

Parameters

NameTypeDescriptionNotes
groupIdUUIDgroupId[default to null]
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption

Return type

GroupContactsDto

Authorization

API_KEY

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json