# \GroupControllerApi

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

Method HTTP request Description
add_contacts_to_group Put /groups/{groupId}/contacts Add contacts to a group
create_group Post /groups Create a group
delete_group Delete /groups/{groupId} Delete group
get_all_groups Get /groups/paginated Get all Contact Groups in paginated format
get_group Get /groups/{groupId} Get group
get_group_with_contacts Get /groups/{groupId}/contacts Get group and contacts belonging to it
get_group_with_contacts_paginated Get /groups/{groupId}/contacts-paginated Get group and paginated contacts belonging to it
get_groups Get /groups Get all groups
remove_contacts_from_group Delete /groups/{groupId}/contacts Remove 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

Name Type Description Required Notes
group_id String groupId [required]
update_group_contacts_option UpdateGroupContacts updateGroupContactsOption [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 README]

# create_group

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

# Parameters

Name Type Description Required Notes
create_group_options CreateGroupOptions createGroupOptions [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 README]

# delete_group

delete_group(group_id) Delete group

# Parameters

Name Type Description Required Notes
group_id String groupId [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 README]

# get_all_groups

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

# Parameters

Name Type Description Required Notes
page Option<i32> Optional page index in inbox list pagination [default to 0]
size Option<i32> Optional page size in inbox list pagination [default to 20]
sort Option<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 README]

# get_group

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

# Parameters

Name Type Description Required Notes
group_id String groupId [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 README]

# get_group_with_contacts

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

# Parameters

Name Type Description Required Notes
group_id String groupId [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 README]

# get_group_with_contacts_paginated

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

# Parameters

Name Type Description Required Notes
group_id String groupId [required]
page Option<i32> Optional page index in group contact pagination [default to 0]
size Option<i32> Optional page size in group contact pagination [default to 20]
sort Option<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 README]

# 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 README]

# remove_contacts_from_group

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

# Parameters

Name Type Description Required Notes
group_id String groupId [required]
update_group_contacts_option UpdateGroupContacts updateGroupContactsOption [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 README]