Actions (60)
Recipients · 16
- Add recipient to groupPOST /API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipient
Add a recipient to a specific group (which also adds to the parent list).
documented - Add recipient to listPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipient
Add a recipient to a specific list (single import) and optionally COI (ConfirmEmail) for pending status.
documented - Check subscriber existsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Subscribed?filterby="Email=='{Email}'"
Check if a subscriber exists in a given list.
documented - Import recipients into a groupPOST /API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Recipients
Bulk import recipients into a group (the group belongs to a single list).
documented - Import recipients into a listPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients
Bulk import recipients into a list (async) via the Console/List/{id_List}/Recipients endpoint.
documented - Read pending recipientsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Pending
Read recipients currently in Pending status for a list.
documented - Read recipients (with detailed subscription data)GET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Subscribed?PageNumber=0&PageSize=20
Read recipients with all subscription details for a list.
documented - Read subscribed recipientsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Subscribed
Read recipients that are subscribed to a given list (status: Subscribed).
documented - Read subscribed recipients (filtered)GET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Subscribed?filterby=...
Read subscribed recipients with filter criteria (e.g., by Email or Mobile).
documented - Read subscribed recipients (paged)GET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Subscribed?PageNumber=0&PageSize=20
Read subscribed recipients with paging.
documented - Read unsubscribed recipientsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Recipients/Unsubscribed
Read recipients who have unsubscribed from a list.
documented - Subscribe recipient to groupPOST /API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Subscribe/{id_Recipient}
Subscribe a recipient to a group (and thereby to its parent list).
documented - Subscribe recipient to listPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Subscribe/{id_Recipient}
Subscribe a recipient to a list.
documented - Unsubscribe recipient from groupDELETE /API/v1.1/Rest/ConsoleService.svc/Console/Group/{id_Group}/Unsubscribe/{id_Recipient}
Unsubscribe a recipient from a group.
documented - Unsubscribe recipient from listPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Unsubscribe/{id_Recipient}
Unsubscribe a recipient from a list.
documented - Update personal data fieldsPUT /API/v1.1/Rest/ConsoleService.svc/Console/Recipient/Detail
Update personal data fields for an existing recipient (by recipient ID or email).
documented
Email messages · 15
- Add message attachmentPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment/{Slot}
Attach a file to a message slot (Base64-encoded payload must be provided in body).
documented - Create email messagePOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email
Create a new email message within a list.
documented - Enable dynamic fields on a messagePUT /API/v1.1/Rest/ConsoleService.svc/Console/list/{id_List}/Email/{id_Message}/EnableDynamicFields/{enable}
Enable or disable dynamic fields for a message.
documented - Get message attachmentsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment
List attachments for a message.
documented - List all emails for a listGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails?PageNumber=0&PageSize=2
Paginated access to emails for a list.
documented - List messagesGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails?PageNumber=0&PageSize=2
List messages for a list (paginated).
documented - List messagesGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails
Retrieve all email messages for a given list.
documented - List messages (filtered)GET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails?filterby=...
List email messages with filter criteria.
documented - List messages (paged)GET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Emails?PageNumber=0&PageSize=20
Retrieve paged email messages for a list.
documented - Read message detailsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}
Retrieve content and settings for a single email message.
documented - Remove message attachmentDELETE /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Attachment/{Slot}
Remove an attachment from a message slot.
documented - Send message to all subscribersPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send
Enqueue or send an email message to all recipients of a list (default sender).
documented - Send message to groupsPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?inGroups={ids}
Send a message to recipients filtered by include/exclude groups.
documented - Send message with custom senderPOST /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}/Send?SenderName={name}&SenderAddress={email}
Send a message to all recipients using a specific sender name/address.
documented - Update messagePUT /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}/Email/{id_Message}
Update an existing email message (content, subject, tags, etc.).
documented
Lists · 10
- Create listPOST /API/v1.1/Rest/ConsoleService.svc/Console/List
Create a new MailUp recipient list with sender/details configuration.
documented - Delete listDELETE /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}
Delete a specific list by id_List.
documented - Disable a trusted senderDELETE /Console/TrustedSenders/{IdTrustedSender}
Disable a trusted sender.
documented - Get list detailsGET /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}
Retrieve full details for a specific list by id_List.
documented - Get list of country codesGET /API/v1.1/Rest/ConsoleService.svc/Console/List/Countries
Return the list of available country codes for list creation and maintenance.
documented - Get time zone codesGET /API/v1.1/Rest/ConsoleService.svc/Console/TimeZones
Return the list of time zone codes for list configuration.
documented - Get trusted sender detailsGET /Console/TrustedSenders/{IdTrustedSender}
Retrieve details about a trusted sender.
documented - Read listsGET /API/v1.1/Rest/ConsoleService.svc/Console/List
List all lists in the account.
documented - Trust an email addressPOST /Console/TrustedSenders
Submit a request to trust (verify) a sender email address.
documented - Update listPUT /API/v1.1/Rest/ConsoleService.svc/Console/List/{id_List}
Update all modifiable properties of a specific list.
documented
Email Statistics · 8
- Get URL click distribution by messageGET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/List/UrlClicks
Count distribution of URL clicks for a message.
documented - Get clicks by message (count)GET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/Count/Clicks
Count clicks for a specific message.
documented - Get opens by message (count)GET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/Count/Views
Count opens for a specific message.
documented - Get recipients by message (count)GET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/Count/Recipients
Count recipients who received a specific message.
documented - List URL click details by messageGET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/List/UrlClickDetails
List details of URL clicks by message.
documented - List clicks by messageGET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/List/Clicks
List recipients who clicked links in a specific message.
documented - List opens by messageGET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/List/Views
List recipients who opened a specific message.
documented - List recipients by messageGET /API/v1/1/Rest/MailStatisticsService.svc/Message/{id_message}/List/Recipients
List recipients who received a specific message.
documented
Emails · 5
- Get active email sendings (Immediate)GET /API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Immediate
Query the status of ongoing immediate email sendings.
documented - Get deferred email sendingsGET /API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/Deferred
Query the status of scheduled/deferred email sendings.
documented - Get earliest send date for a given sendingGET /API/v1.1/Rest/ConsoleService.svc/Console/Email/Sending/{id_sending}/Deferred
Retrieve the earliest date/time a given sending can be scheduled.
documented - Schedule sending for deferred timePOST /API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/{id_sending}/Deferred
Move a sending to the deferred queue with a specified UTC datetime.
documented - Start immediate sendingPOST /API/v1.1/Rest/ConsoleService.svc/Console/Email/Sendings/{id_sending}/Immediate
Move a scheduled sending to the immediate queue (start now).
documented
Public API · 4
- Activate trial accountPOST /PublicService.svc/Console/TrialActivation
Submit a trial-activation request to MailUp.
documented - Activate trial account (public USB)GET /PublicService.svc/Console/TrialActivation
Submit a request to activate a MailUp trial account.
documented - Check trial activation statusGET /PublicService.svc/Console/TrialActivationStatus
Poll for status updates on a trial activation.
documented - Check trial activation statusGET /PublicService.svc/Console/TrialActivationStatus
Poll for status updates on a trial activation.
documented
SMS Statistics · 2
- Get recipients by message (SMS) - countGET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/Count/Recipients
Count recipients for a given SMS message.
documented - List recipients by message (SMS)GET /API/v1.1/Rest/MailStatisticsService.svc/Message/{id_message}/List/Recipients
List recipients who received a given SMS message.
documented