{"id":18337717,"url":"https://github.com/moosend/api-wrappers-js","last_synced_at":"2025-10-22T21:37:05.790Z","repository":{"id":8230980,"uuid":"9671826","full_name":"moosend/api-wrappers-js","owner":"moosend","description":"Moosend API Javascript Wrapper","archived":false,"fork":false,"pushed_at":"2017-10-03T12:03:47.000Z","size":942,"stargazers_count":5,"open_issues_count":2,"forks_count":2,"subscribers_count":17,"default_branch":"master","last_synced_at":"2025-03-21T17:56:33.368Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/moosend.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2013-04-25T13:03:55.000Z","updated_at":"2021-12-17T16:22:10.000Z","dependencies_parsed_at":"2022-08-06T23:00:45.354Z","dependency_job_id":null,"html_url":"https://github.com/moosend/api-wrappers-js","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-js","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-js/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-js/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/moosend%2Fapi-wrappers-js/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/moosend","download_url":"https://codeload.github.com/moosend/api-wrappers-js/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247440339,"owners_count":20939221,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-05T20:12:06.958Z","updated_at":"2025-10-22T21:37:05.703Z","avatar_url":"https://github.com/moosend.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Moosend Javascript Wrapper\n\nThe following project is a Javascript implementation of the Moosend V3 API.\nYou can find the API documentation at http://docs.moosendapp.apiary.io/#\n\n## Installation\n\n```shell\nnpm install moosend-api --save\n```\n\n## Getting Started\n\nPlease follow the [installation](#installation) instruction and execute the following JS code:\n\n```javascript\nvar MoosendApi = require('moosend-api');\n\nvar api = new MoosendApi.CampaignsApi()\n\nvar format = \"format_example\"; // {String} \n\nvar apikey = \"apikey_example\"; // {String} You may find your API Key or generate a new one in your account settings.\n\nvar campaignID = \"campaignID_example\"; // {String} The ID of the requested AB test campaign\n\n\nvar callback = function(error, data, response) {\n  if (error) {\n    console.error(error);\n  } else {\n    console.log('API called successfully. Returned data: ' + data);\n  }\n};\napi.aBTestCampaignSummary(format, apikey, campaignID, callback);\n\n```\n\n## Documentation for API Endpoints\n\n## *CampaignsApi*\nClass | Method \n------------ | ------------- \n[**GetAllCampaigns**](docs/CampaignsApi.md#getallcampaigns) | Returns a list of all campaigns in your account with detailed information.  \n[**GetCampaignsByPage**](docs/CampaignsApi.md#getcampaignsbypage) | Returns a list of all campaigns in your account with detailed information, paging information is required as input.\n[**GetCampaignsByPageAndPagesize**](docs/CampaignsApi.md#getcampaignsbypageandpagesize) | Returns a list of all campaigns in your account with detailed information, paging information is required as input.\n[**GettingCampaignDetails**](docs/CampaignsApi.md#gettingcampaigndetails) | Returns a complete set of properties that describe the requested campaign in detail.  \n[**GettingSenderDetails**](docs/CampaignsApi.md#gettingsenderdetails) | Returns basic information for the specified sender identified by its email address.\n[**CloningAnExistingCampaign**](docs/CampaignsApi.md#cloninganexistingcampaign) | Creates an exact copy of an existing campaign. The new campaign is created as a draft.\n[**CreatingADraftCampaign**](docs/CampaignsApi.md#creatingadraftcampaign) | Creates a new campaign in your account. This method does not send the campaign, but rather creates it as a draft, ready for sending or testing. \n[**UpdatingADraftCampaign**](docs/CampaignsApi.md#updatingadraftcampaign) | Updates properties of an existing draft A/B campaign in your account. Non-draft campaigns cannot be updated. \n[**DeletingACampaign**](docs/CampaignsApi.md#deletingacampaign) | Deletes a campaign from your account, draft or even sent.\n[**TestingACampaign**](docs/CampaignsApi.md#testingacampaign) | Sends a test email of a draft campaign to a list of email addresses you specify for previewing.\n[**SendingACampaign**](docs/CampaignsApi.md#sendingacampaign) | Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediatelly.\n[**ABTestCampaignSummary**](docs/CampaignsApi.md#abtestcampaignsummary) |  Provides a basic summary of the results for a sent AB test campaign, separately for each version (A and B), such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc to date.\n[**ActivityByLocation**](docs/CampaignsApi.md#activitybylocation) |  Returns a detailed report of your campaign opens (unique and total) by country.\n[**CampaignSummary**](docs/CampaignsApi.md#campaignsummary) | Provides a basic summary of the results for any sent campaign such as the number of recipients, opens, clicks, bounces, unsubscribes, forwards etc. to date.\n[**GettingAllYourSenders**](docs/CampaignsApi.md#gettingallyoursenders) | Gets a list of your active senders in your account. You may specify any email address of these senders when sending a campaign.\n[**LinkActivity**](docs/CampaignsApi.md#linkactivity) | Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total.\n[**SchedulingACampaign**](docs/CampaignsApi.md#schedulingacampaign) | Assigns a scheduled date and time at which the campaign will be delivered.\n[**UnschedulingACampaign**](docs/CampaignsApi.md#unschedulingacampaign) | Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent.\n\n## *MailingListsApi*\nClass | Method \n------------ | ------------- \n[**CreatingACustomField**](docs/MailingListsApi.md#creatingacustomfield) | Creates a new custom field in the specified mailing list.\n[**CreatingAMailingList**](docs/MailingListsApi.md#creatingamailinglist) | Creates a new empty mailing list in your account.\n[**DeletingAMailingList**](docs/MailingListsApi.md#deletingamailinglist) | Deletes a mailing list from your account.\n[**GettingAllActiveMailingLists**](docs/MailingListsApi.md#gettingallactivemailinglists) | Gets a list of your active mailing lists in your account.\n[**GettingAllActiveMailingListsWithPaging**](docs/MailingListsApi.md#gettingallactivemailinglistswithpaging) | 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.\n[**GettingMailingListDetails**](docs/MailingListsApi.md#gettingmailinglistdetails) | 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.\n[**RemovingACustomField**](docs/MailingListsApi.md#removingacustomfield) | Removes a custom field definition from the specified mailing list.\n[**UpdatingACustomField**](docs/MailingListsApi.md#updatingacustomfield) | Updates the properties of an existing custom field in the specified mailing list.\n[**UpdatingAMailingList**](docs/MailingListsApi.md#updatingamailinglist) | Updates the properties of an existing mailing list.\n\n## *SegmentsApi*\nClass | Method \n------------ | ------------- \n[**GettingSegments**](docs/SegmentsApi.md#gettingsegments) | Get a list of all segments with their criteria for the given mailing list.\n[**GettingSegmentDetails**](docs/SegmentsApi.md#gettingsegmentdetails) | Gets detailed information on a specific segment and its criteria. However, it does not include the subscribers returned by the segment.\n[**GettingSegmentSubscribers**](docs/SegmentsApi.md#gettingsegmentsubscribers) | 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.\n[**CreatingANewSegment**](docs/SegmentsApi.md#creatinganewsegment) | 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.\n[**UpdatingASegment**](docs/SegmentsApi.md#updatingasegment) | Updates the properties of an existing segment. You may update the name and match type of the segment.\n[**AddingCriteriaToSegments**](docs/SegmentsApi.md#addingcriteriatosegments) | Adds a new criterion (a rule) to the specified segment.\n[**UpdatingSegmentCriteria**](docs/SegmentsApi.md#updatingsegmentcriteria) | Updates an existing criterion in the specified segment.\n[**DeletingASegment**](docs/SegmentsApi.md#deletingasegment) | 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.\n\n## *SubscribersApi*\nClass | Method \n------------ | ------------- \n[**GettingSubscribers**](docs/SubscribersApi.md#gettingsubscribers) | 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. \n[**GetSubscriberByEmailAddress**](docs/SubscribersApi.md#getsubscriberbyemailaddress) | Searches for a subscriber with the specified email address in the specified mailing list.\n[**GetSubscriberById**](docs/SubscribersApi.md#getsubscriberbyid) | Searches for a subscriber with the specified unique id in the specified mailing list\n[**AddingSubscribers**](docs/SubscribersApi.md#addingsubscribers) | 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.\n[**AddingMultipleSubscribers**](docs/SubscribersApi.md#addingmultiplesubscribers) | 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. \n[**UpdatingASubscriber**](docs/SubscribersApi.md#updatingasubscriber) | Updates a subscriber in the specified mailing list. You can even update the subscribers email, if he has not unsubscribed.\n[**UnsubscribingSubscribersFromAccount**](docs/SubscribersApi.md#unsubscribingsubscribersfromaccount) | Unsubscribes a subscriber from the account.\n[**UnsubscribingSubscribersFromMailingList**](docs/SubscribersApi.md#unsubscribingsubscribersfrommailinglist) | Unsubscribes a subscriber from the specified mailing list. The subscriber is not deleted, but moved to the suppression list.\n[**UnsubscribingSubscribersFromMailingListAndASpecifiedCampaign**](docs/SubscribersApi.md#unsubscribingsubscribersfrommailinglistandaspecifiedcampaign) | Unsubscribes a subscriber from the specified mailing list and the specified campaign. The subscriber is not deleted, but moved to the suppression list. \n[**RemovingASubscriber**](docs/SubscribersApi.md#removingasubscriber) | Removes a subscriber from the specified mailing list permanently (without moving to the suppression list).\n[**RemovingMultipleSubscribers**](docs/SubscribersApi.md#removingmultiplesubscribers) | 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.\n\n## Documentation for Models\n\n - [MoosendApi.A](docs/A.md)\n - [MoosendApi.ABCampaignData](docs/ABCampaignData.md)\n - [MoosendApi.AbTestCampaignSummaryResponse](docs/AbTestCampaignSummaryResponse.md)\n - [MoosendApi.ActivityByLocationResponse](docs/ActivityByLocationResponse.md)\n - [MoosendApi.AddingCriteriaToSegmentsRequest](docs/AddingCriteriaToSegmentsRequest.md)\n - [MoosendApi.AddingCriteriaToSegmentsResponse](docs/AddingCriteriaToSegmentsResponse.md)\n - [MoosendApi.AddingMultipleSubscribersRequest](docs/AddingMultipleSubscribersRequest.md)\n - [MoosendApi.AddingMultipleSubscribersResponse](docs/AddingMultipleSubscribersResponse.md)\n - [MoosendApi.AddingSubscribersRequest](docs/AddingSubscribersRequest.md)\n - [MoosendApi.AddingSubscribersResponse](docs/AddingSubscribersResponse.md)\n - [MoosendApi.Analytic](docs/Analytic.md)\n - [MoosendApi.B](docs/B.md)\n - [MoosendApi.Campaign](docs/Campaign.md)\n - [MoosendApi.CampaignSummaryResponse](docs/CampaignSummaryResponse.md)\n - [MoosendApi.CloningAnExistingCampaignResponse](docs/CloningAnExistingCampaignResponse.md)\n - [MoosendApi.Context](docs/Context.md)\n - [MoosendApi.Context110](docs/Context110.md)\n - [MoosendApi.Context118](docs/Context118.md)\n - [MoosendApi.Context132](docs/Context132.md)\n - [MoosendApi.Context140](docs/Context140.md)\n - [MoosendApi.Context145](docs/Context145.md)\n - [MoosendApi.Context148](docs/Context148.md)\n - [MoosendApi.Context17](docs/Context17.md)\n - [MoosendApi.Context32](docs/Context32.md)\n - [MoosendApi.Context37](docs/Context37.md)\n - [MoosendApi.Context52](docs/Context52.md)\n - [MoosendApi.Context64](docs/Context64.md)\n - [MoosendApi.Context66](docs/Context66.md)\n - [MoosendApi.Context72](docs/Context72.md)\n - [MoosendApi.Context84](docs/Context84.md)\n - [MoosendApi.Context89](docs/Context89.md)\n - [MoosendApi.Context93](docs/Context93.md)\n - [MoosendApi.CreatingACustomFieldRequest](docs/CreatingACustomFieldRequest.md)\n - [MoosendApi.CreatingACustomFieldResponse](docs/CreatingACustomFieldResponse.md)\n - [MoosendApi.CreatingADraftCampaignRequest](docs/CreatingADraftCampaignRequest.md)\n - [MoosendApi.CreatingADraftCampaignResponse](docs/CreatingADraftCampaignResponse.md)\n - [MoosendApi.CreatingAMailingListRequest](docs/CreatingAMailingListRequest.md)\n - [MoosendApi.CreatingAMailingListResponse](docs/CreatingAMailingListResponse.md)\n - [MoosendApi.CreatingANewSegmentRequest](docs/CreatingANewSegmentRequest.md)\n - [MoosendApi.CreatingANewSegmentResponse](docs/CreatingANewSegmentResponse.md)\n - [MoosendApi.Criterion](docs/Criterion.md)\n - [MoosendApi.CustomField](docs/CustomField.md)\n - [MoosendApi.CustomField53](docs/CustomField53.md)\n - [MoosendApi.CustomFieldsDefinition](docs/CustomFieldsDefinition.md)\n - [MoosendApi.DeletingACampaignResponse](docs/DeletingACampaignResponse.md)\n - [MoosendApi.DeletingAMailingListResponse](docs/DeletingAMailingListResponse.md)\n - [MoosendApi.DeletingASegmentResponse](docs/DeletingASegmentResponse.md)\n - [MoosendApi.Format](docs/Format.md)\n - [MoosendApi.GetAllCampaignsResponse](docs/GetAllCampaignsResponse.md)\n - [MoosendApi.GetCampaignStatisticsResponse](docs/GetCampaignStatisticsResponse.md)\n - [MoosendApi.GetCampaignStatisticsWithPagingFilteredResponse](docs/GetCampaignStatisticsWithPagingFilteredResponse.md)\n - [MoosendApi.GetCampaignsByPageAndPagesizeResponse](docs/GetCampaignsByPageAndPagesizeResponse.md)\n - [MoosendApi.GetCampaignsByPageResponse](docs/GetCampaignsByPageResponse.md)\n - [MoosendApi.GetSubscriberByEmailAddressResponse](docs/GetSubscriberByEmailAddressResponse.md)\n - [MoosendApi.GetSubscriberByIdResponse](docs/GetSubscriberByIdResponse.md)\n - [MoosendApi.GettingAllActiveMailingListsResponse](docs/GettingAllActiveMailingListsResponse.md)\n - [MoosendApi.GettingAllActiveMailingListsWithPagingResponse](docs/GettingAllActiveMailingListsWithPagingResponse.md)\n - [MoosendApi.GettingAllYourSendersResponse](docs/GettingAllYourSendersResponse.md)\n - [MoosendApi.GettingCampaignDetailsResponse](docs/GettingCampaignDetailsResponse.md)\n - [MoosendApi.GettingMailingListDetailsResponse](docs/GettingMailingListDetailsResponse.md)\n - [MoosendApi.GettingSegmentDetailsResponse](docs/GettingSegmentDetailsResponse.md)\n - [MoosendApi.GettingSegmentSubscribersResponse](docs/GettingSegmentSubscribersResponse.md)\n - [MoosendApi.GettingSegmentsResponse](docs/GettingSegmentsResponse.md)\n - [MoosendApi.GettingSenderDetailsResponse](docs/GettingSenderDetailsResponse.md)\n - [MoosendApi.GettingSubscribersResponse](docs/GettingSubscribersResponse.md)\n - [MoosendApi.ImportOperation](docs/ImportOperation.md)\n - [MoosendApi.ImportOperation19](docs/ImportOperation19.md)\n - [MoosendApi.LinkActivityResponse](docs/LinkActivityResponse.md)\n - [MoosendApi.MailingList](docs/MailingList.md)\n - [MoosendApi.MailingList68](docs/MailingList68.md)\n - [MoosendApi.MailingList69](docs/MailingList69.md)\n - [MoosendApi.MailingList85](docs/MailingList85.md)\n - [MoosendApi.MailingLists](docs/MailingLists.md)\n - [MoosendApi.MailingLists119](docs/MailingLists119.md)\n - [MoosendApi.MailingLists134](docs/MailingLists134.md)\n - [MoosendApi.Paging](docs/Paging.md)\n - [MoosendApi.Paging76](docs/Paging76.md)\n - [MoosendApi.RemovingACustomFieldResponse](docs/RemovingACustomFieldResponse.md)\n - [MoosendApi.RemovingASubscriberRequest](docs/RemovingASubscriberRequest.md)\n - [MoosendApi.RemovingASubscriberResponse](docs/RemovingASubscriberResponse.md)\n - [MoosendApi.RemovingMultipleSubscribersRequest](docs/RemovingMultipleSubscribersRequest.md)\n - [MoosendApi.RemovingMultipleSubscribersResponse](docs/RemovingMultipleSubscribersResponse.md)\n - [MoosendApi.ReplyToEmail](docs/ReplyToEmail.md)\n - [MoosendApi.SchedulingACampaignRequest](docs/SchedulingACampaignRequest.md)\n - [MoosendApi.SchedulingACampaignResponse](docs/SchedulingACampaignResponse.md)\n - [MoosendApi.Segment](docs/Segment.md)\n - [MoosendApi.Sender](docs/Sender.md)\n - [MoosendApi.SendingACampaignResponse](docs/SendingACampaignResponse.md)\n - [MoosendApi.ShortBy](docs/ShortBy.md)\n - [MoosendApi.SortMethod](docs/SortMethod.md)\n - [MoosendApi.Status](docs/Status.md)\n - [MoosendApi.Subscriber](docs/Subscriber.md)\n - [MoosendApi.Subscribers](docs/Subscribers.md)\n - [MoosendApi.Subscribers150](docs/Subscribers150.md)\n - [MoosendApi.TestingACampaignRequest](docs/TestingACampaignRequest.md)\n - [MoosendApi.TestingACampaignResponse](docs/TestingACampaignResponse.md)\n - [MoosendApi.Type](docs/Type.md)\n - [MoosendApi.UnschedulingACampaignResponse](docs/UnschedulingACampaignResponse.md)\n - [MoosendApi.UnsubscribingSubscribersFromAccountRequest](docs/UnsubscribingSubscribersFromAccountRequest.md)\n - [MoosendApi.UnsubscribingSubscribersFromAccountResponse](docs/UnsubscribingSubscribersFromAccountResponse.md)\n - [MoosendApi.UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignRequest.md)\n - [MoosendApi.UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse](docs/UnsubscribingSubscribersFromMailingListAndASpecifiedCampaignResponse.md)\n - [MoosendApi.UnsubscribingSubscribersFromMailingListRequest](docs/UnsubscribingSubscribersFromMailingListRequest.md)\n - [MoosendApi.UnsubscribingSubscribersFromMailingListResponse](docs/UnsubscribingSubscribersFromMailingListResponse.md)\n - [MoosendApi.UpdatingACustomFieldRequest](docs/UpdatingACustomFieldRequest.md)\n - [MoosendApi.UpdatingACustomFieldResponse](docs/UpdatingACustomFieldResponse.md)\n - [MoosendApi.UpdatingADraftCampaignRequest](docs/UpdatingADraftCampaignRequest.md)\n - [MoosendApi.UpdatingADraftCampaignResponse](docs/UpdatingADraftCampaignResponse.md)\n - [MoosendApi.UpdatingAMailingListRequest](docs/UpdatingAMailingListRequest.md)\n - [MoosendApi.UpdatingAMailingListResponse](docs/UpdatingAMailingListResponse.md)\n - [MoosendApi.UpdatingASegmentRequest](docs/UpdatingASegmentRequest.md)\n - [MoosendApi.UpdatingASegmentResponse](docs/UpdatingASegmentResponse.md)\n - [MoosendApi.UpdatingASubscriberRequest](docs/UpdatingASubscriberRequest.md)\n - [MoosendApi.UpdatingASubscriberResponse](docs/UpdatingASubscriberResponse.md)\n - [MoosendApi.UpdatingSegmentCriteriaRequest](docs/UpdatingSegmentCriteriaRequest.md)\n - [MoosendApi.UpdatingSegmentCriteriaResponse](docs/UpdatingSegmentCriteriaResponse.md)\n - [MoosendApi.WithStatistics](docs/WithStatistics.md)\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoosend%2Fapi-wrappers-js","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmoosend%2Fapi-wrappers-js","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmoosend%2Fapi-wrappers-js/lists"}