MailSlurpGroupControllerApi

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

Add contacts to a group

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption

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 ]

CreateGroup

GroupDto CreateGroup(ctx, createGroupOptions)

Create a group

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
createGroupOptionsCreateGroupOptionscreateGroupOptions

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 ]

DeleteGroup

DeleteGroup(ctx, groupId)

Delete group

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId

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 ]

GetAllGroups

PageGroupProjection GetAllGroups(ctx, optional)

Get all Contact Groups in paginated format

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
optional*GetAllGroupsOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetAllGroupsOpts struct

NameTypeDescriptionNotes
beforeoptional.TimeFilter by created at before the given timestamp
pageoptional.Int32Optional page in list pagination[default to 0]
sinceoptional.TimeFilter by created at after the given timestamp
sizeoptional.Int32Optional page size in list pagination[default to 20]
sortoptional.StringOptional 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 ]

GetGroup

GroupDto GetGroup(ctx, groupId)

Get group

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId

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 ]

GetGroupWithContacts

GroupContactsDto GetGroupWithContacts(ctx, groupId)

Get group and contacts belonging to it

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId

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 ]

GetGroupWithContactsPaginated

PageContactProjection GetGroupWithContactsPaginated(ctx, groupId, optional)

Get group and paginated contacts belonging to it

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId
optional*GetGroupWithContactsPaginatedOptsoptional parametersnil if no parameters

Optional Parameters

Optional parameters are passed through a pointer to a GetGroupWithContactsPaginatedOpts struct

NameTypeDescriptionNotes

before | optional.Time| Filter by created at before the given timestamp | page | optional.Int32| Optional page in group contact pagination | [default to 0] since | optional.Time| Filter by created at after the given timestamp | 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 ]

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 ]

RemoveContactsFromGroup

GroupContactsDto RemoveContactsFromGroup(ctx, groupId, updateGroupContactsOption)

Remove contacts from a group

Required Parameters

NameTypeDescriptionNotes
ctxcontext.Contextcontext for authentication, logging, cancellation, deadlines, tracing, etc.
groupIdstringgroupId
updateGroupContactsOptionUpdateGroupContactsupdateGroupContactsOption

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 ]