Enginemailer

Delete Campaign via GET /restapi/campaign/emcampaign/DeleteCampaign. Deleting undelivered campaign. Please note of the following before starting use this function Scheduled, delivering, delivered campaign is not able to perform the deleting. This function will not work when the campaign is inserting / deleting the recipient list. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Delete Recipient List via GET /restapi/campaign/emcampaign/deleteRecipientList. Delete existing recipient list from the targeted campaign. Please note of the following before starting use this function Scheduled, delivering, delivered campaign is not able to perform the deleting. This function will not work when the campaign is inserting / deleting the recipient list. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Get Category List via GET /restapi/campaign/emcampaign/GetCategoryList. Get a list of category. No parameter is required Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Get Sub Category List via GET /restapi/campaign/emcampaign/GetSubCategoryList. Get a list of subcategory based on the category ID Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

List Campaign via GET /restapi/campaign/emcampaign/ListCampaign. Get a list of undelivered campaigns. No parameter is required Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Pause Campaign via GET /restapi/campaign/emcampaign/PauseCampaign. Pause the campaign from a scheduled campaign. Please note of the following before starting use this function Only scheduled without delivering campaign is able to perform the pause for the campaign Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Schedule Campaign via GET /restapi/campaign/emcampaign/ScheduleCampaign. Schedule the campaign. Please note of the following before starting use this function Scheduled, delivering, delivered campaign is not able to perform the scheduling. This function will not work when the campaign is deleting the recipient list. The campaign must at least have one recipient to deliver the campaign. Schedule Date must not be a passed date. Schedule Date must follow the standard of scheduling in the portal. It must be in the interval of 15 minutes. For g., 12:00, 12:15, 12:30, 12:45, others format of the schedule time will be rejected. Insufficient credit will flag the scheduled campaign as “failed” and campaign will not send at the scheduled time. Failed campaign can be edited and resend from the portal. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Send Campaign via GET /restapi/campaign/emcampaign/SendCampaign. Send the campaign. Please note of the following before starting use this function Scheduled, delivering, delivered campaign is not able to perform the sending. This function will not work when the campaign is deleting the recipient list. The campaign must at least have one recipient to deliver the campaign. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Get Custom Field via GET /restapi/subscriber/emsubscriber/getCustomField. Get Custom Field List.

Get Sub Category via GET /restapi/subscriber/emsubscriber/getSubCategory. Get Sub Category List.

Get Subscriber via GET /restapi/subscriber/emsubscriber/getSubscriber. Get information about a subscriber.

UnSub Subscriber via GET /restapi/subscriber/emsubscriber/unSubSubscriber. Unsubscribe existing subscriber from subscriber list.

Assign Recipient List via POST /restapi/campaign/emcampaign/AssignRecipientList. Assign recipient list to the targeted campaign. Please note of the following before starting use this function Scheduled, delivering, delivered campaign is not able to perform the assigning. This function will not work when the campaign is inserting / deleting the recipient list. The subcategoryid please get from the function which named as getSubCategoryList. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Create Campaign via POST /restapi/campaign/emcampaign/CreateCampaign. Creation of the campaign. Note: The user can only create campaign with the maximum number of 200. If intend to create more campaign, you are required to delete older campaigns. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Update Campaign via POST /restapi/campaign/emcampaign/UpdateCampaign. Update data for existing campaign. Paid plans only: "The campaign API only allow the PAID user to use the service." (https://enginemailer.zendesk.com/hc/en-us/articles/360003129972-Campaign-REST-API-GETTING-STARTED). A Free account receives "Free account is not eligible to use API!" (https://enginemailer.zendesk.com/hc/en-us/articles/360003892652-Errors-for-Campaign-API).

Activate Subscriber via POST /restapi/subscriber/emsubscriber/activateSubscriber. Activate an inactive subscriber. Only applicable to the subscriber that is deactivated either through the API or manually.

Batch Update Status via POST /restapi/subscriber/emsubscriber/batchUpdateStatus. Retrieve the status for the Batch Update Subscribers job, using the ID that is returned from the API.

Batch Update Subscribers via POST /restapi/subscriber/emsubscriber/batchUpdateSubscribers. Add or Update the list of subscribers based on the custom fields and subcategories provided in the JSON data. Subscribers data that does not pass the validation will be removed from processing. Retrieve the status for the job using Batch Update Status.

Delete Subscriber via POST /restapi/subscriber/emsubscriber/deleteSubscriber. Delete a subscriber, identified by email. (The vendor article's own summary line reads 'Insertion of a subscriber.', copied from Insert Subscriber.).

Insert Subscriber via POST /restapi/subscriber/emsubscriber/insertSubscriber. Insertion of a subscriber. Note: The user can only insert with the maximum number of 50/day with the free account and 10,000/day with the paid account.

Create Update Category via POST /restapi/subscriber/emsubscriber/updateCategory. Create or modify the category and subcategories using the data provided in JSON format.

Update Subscriber via POST /restapi/subscriber/emsubscriber/updateSubscriber. Update data for an existing subscriber.

Check Export Status Version 2 via POST /RESTAPI/V2/Submission/Report/CheckExport. You can export transactional email reports using API. Once you've initiated the export using this method, it will undergo a processing phase which may take some time to complete. Check Export Status Go to https://api.enginemailer.com/RESTAPI/V2/Submission/Report/CheckExport and use the ExportID that you received from the Export method to check the status. Please note that our REST API only accepts JSON object as a parameter list. To ensure proper authentication, you should include only one authentication parameter (APIKey) within the header. Below is an example of the response. If the export is still processing, it will display a "Processing" status. If the export is complete, it will display a "Complete" status and the URL to download the file.

Export CSV Report Version 2 via POST /RESTAPI/V2/Submission/Report/Export. You can export transactional email reports using API at this link: Please note that our REST API only accepts JSON object as a parameter list. To ensure proper authentication, you should include only one authentication parameter (APIKey) within the header. Below is an example of the response. Use the ExportID to check for the export status in here.

Submitting Transactional Emails via REST-API Version 2 via POST /RESTAPI/V2/Submission/SendEmail. We recommend that you use this version as the previous version will no longer be updated for new enhancements. You can submit emails by invoking the Enginemailer Email Service at https://api.enginemailer.com/RESTAPI/V2/Submission/SendEmail Please note that our REST API only accepts JSON object as a parameter list. To ensure proper authentication, you should include only one authentication parameter (APIKey) within the header. We allow users to send emails with or without templates. To create a template, please visit here.