mailslurp.Api.GroupControllerApi
All URIs are relative to https://csharp.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 | |
| GetGroups | GET /groups | Get all groups |
| RemoveContactsFromGroup | DELETE /groups/{groupId}/contacts | Remove contacts from a group |
GroupContactsDto AddContactsToGroup (Guid groupId, UpdateGroupContacts updateGroupContacts)
Add contacts to a group
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class AddContactsToGroupExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
var updateGroupContacts = new UpdateGroupContacts(); // UpdateGroupContacts |
try
{
// Add contacts to a group
GroupContactsDto result = apiInstance.AddContactsToGroup(groupId, updateGroupContacts);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.AddContactsToGroup: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid | ||
| updateGroupContacts | UpdateGroupContacts |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GroupDto CreateGroup (CreateGroupOptions createGroupOptions)
Create a group
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class CreateGroupExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var createGroupOptions = new CreateGroupOptions(); // CreateGroupOptions |
try
{
// Create a group
GroupDto result = apiInstance.CreateGroup(createGroupOptions);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.CreateGroup: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| createGroupOptions | CreateGroupOptions |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 201 | Created | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
void DeleteGroup (Guid groupId)
Delete group
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class DeleteGroupExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
try
{
// Delete group
apiInstance.DeleteGroup(groupId);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.DeleteGroup: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid |
Return type
void (empty response body)
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: Not defined
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 204 | No Content | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageGroupProjection GetAllGroups (int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null)
Get all Contact Groups in paginated format
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetAllGroupsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var page = 56; // int? | Optional page in list pagination (optional) (default to 0)
var size = 56; // int? | Optional page size in list pagination (optional) (default to 20)
var sort = sort_example; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var since = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at after the given timestamp (optional)
var before = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at before the given timestamp (optional)
try
{
// Get all Contact Groups in paginated format
PageGroupProjection result = apiInstance.GetAllGroups(page, size, sort, since, before);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.GetAllGroups: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| page | int? | Optional page in list pagination | [optional] [default to 0] |
| size | int? | Optional page size in list pagination | [optional] [default to 20] |
| sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] |
| since | DateTime? | Filter by created at after the given timestamp | [optional] |
| before | DateTime? | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GroupDto GetGroup (Guid groupId)
Get group
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetGroupExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
try
{
// Get group
GroupDto result = apiInstance.GetGroup(groupId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.GetGroup: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GroupContactsDto GetGroupWithContacts (Guid groupId)
Get group and contacts belonging to it
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetGroupWithContactsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
try
{
// Get group and contacts belonging to it
GroupContactsDto result = apiInstance.GetGroupWithContacts(groupId);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.GetGroupWithContacts: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
PageContactProjection GetGroupWithContactsPaginated (Guid groupId, int? page = null, int? size = null, string sort = null, DateTime? since = null, DateTime? before = null)
Get group and paginated contacts belonging to it
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetGroupWithContactsPaginatedExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
var page = 56; // int? | Optional page in group contact pagination (optional) (default to 0)
var size = 56; // int? | Optional page size in group contact pagination (optional) (default to 20)
var sort = sort_example; // string | Optional createdAt sort direction ASC or DESC (optional) (default to ASC)
var since = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at after the given timestamp (optional)
var before = 2013-10-20T19:20:30+01:00; // DateTime? | Filter by created at before the given timestamp (optional)
try
{
PageContactProjection result = apiInstance.GetGroupWithContactsPaginated(groupId, page, size, sort, since, before);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.GetGroupWithContactsPaginated: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid | ||
| page | int? | Optional page in group contact pagination | [optional] [default to 0] |
| size | int? | Optional page size in group contact pagination | [optional] [default to 20] |
| sort | string | Optional createdAt sort direction ASC or DESC | [optional] [default to ASC] |
| since | DateTime? | Filter by created at after the given timestamp | [optional] |
| before | DateTime? | Filter by created at before the given timestamp | [optional] |
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
List
GetGroups ()
Get all groups
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class GetGroupsExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
try
{
// Get all groups
List<GroupProjection> result = apiInstance.GetGroups();
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.GetGroups: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
This endpoint does not need any parameter.
Return type
Authorization
HTTP request headers
- Content-Type: Not defined
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]
GroupContactsDto RemoveContactsFromGroup (Guid groupId, UpdateGroupContacts updateGroupContacts)
Remove contacts from a group
Example
using System.Collections.Generic;
using System.Diagnostics;
using mailslurp.Api;
using mailslurp.Client;
using mailslurp.Model;
namespace Example
{
public class RemoveContactsFromGroupExample
{
public static void Main()
{
Configuration config = new Configuration();
config.BasePath = "https://csharp.api.mailslurp.com";
// Configure API key authorization: API_KEY
config.AddApiKey("x-api-key", "YOUR_API_KEY");
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// config.AddApiKeyPrefix("x-api-key", "Bearer");
var apiInstance = new GroupControllerApi(config);
var groupId = new Guid(); // Guid |
var updateGroupContacts = new UpdateGroupContacts(); // UpdateGroupContacts |
try
{
// Remove contacts from a group
GroupContactsDto result = apiInstance.RemoveContactsFromGroup(groupId, updateGroupContacts);
Debug.WriteLine(result);
}
catch (ApiException e)
{
Debug.Print("Exception when calling GroupControllerApi.RemoveContactsFromGroup: " + e.Message );
Debug.Print("Status Code: "+ e.ErrorCode);
Debug.Print(e.StackTrace);
}
}
}
}
Parameters
| Name | Type | Description | Notes |
|---|---|---|---|
| groupId | Guid | ||
| updateGroupContacts | UpdateGroupContacts |
Return type
Authorization
HTTP request headers
- Content-Type: application/json
- Accept: /
HTTP response details
| Status code | Description | Response headers |
|---|---|---|
| 200 | OK | - |
[Back to top] [Back to API list] [Back to Model list] [Back to ]