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 |
AddingCriteriaToSegmentsResponse AddingCriteriaToSegments($format, $mailingListID, $apikey, $segmentID, $body)
Adding criteria to segments
Adds a new criterion (a rule) to the specified segment.
| 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 |
AddingCriteriaToSegmentsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| 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 |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| 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. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| 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. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| 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. |
GettingSegmentSubscribersResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GettingSegmentsResponse GettingSegments($format, $mailingListID, $apikey)
Getting segments
Get a list of all segments with their criteria for the given mailing list.
| 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. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
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.
| 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 |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatingSegmentCriteriaResponse UpdatingSegmentCriteria($format, $mailingListID, $apikey, $segmentID, $criteriaID, $body)
Updating segment criteria
Updates an existing criterion in the specified segment.
| 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 | float64 | The ID of the criterion to process. | |
| body | UpdatingSegmentCriteriaRequest |
UpdatingSegmentCriteriaResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]