Skip to content

Latest commit

 

History

History
465 lines (306 loc) · 15 KB

SegmentsApi.md

File metadata and controls

465 lines (306 loc) · 15 KB
Raw

MoosendApi.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(format, mailingListID, apikey, segmentID, body)

Adding criteria to segments

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

Example

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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 MoosendApi.AddingCriteriaToSegmentsRequest(); // AddingCriteriaToSegmentsRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.addingCriteriaToSegments(format, mailingListID, apikey, segmentID, body, callback);

Parameters

Name Type Description Notes
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

creatingANewSegment

CreatingANewSegmentResponse creatingANewSegment(format, mailingListID, apikey, 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

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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 MoosendApi.CreatingANewSegmentRequest(); // CreatingANewSegmentRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.creatingANewSegment(format, mailingListID, apikey, body, callback);

Parameters

Name Type Description Notes
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

deletingASegment

DeletingASegmentResponse deletingASegment(format, mailingListID, apikey, 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

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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 callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.deletingASegment(format, mailingListID, apikey, segmentID, callback);

Parameters

Name Type Description Notes
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

gettingSegmentDetails

GettingSegmentDetailsResponse gettingSegmentDetails(format, mailingListID, segmentID, 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

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.gettingSegmentDetails(format, mailingListID, segmentID, apikey, callback);

Parameters

Name Type Description Notes
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

gettingSegmentSubscribers

GettingSegmentSubscribersResponse gettingSegmentSubscribers(format, mailingListID, segmentID, 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

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.gettingSegmentSubscribers(format, mailingListID, segmentID, apikey, callback);

Parameters

Name Type Description Notes
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

gettingSegments

GettingSegmentsResponse gettingSegments(format, mailingListID, apikey)

Getting segments

Get a list of all segments with their criteria for the given mailing list.

Example

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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.


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.gettingSegments(format, mailingListID, apikey, callback);

Parameters

Name Type Description Notes
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

updatingASegment

UpdatingASegmentResponse updatingASegment(format, mailingListID, apikey, segmentID, body)

Updating a segment

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

Example

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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 MoosendApi.UpdatingASegmentRequest(); // UpdatingASegmentRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updatingASegment(format, mailingListID, apikey, segmentID, body, callback);

Parameters

Name Type Description Notes
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

updatingSegmentCriteria

UpdatingSegmentCriteriaResponse updatingSegmentCriteria(format, mailingListID, apikey, segmentID, criteriaID, body)

Updating segment criteria

Updates an existing criterion in the specified segment.

Example

var MoosendApi = require('moosend_api');

var apiInstance = new MoosendApi.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; // Number | The ID of the criterion to process.

var body = new MoosendApi.UpdatingSegmentCriteriaRequest(); // UpdatingSegmentCriteriaRequest | 


var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
apiInstance.updatingSegmentCriteria(format, mailingListID, apikey, segmentID, criteriaID, body, callback);

Parameters

Name Type Description Notes
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 Number 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