All URIs are relative to https://api.moosend.com/v3
| Method | HTTP request | Description |
|---|---|---|
| AddingMultipleSubscribers | Post /subscribers/{MailingListID}/subscribe_many.{Format} | Adding multiple subscribers |
| AddingSubscribers | Post /subscribers/{MailingListID}/subscribe.{Format} | Adding subscribers |
| GetSubscriberByEmailAddress | Get /subscribers/{MailingListID}/view.{Format} | Get subscriber by email address |
| GetSubscriberById | Get /subscribers/{MailingListID}/find/{SubscriberID}.{Format} | Get subscriber by id |
| GettingSubscribers | Get /lists/{MailingListID}/subscribers/{Status}.{Format} | Getting subscribers |
| RemovingASubscriber | Post /subscribers/{MailingListID}/remove.{Format} | Removing a subscriber |
| RemovingMultipleSubscribers | Post /subscribers/{MailingListID}/remove_many.{Format} | Removing multiple subscribers |
| UnsubscribingSubscribersFromAccount | Post /subscribers/unsubscribe.{Format} | Unsubscribing subscribers from account |
| UnsubscribingSubscribersFromMailingList | Post /subscribers/{MailingListID}/unsubscribe.{Format} | Unsubscribing subscribers from mailing list |
| UnsubscribingSubscribersFromMailingListAndASpecifiedCampaign | Post /subscribers/{MailingListID}/{CampaignID}/unsubscribe.{Format} | Unsubscribing subscribers from mailing list and a specified campaign |
| UpdatingASubscriber | Post /subscribers/{MailingListID}/update/{SubscriberID}.{Format} | Updating a subscriber |
AddingMultipleSubscribersResponse AddingMultipleSubscribers($format, $apikey, $mailingListID, $body)
Adding multiple subscribers
This method allows you to add multiple subscribers in a mailing list with a single call. If some subscribers already exist with the given email addresses, they will be updated. If you try to add a subscriber with an invalid email address, this attempt will be ignored, as the process will skip to the next subscriber automatically.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 add subscribers to. | |
| body | AddingMultipleSubscribersRequest |
AddingMultipleSubscribersResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
AddingSubscribersResponse AddingSubscribers($format, $mailingListID, $apikey, $body)
Adding subscribers
Adds a new subscriber to the specified mailing list. If there is already a subscriber with the specified email address in the list, an update will be performed instead.
| Name | Type | Description | Notes |
|---|---|---|---|
| format | string | ||
| mailingListID | string | The ID of the mailing list to add the new member. | |
| apikey | string | You may find your API Key or generate a new one in your account settings. | |
| body | AddingSubscribersRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSubscriberByEmailAddressResponse GetSubscriberByEmailAddress($format, $apikey, $mailingListID, $email)
Get subscriber by email address
Searches for a subscriber with the specified email address in the specified mailing list and returns detailed information such as id, name, date created, date unsubscribed, status and custom fields
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 subscriber belongs. | |
| string | The email of the subscriber. |
GetSubscriberByEmailAddressResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GetSubscriberByIdResponse GetSubscriberById($format, $apikey, $mailingListID, $subscriberID)
Get subscriber by id
Searches for a subscriber with the specified unique id in the specified mailing list and returns detailed information such as email, name, date created, date unsubscribed, status and custom fields.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 search the subscriber in. | |
| subscriberID | string | The id of the subscriber being searched. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GettingSubscribersResponse GettingSubscribers($format, $mailingListID, $apikey, $status, $page, $pageSize)
Getting subscribers
Gets a list of all subscribers in a given mailing list. You may filter the list by setting a date to fetch those subscribed since then and/or by their status. 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 where the subscribers belong. | |
| apikey | string | You may find your API Key or generate a new one in your account settings. | |
| status | string | Specifies what type of subscriber statistics results will be returned. | |
| page | float64 | Specifies the page of subscriber statistics results will be returned. | [optional] |
| pageSize | float64 | Specifies the page size of subscriber statistics results will be returned. | [optional] |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemovingASubscriberResponse RemovingASubscriber($format, $apikey, $mailingListID, $body)
Removing a subscriber
Removes a subscriber from the specified mailing list permanently (without moving to the suppression list).
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 remove the subscriber from. | |
| body | RemovingASubscriberRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemovingMultipleSubscribersResponse RemovingMultipleSubscribers($format, $apikey, $mailingListID, $body)
Removing multiple subscribers
Removes a list of subscribers from the specified mailing list permanently (without putting them in the suppression list). Any invalid email addresses specified will be ignored.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 remove the subscribers from. | |
| body | RemovingMultipleSubscribersRequest |
RemovingMultipleSubscribersResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UnsubscribingSubscribersFromAccountResponse UnsubscribingSubscribersFromAccount($format, $apikey, $body)
Unsubscribing subscribers from account
Unsubscribes a subscriber from the account.
| Name | Type | Description | Notes |
|---|---|---|---|
| format | string | ||
| apikey | string | You may find your API Key or generate a new one in your account settings. | |
| body | UnsubscribingSubscribersFromAccountRequest |
UnsubscribingSubscribersFromAccountResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UnsubscribingSubscribersFromMailingListResponse UnsubscribingSubscribersFromMailingList($format, $apikey, $mailingListID, $body)
Unsubscribing subscribers from mailing list
Unsubscribes a subscriber from the specified mailing list. The subscriber is not deleted, but moved to the suppression list.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 add subscribers to. | |
| body | UnsubscribingSubscribersFromMailingListRequest |
UnsubscribingSubscribersFromMailingListResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse UnsubscribingSubscribersFromMailingListAndASpecifiedCampaign($format, $campaignID, $apikey, $mailingListID, $body)
Unsubscribing subscribers from mailing list and a specified campaign
Unsubscribes a subscriber from the specified mailing list and the specified campaign. The subscriber is not deleted, but moved to the suppression list. This call will take into account the setting you have in "suppression list and unsubscribe settings" and will remove the subscriber from all other mailing lists or not accordingly.
| Name | Type | Description | Notes |
|---|---|---|---|
| format | string | ||
| campaignID | string | The ID of the campaign that was sent to the specific mailing list. | |
| 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 remove the subscriber from. | |
| body | UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest |
UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatingASubscriberResponse UpdatingASubscriber($format, $apikey, $mailingListID, $subscriberID, $body)
Updating a subscriber
Updates a subscriber in the specified mailing list. You can even update the subscribers email, if he has not unsubscribed.
| Name | Type | Description | Notes |
|---|---|---|---|
| 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 that contains the subscriber | |
| subscriberID | string | The id of the subscriber to be updated | |
| body | UpdatingASubscriberRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]