# MailSlurp\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(ctx, groupId, updateGroupContactsOption)

Add contacts to a group

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId
updateGroupContactsOption UpdateGroupContacts updateGroupContactsOption

# Return type

GroupContactsDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# CreateGroup

GroupDto CreateGroup(ctx, createGroupOptions)

Create a group

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
createGroupOptions CreateGroupOptions createGroupOptions

# Return type

GroupDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# DeleteGroup

DeleteGroup(ctx, groupId)

Delete group

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId

# Return type

(empty response body)

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetAllGroups

PageGroupProjection GetAllGroups(ctx, optional)

Get all Contact Groups in paginated format

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
optional *GetAllGroupsOpts optional parameters nil if no parameters

# Optional Parameters

Optional parameters are passed through a pointer to a GetAllGroupsOpts struct

Name Type Description Notes
page optional.Int32 Optional page index in inbox list pagination [default to 0]
size optional.Int32 Optional page size in inbox list pagination [default to 20]
sort optional.String Optional createdAt sort direction ASC or DESC [default to ASC]

# Return type

PageGroupProjection

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetGroup

GroupDto GetGroup(ctx, groupId)

Get group

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId

# Return type

GroupDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetGroupWithContacts

GroupContactsDto GetGroupWithContacts(ctx, groupId)

Get group and contacts belonging to it

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId

# Return type

GroupContactsDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetGroupWithContactsPaginated

PageContactProjection GetGroupWithContactsPaginated(ctx, groupId, optional)

Get group and paginated contacts belonging to it

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId
optional *GetGroupWithContactsPaginatedOpts optional parameters nil if no parameters

# Optional Parameters

Optional parameters are passed through a pointer to a GetGroupWithContactsPaginatedOpts struct

Name Type Description Notes

page | optional.Int32| Optional page index in group contact pagination | [default to 0] size | optional.Int32| Optional page size in group contact pagination | [default to 20] sort | optional.String| Optional createdAt sort direction ASC or DESC | [default to ASC]

# Return type

PageContactProjection

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# GetGroups

[]GroupProjection GetGroups(ctx, )

Get all groups

# Required Parameters

This endpoint does not need any parameter.

# Return type

[]GroupProjection

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]

# RemoveContactsFromGroup

GroupContactsDto RemoveContactsFromGroup(ctx, groupId, updateGroupContactsOption)

Remove contacts from a group

# Required Parameters

Name Type Description Notes
ctx context.Context context for authentication, logging, cancellation, deadlines, tracing, etc.
groupId string groupId
updateGroupContactsOption UpdateGroupContacts updateGroupContactsOption

# Return type

GroupContactsDto

# Authorization

API_KEY

# HTTP request headers

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

[Back to top] [Back to API list] [Back to Model list] [Back to README]