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 |
CreatingACustomFieldResponse CreatingACustomField($format, $apikey, $mailingListID, $body)
Creating a custom field
Creates a new custom field in the specified mailing 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 where the custom field will belong. | |
body | CreatingACustomFieldRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
CreatingAMailingListResponse CreatingAMailingList($format, $apikey, $body)
Creating a mailing list
Creates a new empty mailing list in your 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 | CreatingAMailingListRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
DeletingAMailingListResponse DeletingAMailingList($format, $apikey, $mailingListID)
Deleting a mailing list
Deletes a mailing list from your account.
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 be deleted. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GettingAllActiveMailingListsResponse GettingAllActiveMailingLists($format, $apikey, $withStatistics, $shortBy, $sortMethod)
Getting all active mailing lists
Gets a list of your active mailing lists in your account.
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] |
GettingAllActiveMailingListsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GettingAllActiveMailingListsWithPagingResponse GettingAllActiveMailingListsWithPaging($format, $apikey, $page, $pageSize, $shortBy, $sortMethod)
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.
Name | Type | Description | Notes |
---|---|---|---|
format | string | ||
apikey | string | You may find your API Key or generate a new one in your account settings. | |
page | float64 | The page that you want to get. | |
pageSize | float64 | 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] |
GettingAllActiveMailingListsWithPagingResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
GettingMailingListDetailsResponse GettingMailingListDetails($format, $mailingListID, $apikey, $withStatistics)
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.
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] |
GettingMailingListDetailsResponse
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
RemovingACustomFieldResponse RemovingACustomField($format, $customFieldID, $apikey, $mailingListID)
Removing a custom field
Removes a custom field definition from the specified mailing list.
Name | Type | Description | Notes |
---|---|---|---|
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. |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatingACustomFieldResponse UpdatingACustomField($format, $customFieldID, $apikey, $mailingListID, $body)
Updating a custom field
Updates the properties of an existing custom field in the specified mailing list.
Name | Type | Description | Notes |
---|---|---|---|
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 |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]
UpdatingAMailingListResponse UpdatingAMailingList($format, $apikey, $mailingListID, $body)
Updating a mailing list
Updates the properties of an existing mailing 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 be updated. | |
body | UpdatingAMailingListRequest |
No authorization required
- Content-Type: application/json
- Accept: application/json
[Back to top] [Back to API list] [Back to Model list] [Back to README]