Moosend.Wrappers.CSharpWrapper.Api.SegmentsApi

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

Method	HTTP request	Description
AddingCriteriaToSegments	POST /lists/{MailingListID}/segments/{SegmentID}/criteria/add.{Format}	Adding criteria to segments
CreatingANewSegment	POST /lists/{MailingListID}/segments/create.{Format}	Creating a new segment
DeletingASegment	DELETE /lists/{MailingListID}/segments/{SegmentID}/delete.{Format}	Deleting A Segment
GettingSegmentDetails	GET /lists/{MailingListID}/segments/{SegmentID}/details.{Format}	Getting segment details
GettingSegmentSubscribers	GET /lists/{MailingListID}/segments/{SegmentID}/members.{Format}	Getting segment subscribers
GettingSegments	GET /lists/{MailingListID}/segments.{Format}	Getting segments
UpdatingASegment	POST /lists/{MailingListID}/segments/{SegmentID}/update.{Format}	Updating a segment
UpdatingSegmentCriteria	POST /lists/{MailingListID}/segments/{SegmentID}/criteria/{CriteriaID}/update.{Format}	Updating segment criteria

AddingCriteriaToSegments

AddingCriteriaToSegmentsResponse AddingCriteriaToSegments (string format, string mailingListID, string apikey, string segmentID, AddingCriteriaToSegmentsRequest body)

Adding criteria to segments

Adds a new criterion (a rule) to the specified segment.

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 AddingCriteriaToSegmentsExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var segmentID = segmentID_example;  // string | The ID of the segment to update.
            var body = new AddingCriteriaToSegmentsRequest(); // AddingCriteriaToSegmentsRequest | 

            try
            {
                // Adding criteria to segments
                AddingCriteriaToSegmentsResponse result = apiInstance.AddingCriteriaToSegments(format, mailingListID, apikey, segmentID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.AddingCriteriaToSegments: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs.
apikey	string	You may find your API Key or generate a new one in your account settings.
segmentID	string	The ID of the segment to update.
body	AddingCriteriaToSegmentsRequest

Return type

AddingCriteriaToSegmentsResponse

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]

CreatingANewSegment

CreatingANewSegmentResponse CreatingANewSegment (string format, string mailingListID, string apikey, CreatingANewSegmentRequest body)

Creating a new segment

Creates a new empty segment (without criteria) for the given mailing list. You may specify the name of the segment and the way the criteria will match together.

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 CreatingANewSegmentExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var body = new CreatingANewSegmentRequest(); // CreatingANewSegmentRequest | 

            try
            {
                // Creating a new segment
                CreatingANewSegmentResponse result = apiInstance.CreatingANewSegment(format, mailingListID, apikey, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.CreatingANewSegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs
apikey	string	You may find your API Key or generate a new one in your account settings.
body	CreatingANewSegmentRequest

Return type

CreatingANewSegmentResponse

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]

DeletingASegment

DeletingASegmentResponse DeletingASegment (string format, string mailingListID, string apikey, string segmentID)

Deleting A Segment

Deletes a segment along with its criteria from the mailing list. The subscribers of the mailing list that the segment returned are not deleted or affected in any way.

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 DeletingASegmentExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var segmentID = segmentID_example;  // string | The ID of the segment to update.

            try
            {
                // Deleting A Segment
                DeletingASegmentResponse result = apiInstance.DeletingASegment(format, mailingListID, apikey, segmentID);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.DeletingASegment: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

DeletingASegmentResponse

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]

GettingSegmentDetails

GettingSegmentDetailsResponse GettingSegmentDetails (string format, string mailingListID, string segmentID, string apikey)

Getting segment details

Gets detailed information on a specific segment and its criteria. However, it does not include the subscribers returned by the segment.

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 GettingSegmentDetailsExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs
            var segmentID = segmentID_example;  // string | The ID of the segment to fetch results for.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.

            try
            {
                // Getting segment details
                GettingSegmentDetailsResponse result = apiInstance.GettingSegmentDetails(format, mailingListID, segmentID, apikey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.GettingSegmentDetails: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs
segmentID	string	The ID of the segment to fetch results for.
apikey	string	You may find your API Key or generate a new one in your account settings.

Return type

GettingSegmentDetailsResponse

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]

GettingSegmentSubscribers

GettingSegmentSubscribersResponse GettingSegmentSubscribers (string format, string mailingListID, string segmentID, string apikey)

Getting segment subscribers

Gets a list of the subscribers that the specified segment returns according to its criteria. 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 GettingSegmentSubscribersExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs
            var segmentID = segmentID_example;  // string | The ID of the segment to fetch results for.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.

            try
            {
                // Getting segment subscribers
                GettingSegmentSubscribersResponse result = apiInstance.GettingSegmentSubscribers(format, mailingListID, segmentID, apikey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.GettingSegmentSubscribers: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs
segmentID	string	The ID of the segment to fetch results for.
apikey	string	You may find your API Key or generate a new one in your account settings.

Return type

GettingSegmentSubscribersResponse

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]

GettingSegments

GettingSegmentsResponse GettingSegments (string format, string mailingListID, string apikey)

Getting segments

Get a list of all segments with their criteria for the given 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 GettingSegmentsExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | 
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.

            try
            {
                // Getting segments
                GettingSegmentsResponse result = apiInstance.GettingSegments(format, mailingListID, apikey);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.GettingSegments: " + e.Message );
            }
        }
    }
}

Parameters

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

Return type

GettingSegmentsResponse

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]

UpdatingASegment

UpdatingASegmentResponse UpdatingASegment (string format, string mailingListID, string apikey, string segmentID, UpdatingASegmentRequest body)

Updating a segment

Updates the properties of an existing segment. You may update the name and match type of the segment.

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 UpdatingASegmentExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var segmentID = segmentID_example;  // string | The ID of the segment to update.
            var body = new UpdatingASegmentRequest(); // UpdatingASegmentRequest | 

            try
            {
                // Updating a segment
                UpdatingASegmentResponse result = apiInstance.UpdatingASegment(format, mailingListID, apikey, segmentID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.UpdatingASegment: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs
apikey	string	You may find your API Key or generate a new one in your account settings.
segmentID	string	The ID of the segment to update.
body	UpdatingASegmentRequest

Return type

UpdatingASegmentResponse

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]

UpdatingSegmentCriteria

UpdatingSegmentCriteriaResponse UpdatingSegmentCriteria (string format, string mailingListID, string apikey, string segmentID, double? criteriaID, UpdatingSegmentCriteriaRequest body)

Updating segment criteria

Updates an existing criterion in the specified segment.

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 UpdatingSegmentCriteriaExample
    {
        public void main()
        {
            var apiInstance = new SegmentsApi();
            var format = format_example;  // string | 
            var mailingListID = mailingListID_example;  // string | The ID of the mailing list the specified segment belongs.
            var apikey = apikey_example;  // string | You may find your API Key or generate a new one in your account settings.
            var segmentID = segmentID_example;  // string | The ID of the segment to update.
            var criteriaID = 1.2;  // double? | The ID of the criterion to process.
            var body = new UpdatingSegmentCriteriaRequest(); // UpdatingSegmentCriteriaRequest | 

            try
            {
                // Updating segment criteria
                UpdatingSegmentCriteriaResponse result = apiInstance.UpdatingSegmentCriteria(format, mailingListID, apikey, segmentID, criteriaID, body);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling SegmentsApi.UpdatingSegmentCriteria: " + e.Message );
            }
        }
    }
}

Parameters

Name	Type	Description
format	string
mailingListID	string	The ID of the mailing list the specified segment belongs.
apikey	string	You may find your API Key or generate a new one in your account settings.
segmentID	string	The ID of the segment to update.
criteriaID	double?	The ID of the criterion to process.
body	UpdatingSegmentCriteriaRequest

Return type

UpdatingSegmentCriteriaResponse

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

SegmentsApi.md

Latest commit

History

SegmentsApi.md

File metadata and controls

Moosend.Wrappers.CSharpWrapper.Api.SegmentsApi

AddingCriteriaToSegments

Example

Parameters

Return type

Authorization

HTTP request headers

CreatingANewSegment

Example

Parameters

Return type

Authorization

HTTP request headers

DeletingASegment

Example

Parameters

Return type

Authorization

HTTP request headers

GettingSegmentDetails

Example

Parameters

Return type

Authorization

HTTP request headers

GettingSegmentSubscribers

Example

Parameters

Return type

Authorization

HTTP request headers

GettingSegments

Example

Parameters

Return type

Authorization

HTTP request headers

UpdatingASegment

Example

Parameters

Return type

Authorization

HTTP request headers

UpdatingSegmentCriteria

Example

Parameters

Return type

Authorization

HTTP request headers