{ "opencollection": "1.0.0", "info": { "name": "Moosend API", "version": "v3" }, "request": { "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "items": [ { "info": { "name": "Mailing Lists", "type": "folder" }, "items": [ { "info": { "name": "Getting all active mailing lists", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "WithStatistics", "value": "", "type": "query" }, { "name": "ShortBy", "value": "", "type": "query" }, { "name": "SortMethod", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Gets a list of your active mailing lists in your account." }, { "info": { "name": "Getting all active mailing lists with paging", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:Page/:PageSize.:Format", "params": [ { "name": "Page", "value": "1", "type": "path" }, { "name": "PageSize", "value": "20", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "ShortBy", "value": "", "type": "query", "description": "The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property" }, { "name": "SortMethod", "value": "", "type": "query", "description": "The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Getting mailing list details", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:MailingListID/details.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "WithStatistics", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Creating a mailing list", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/create.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Creates a new empty mailing list in your account." }, { "info": { "name": "Updating a mailing list", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/update.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path", "description": "The ID of the mailing list to be updated." }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates the properties of an existing mailing list." }, { "info": { "name": "Deleting a mailing list", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.moosend.com/v3/lists/:MailingListID/delete.:Format", "params": [ { "name": "MailingListID", "value": "b9c67cb4-a821-4187-930d-79d81a3067df", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Deletes a mailing list from your account." }, { "info": { "name": "Creating a custom field", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/customfields/create.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Creates a new custom field in the specified mailing list." }, { "info": { "name": "Updating a custom field", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/customfields/:CustomFieldID/update.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "CustomFieldID", "value": "b42b4e0f-ca2f-403d-8231-32a2405651af", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates the properties of an existing custom field in the specified mailing list." }, { "info": { "name": "Removing a custom field", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.moosend.com/v3/lists/:MailingListID/customfields/:CustomFieldID/delete.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "CustomFieldID", "value": "b42b4e0f-ca2f-403d-8231-32a2405651af", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Removes a custom field definition from the specified mailing list." } ] }, { "info": { "name": "Subscribers", "type": "folder" }, "items": [ { "info": { "name": "Getting subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:MailingListID/subscribers/:Status.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Status", "value": "Subscribed", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Get subscriber by email address", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/view.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "Email", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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" }, { "info": { "name": "Get subscriber by id", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/find/:SubscriberID.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SubscriberID", "value": "118e41dc-bb9e-435d-a86a-e5bd374668a8", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Adding subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/subscribe.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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. The rate limit for this request is 10 requests per 10 seconds (*per API key)." }, { "info": { "name": "Adding multiple subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/subscribe_many.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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. The rate limit for this request is 2 requests per 10 seconds (*per API key)." }, { "info": { "name": "Updating a subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/update/:SubscriberID.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SubscriberID", "value": "118e41dc-bb9e-435d-a86a-e5bd374668a8", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates a subscriber in the specified mailing list." }, { "info": { "name": "Unsubscribing subscribers from account", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/unsubscribe.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Unsubscribes a subscriber from the account. The rate limit for this request is 20 requests per 10 seconds (*per API key)." }, { "info": { "name": "Unsubscribing subscribers from mailing list", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/unsubscribe.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Unsubscribes a subscriber from the specified mailing list. The rate limit for this request is 20 requests per 10 seconds (*per API key)." }, { "info": { "name": "Unsubscribing subscribers from mailing list and a specified campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/:CampaignID/unsubscribe.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "CampaignID", "value": "cbcb297d-52a8-4bed-ae85-640c37c92771", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Unsubscribes a subscriber from the specified mailing list and the specified campaign. This call will take into account the setting you have in \"unsubscribe settings\" and will remove the subscriber from all other mailing lists or not accordingly. The rate limit for this request is 20 requests per 10 seconds (*per API key)." }, { "info": { "name": "Removing a subscriber", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/remove.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Removes a subscriber from the specified mailing list permanently (without moving to the suppression list)." }, { "info": { "name": "Removing multiple subscribers", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/subscribers/:MailingListID/remove_many.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." } ] }, { "info": { "name": "Campaigns", "type": "folder" }, "items": [ { "info": { "name": "Get All Campaigns", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input." }, { "info": { "name": "Get Campaigns By Page", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:Page.:Format", "params": [ { "name": "Page", "value": "1", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input." }, { "info": { "name": "Get Campaigns By Page And Pagesize", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:Page/:PageSize.:Format", "params": [ { "name": "Page", "value": "1", "type": "path" }, { "name": "PageSize", "value": "5", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "SortBy", "value": "", "type": "query", "description": "The name of the campaign property to sort results by. If not specified, results will be sorted by the CreatedOn property" }, { "name": "SortMethod", "value": "", "type": "query", "description": "The method to sort results: ASC for ascending, DESC for descending. If not specified, `ASC` will be assumed" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a list of all campaigns in your account with detailed information. Because the results for this call could be quite big, paging information is required as input." }, { "info": { "name": "Getting Campaign Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/view.:Format", "params": [ { "name": "CampaignID", "value": "cbcb297d-52a8-4bed-ae85-640c37c92771", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a complete set of properties that describe the requested campaign in detail. No statistics are included in the result." }, { "info": { "name": "Getting All Your Senders", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/senders/find_all.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Gets a list of your active senders in your account. You may specify any email address of these senders when sending a campaign." }, { "info": { "name": "Getting Sender Details", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/senders/find_one.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "Email", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns basic information for the specified sender identified by its email address." }, { "info": { "name": "Cloning An Existing Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/clone.:Format", "params": [ { "name": "CampaignID", "value": "cbcb297d-52a8-4bed-ae85-640c37c92771", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Creates an exact copy of an existing campaign. The new campaign is created as a draft." }, { "info": { "name": "Creating A Draft Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/create.:Format", "params": [ { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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. You can choose to send either a regular campaign or an AB split campaign. Campaign content must be specified from a web location. Ignore ***(A/B Split Campaign Option)*** if you want to create a regular campaign." }, { "info": { "name": "Updating A Draft Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/update.:Format", "params": [ { "name": "CampaignID", "value": "", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates properties of an existing draft A/B campaign in your account. Non-draft campaigns cannot be updated. Ignore ***(A/B Split Campaign Option)*** if you want to create a regular campaign." }, { "info": { "name": "Deleting A Campaign", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/delete.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Deletes a campaign from your account, draft or even sent." }, { "info": { "name": "Testing a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/send_test.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Sends a test email of a draft campaign to a list of email addresses you specify for previewing." }, { "info": { "name": "Sending a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/send.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Sends an existing draft campaign to all recipients specified in its mailing list. The campaign is sent immediatelly." }, { "info": { "name": "Get Campaign Statistics", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/stats/:Type.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Type", "value": "Sent", "type": "path", "description": "* Sent: To get information about when and to which recipients the campaign was sent. * Opened: To get information about who opened the campaign. * LinkClicked: To get information about who clicked on which link. * Forward: To get information about who forwarded the campaign using the relevant link on the email body and when. * Unsubscribed : To get information about who unsubscribed from the campaign by clicking on the unsubscribe link and when. * Bounced : To get information about which email recipients failed to receive the campaign. If not specified, the value Sent will be used by default." }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." }, { "name": "Page", "value": "", "type": "query" }, { "name": "PageSize", "value": "", "type": "query" }, { "name": "From", "value": "", "type": "query" }, { "name": "To", "value": "", "type": "query" } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a detailed list of statistics for a given campaign based on activity such as emails sent, opened, bounced, link clicked, etc. Because the results for this call could be quite big, paging information is required as input. Blueprint also documents this operation as \"Get Campaign Statistics With Paging & Filtered\"." }, { "info": { "name": "Campaign Summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/view_summary.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Activity By Location", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/stats/countries.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a detailed report of your campaign opens (unique and total) by country." }, { "info": { "name": "Link Activity", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/stats/links.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Returns a list with your campaign links and how many clicks have been made by your recipients, either unique or total." }, { "info": { "name": "Scheduling A Campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/schedule.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Assigns a scheduled date and time at which the campaign will be delivered." }, { "info": { "name": "Unscheduling a campaign", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/unschedule.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Removes a previously defined scheduled date and time from a campaign, so that it will be delivered immediately if already queued or when sent." }, { "info": { "name": "A/B Test Campaign Summary", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/campaigns/:CampaignID/view_ab_summary.:Format", "params": [ { "name": "CampaignID", "value": "afdc4ef6-999f-4d74-905b-ec234789f9d6", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." } ] }, { "info": { "name": "Segments", "type": "folder" }, "items": [ { "info": { "name": "Getting segments", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Get a list of all segments with their criteria for the given mailing list." }, { "info": { "name": "Getting segment details", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/details.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "10198", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Gets detailed information on a specific segment and its criteria. However, it does not include the subscribers returned by the segment." }, { "info": { "name": "Getting segment subscribers", "type": "http" }, "http": { "method": "GET", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/members.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "10198", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." }, { "info": { "name": "Creating a new empty segment", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/create.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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. Blueprint also documents this operation as \"Creating a new segment\"." }, { "info": { "name": "Updating a segment", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/update.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates the properties and criteria of an existing segment. You may update the name and match type of the segment. If criteria are included these will also be updated. You may update only the criteria. In that case, the existing name and settings will be retained." }, { "info": { "name": "Adding criteria to segments", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/criteria/add.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "10199", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Adds a new criterion (a rule) to the specified segment." }, { "info": { "name": "Updating segment criteria", "type": "http" }, "http": { "method": "POST", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/criteria/:CriteriaID/update.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "10199", "type": "path" }, { "name": "CriteriaID", "value": "15783", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "Updates an existing criterion in the specified segment." }, { "info": { "name": "Deleting A Segment", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.moosend.com/v3/lists/:MailingListID/segments/:SegmentID/delete.:Format", "params": [ { "name": "MailingListID", "value": "a589366a-1a34-4965-ac50-f1299fe5979e", "type": "path" }, { "name": "SegmentID", "value": "10199", "type": "path" }, { "name": "Format", "value": "json", "type": "path" }, { "name": "apikey", "value": "", "type": "query", "description": "Account API key. Passed as a query-string parameter on every call." } ], "auth": { "type": "apikey", "key": "apikey", "value": "{{apikey}}", "placement": "query" } }, "docs": "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." } ] } ], "bundled": true }