Moosend.Wrappers.CSharpWrapper.Api.MailingListsApi

All URIs are relative to https://api.moosend.com/v3

Method	HTTP request	Description
CreatingACustomField	POST /lists/{MailingListID}/customfields/create.{Format}	Creating a custom field
CreatingAMailingList	POST /lists/create.{Format}	Creating a mailing list
DeletingAMailingList	DELETE /lists/{MailingListID}/delete.{Format}	Deleting a mailing list
GettingAllActiveMailingLists	GET /lists.{Format}	Getting all active mailing lists
GettingAllActiveMailingListsWithPaging	GET /lists/{Page}/{PageSize}.{Format}	Getting all active mailing lists with paging
GettingMailingListDetails	GET /lists/{MailingListID}/details.{Format}	Getting mailing list details
RemovingACustomField	DELETE /lists/{MailingListID}/customfields/{CustomFieldID}/delete.{Format}	Removing a custom field
UpdatingACustomField	POST /lists/{MailingListID}/customfields/{CustomFieldID}/update.{Format}	Updating a custom field
UpdatingAMailingList	POST /lists/{MailingListID}/update.{Format}	Updating a mailing list

CreatingACustomField

CreatingACustomFieldResponse CreatingACustomField (string format, string apikey, string mailingListID, CreatingACustomFieldRequest body)

Creating a custom field

Creates a new custom field in the specified mailing list.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class CreatingACustomFieldExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list where the custom field will belong.
            var body = new CreatingACustomFieldRequest(); // CreatingACustomFieldRequest | 

            try
            {
                // Creating a custom field
                CreatingACustomFieldResponse result = apiInstance.CreatingACustomField(format, apikey, mailingListID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.CreatingACustomField: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
mailingListID	string	The ID of the mailing list where the custom field will belong.
body	CreatingACustomFieldRequest

Return type

CreatingACustomFieldResponse

Authorization

No authorization required

HTTP request headers

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

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

CreatingAMailingList

CreatingAMailingListResponse CreatingAMailingList (string format, string apikey, CreatingAMailingListRequest body)

Creating a mailing list

Creates a new empty mailing list in your account.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class CreatingAMailingListExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var body = new CreatingAMailingListRequest(); // CreatingAMailingListRequest | 

            try
            {
                // Creating a mailing list
                CreatingAMailingListResponse result = apiInstance.CreatingAMailingList(format, apikey, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.CreatingAMailingList: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
body	CreatingAMailingListRequest

Return type

CreatingAMailingListResponse

Authorization

No authorization required

HTTP request headers

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

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

DeletingAMailingList

DeletingAMailingListResponse DeletingAMailingList (string format, string apikey, string mailingListID)

Deleting a mailing list

Deletes a mailing list from your account.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class DeletingAMailingListExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list to be deleted.

            try
            {
                // Deleting a mailing list
                DeletingAMailingListResponse result = apiInstance.DeletingAMailingList(format, apikey, mailingListID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.DeletingAMailingList: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
mailingListID	string	The ID of the mailing list to be deleted.

Return type

DeletingAMailingListResponse

Authorization

No authorization required

HTTP request headers

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

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

GettingAllActiveMailingLists

GettingAllActiveMailingListsResponse GettingAllActiveMailingLists (string format, string apikey, string withStatistics = null, string shortBy = null, string sortMethod = null)

Getting all active mailing lists

Gets a list of your active mailing lists in your account.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class GettingAllActiveMailingListsExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var withStatistics = withStatistics_example;  // string | Specifies whether to fetch statistics for the subscribers or not. If omitted, results will be returned with statistics by default. (optional) 
            var shortBy = shortBy_example;  // string | The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property (optional) 
            var sortMethod = sortMethod_example;  // string | The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed (optional) 

            try
            {
                // Getting all active mailing lists
                GettingAllActiveMailingListsResponse result = apiInstance.GettingAllActiveMailingLists(format, apikey, withStatistics, shortBy, sortMethod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.GettingAllActiveMailingLists: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
withStatistics	string	Specifies whether to fetch statistics for the subscribers or not. If omitted, results will be returned with statistics by default.	[optional]
shortBy	string	The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property	[optional]
sortMethod	string	The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed	[optional]

Return type

GettingAllActiveMailingListsResponse

Authorization

No authorization required

HTTP request headers

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

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

GettingAllActiveMailingListsWithPaging

GettingAllActiveMailingListsWithPagingResponse GettingAllActiveMailingListsWithPaging (string format, string apikey, double? page, double? pageSize, string shortBy = null, string sortMethod = null)

Getting all active mailing lists with paging

Gets a list of your active mailing lists in your account. Because the results for this call could be quite big, paging information is required as input.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class GettingAllActiveMailingListsWithPagingExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var page = 1.2;  // double? | The page that you want to get.
            var pageSize = 1.2;  // double? | Lists Per Page.
            var shortBy = shortBy_example;  // string | The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property (optional) 
            var sortMethod = sortMethod_example;  // string | The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed (optional) 

            try
            {
                // Getting all active mailing lists with paging
                GettingAllActiveMailingListsWithPagingResponse result = apiInstance.GettingAllActiveMailingListsWithPaging(format, apikey, page, pageSize, shortBy, sortMethod);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.GettingAllActiveMailingListsWithPaging: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
page	double?	The page that you want to get.
pageSize	double?	Lists Per Page.
shortBy	string	The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property	[optional]
sortMethod	string	The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed	[optional]

Return type

GettingAllActiveMailingListsWithPagingResponse

Authorization

No authorization required

HTTP request headers

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

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

GettingMailingListDetails

GettingMailingListDetailsResponse GettingMailingListDetails (string format, string mailingListID, string apikey, string withStatistics = null)

Getting mailing list details

Gets details for a given mailing list. You may include subscriber statistics in your results or not. Any segments existing for the requested mailing list will not be included in the results.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class GettingMailingListDetailsExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list to be returned.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var withStatistics = withStatistics_example;  // string | Specifies whether to fetch statistics for the subscribers or not. If omitted, results will be returned with statistics by default. (optional) 

            try
            {
                // Getting mailing list details
                GettingMailingListDetailsResponse result = apiInstance.GettingMailingListDetails(format, mailingListID, apikey, withStatistics);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.GettingMailingListDetails: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description	Notes
format	string
mailingListID	string	The ID of the mailing list to be returned.
apikey	string	You may find your API Key or generate a new one in your account settings.
withStatistics	string	Specifies whether to fetch statistics for the subscribers or not. If omitted, results will be returned with statistics by default.	[optional]

Return type

GettingMailingListDetailsResponse

Authorization

No authorization required

HTTP request headers

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

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

RemovingACustomField

RemovingACustomFieldResponse RemovingACustomField (string format, string customFieldID, string apikey, string mailingListID)

Removing a custom field

Removes a custom field definition from the specified mailing list.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class RemovingACustomFieldExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var customFieldID = customFieldID_example;  // string | The ID of the custom field to be deleted.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list where the custom field belongs.

            try
            {
                // Removing a custom field
                RemovingACustomFieldResponse result = apiInstance.RemovingACustomField(format, customFieldID, apikey, mailingListID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.RemovingACustomField: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
customFieldID	string	The ID of the custom field to be deleted.
apikey	string	You may find your API Key or generate a new one in your account settings.
mailingListID	string	The ID of the mailing list where the custom field belongs.

Return type

RemovingACustomFieldResponse

Authorization

No authorization required

HTTP request headers

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

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

UpdatingACustomField

UpdatingACustomFieldResponse UpdatingACustomField (string format, string customFieldID, string apikey, string mailingListID, UpdatingACustomFieldRequest body)

Updating a custom field

Updates the properties of an existing custom field in the specified mailing list.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class UpdatingACustomFieldExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var customFieldID = customFieldID_example;  // string | The ID of the custom field to be updated.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list where the custom field belongs.
            var body = new UpdatingACustomFieldRequest(); // UpdatingACustomFieldRequest | 

            try
            {
                // Updating a custom field
                UpdatingACustomFieldResponse result = apiInstance.UpdatingACustomField(format, customFieldID, apikey, mailingListID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.UpdatingACustomField: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
customFieldID	string	The ID of the custom field to be updated.
apikey	string	You may find your API Key or generate a new one in your account settings.
mailingListID	string	The ID of the mailing list where the custom field belongs.
body	UpdatingACustomFieldRequest

Return type

UpdatingACustomFieldResponse

Authorization

No authorization required

HTTP request headers

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

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

UpdatingAMailingList

UpdatingAMailingListResponse UpdatingAMailingList (string format, string apikey, string mailingListID, UpdatingAMailingListRequest body)

Updating a mailing list

Updates the properties of an existing mailing list.

Example

using System;
using System.Diagnostics;
using Moosend.Wrappers.CSharpWrapper.Api;
using Moosend.Wrappers.CSharpWrapper.Client;
using Moosend.Wrappers.CSharpWrapper.Model;

namespace Example
{
    public class UpdatingAMailingListExample
    {
        public void main()
        {
            var apiInstance = new MailingListsApi();
            var format = format_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list to be updated.
            var body = new UpdatingAMailingListRequest(); // UpdatingAMailingListRequest | 

            try
            {
                // Updating a mailing list
                UpdatingAMailingListResponse result = apiInstance.UpdatingAMailingList(format, apikey, mailingListID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling MailingListsApi.UpdatingAMailingList: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
apikey	string	You may find your API Key or generate a new one in your account settings.
mailingListID	string	The ID of the mailing list to be updated.
body	UpdatingAMailingListRequest

Return type

UpdatingAMailingListResponse

Authorization

No authorization required

HTTP request headers

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

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

Files

MailingListsApi.md

Latest commit

History

MailingListsApi.md

File metadata and controls

Moosend.Wrappers.CSharpWrapper.Api.MailingListsApi

CreatingACustomField

Example

Parameters

Return type

Authorization

HTTP request headers

CreatingAMailingList

Example

Parameters

Return type

Authorization

HTTP request headers

DeletingAMailingList

Example

Parameters

Return type

Authorization

HTTP request headers

GettingAllActiveMailingLists

Example

Parameters

Return type

Authorization

HTTP request headers

GettingAllActiveMailingListsWithPaging

Example

Parameters

Return type

Authorization

HTTP request headers

GettingMailingListDetails

Example

Parameters

Return type

Authorization

HTTP request headers

RemovingACustomField

Example

Parameters

Return type

Authorization

HTTP request headers

UpdatingACustomField

Example

Parameters

Return type

Authorization

HTTP request headers

UpdatingAMailingList

Example

Parameters

Return type

Authorization

HTTP request headers