GroupControllerApi

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

MethodHTTP requestDescription
add_contacts_to_groupput /groups/{groupId}/contactsAdd contacts to a group
create_grouppost /groupsCreate a group
delete_groupdelete /groups/{groupId}Delete group
get_all_groupsget /groups/paginatedGet all Contact Groups in paginated format
get_groupget /groups/{groupId}Get group
get_group_with_contactsget /groups/{groupId}/contactsGet group and contacts belonging to it
get_group_with_contacts_paginatedget /groups/{groupId}/contacts-paginatedGet group and paginated contacts belonging to it
get_groupsget /groupsGet all groups
remove_contacts_from_groupdelete /groups/{groupId}/contactsRemove contacts from a group

add_contacts_to_group

crate::models::GroupContactsDto add_contacts_to_group(group_id, update_group_contacts_option) Add contacts to a group

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]
update_group_contacts_optionUpdateGroupContactsupdateGroupContactsOption[required]

Return type

crate::models::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 ]

create_group

crate::models::GroupDto create_group(create_group_options) Create a group

Parameters

NameTypeDescriptionRequiredNotes
create_group_optionsCreateGroupOptionscreateGroupOptions[required]

Return type

crate::models::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 ]

delete_group

delete_group(group_id) Delete group

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]

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 ]

get_all_groups

crate::models::PageGroupProjection get_all_groups(before, page, since, size, sort) Get all Contact Groups in paginated format

Parameters

NameTypeDescriptionRequiredNotes
beforeOption<String>Filter by created at before the given timestamp
pageOption<i32>Optional page in list pagination[default to 0]
sinceOption<String>Filter by created at after the given timestamp
sizeOption<i32>Optional page size in list pagination[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]

Return type

crate::models::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 ]

get_group

crate::models::GroupDto get_group(group_id) Get group

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]

Return type

crate::models::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 ]

get_group_with_contacts

crate::models::GroupContactsDto get_group_with_contacts(group_id) Get group and contacts belonging to it

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]

Return type

crate::models::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 ]

get_group_with_contacts_paginated

crate::models::PageContactProjection get_group_with_contacts_paginated(group_id, before, page, since, size, sort) Get group and paginated contacts belonging to it

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]
beforeOption<String>Filter by created at before the given timestamp
pageOption<i32>Optional page in group contact pagination[default to 0]
sinceOption<String>Filter by created at after the given timestamp
sizeOption<i32>Optional page size in group contact pagination[default to 20]
sortOption<String>Optional createdAt sort direction ASC or DESC[default to ASC]

Return type

crate::models::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 ]

get_groups

Veccrate::models::GroupProjection get_groups() Get all groups

Parameters

This endpoint does not need any parameter.

Return type

Veccrate::models::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 ]

remove_contacts_from_group

crate::models::GroupContactsDto remove_contacts_from_group(group_id, update_group_contacts_option) Remove contacts from a group

Parameters

NameTypeDescriptionRequiredNotes
group_idStringgroupId[required]
update_group_contacts_optionUpdateGroupContactsupdateGroupContactsOption[required]

Return type

crate::models::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 ]