- Category: email
- Auth: OAUTH2
- Composio-managed OAuth available? No
- Tools: 151
- Triggers: 0
- Slug:
MAIL_UP - Version: 20261101_00
Tools
Add Image
Add Image
MAIL_UP_ADD_IMAGEDecode and store supplied base64 image data in either MailUp’s shared console library or one list, returning the resulting full paths. This creates persistent provider content, requires image/list access, and counts toward the 5-calls-per-second standard REST limit.Input Parameters
Output
Add Message Attachment
Add Message Attachment
Associate Personalization Endpoint With List
Associate Personalization Endpoint With List
Import SMS Recipients To Group
Import SMS Recipients To Group
MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENTS_TO_GROUPAsynchronously add or update an SMS recipient batch in a MailUp group and return the import ID. clear_missing_or_empty_fields=true permanently clears stored recipient fields omitted or empty in each row. remove_from_prev_groups=true removes each recipient from every previous group before adding this group. Requires SMS entitlement; limit traffic to 5 calls per second.Input Parameters
Output
Import SMS Recipients To List
Import SMS Recipients To List
MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENTS_TO_LISTAsynchronously add or update an SMS recipient batch in a MailUp list and return the import ID. clear_missing_or_empty_fields=true permanently clears stored recipient fields omitted or empty in each row. Requires SMS entitlement; limit traffic to 5 calls per second.Input Parameters
Output
Import One SMS Recipient To Group
Import One SMS Recipient To Group
MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENT_TO_GROUPAdd or update one SMS recipient in a MailUp group and return the recipient ID. clear_missing_or_empty_fields=true permanently clears stored recipient fields omitted or empty in this request. remove_from_prev_groups=true removes the recipient from every previous group before adding this group. Requires SMS entitlement; observe the 5 calls per second limit.Input Parameters
Output
Import One SMS Recipient To List
Import One SMS Recipient To List
MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENT_TO_LISTAdd or update one SMS recipient in a MailUp list and return the recipient ID. clear_missing_or_empty_fields=true permanently clears stored recipient fields omitted or empty in this request. Requires SMS entitlement; observe the 5 calls per second limit.Input Parameters
Output
Batch Unsubscribe Recipients From List
Batch Unsubscribe Recipients From List
MAIL_UP_BATCH_UNSUBSCRIBE_RECIPIENTS_FROM_LISTRemove multiple recipients’ memberships from one MailUp list without deleting their global recipient records. This non-atomic action processes 1-20 unique recipient IDs sequentially at less than 5 requests per second. It stops after the first failed or unknown removal, reports any partial completion, and marks remaining recipients not_attempted; successful earlier removals are not rolled back.Input Parameters
Output
Confirm SMS Numeric Sender
Confirm SMS Numeric Sender
Copy Email Message
Copy Email Message
Count Message Sending Recipients
Count Message Sending Recipients
MAIL_UP_COUNT_MESSAGE_SENDING_RECIPIENTSReturn MailUp’s count of recipients to whom one email message was sent. This is the SendingRecipients statistic, distinct from the recipient-detail list; message-recipient data is retained for the console retention period, up to 12 months, after which related recipient statistics can be zero or empty.Input Parameters
Output
Count Subscribers
Count Subscribers
Create Audience Group
Create Audience Group
Create Content Source
Create Content Source
Create Email Message
Create Email Message
MAIL_UP_CREATE_EMAIL_MESSAGECreate a draft email campaign message in one MailUp list without sending it.Input Parameters
Output
Create Email Message from Template
Create Email Message from Template
Create List
Create List
MAIL_UP_CREATE_LISTCreate a MailUp mailing list without adding recipients or sending messages. The request must supply at least one settings source: id_settings or use_default_settings. Availability and accepted settings depend on the connected user’s console permissions; MailUp limits standard REST traffic to 5 calls per second.Input Parameters
Output
Create Personalization Endpoint
Create Personalization Endpoint
MAIL_UP_CREATE_PERSONALIZATION_ENDPOINTCreate a MailUp endpoint used to obtain external personalization data. This operation requires Personalization to be enabled by MailUp for the connected platform account.Input Parameters
Output
Create SMS Message
Create SMS Message
MAIL_UP_CREATE_SMS_MESSAGECreate a MailUp SMS draft without sending or consuming delivery credits. The account needs SMS entitlement; observe MailUp’s limit of 5 calls per second.Input Parameters
Output
Create SMTP+ Account
Create SMTP+ Account
MAIL_UP_CREATE_SMTP_PLUS_ACCOUNTCreate an SMTP+ user account for a MailUp list and return its generated credentials. Supply at least one non-empty trusted domain or confirmed trusted sender, and choose priority_code from GET_SMTP_PLUS_PRIORITY_CODES. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account.Input Parameters
Output
Create Tag
Create Tag
Delete Audience Group
Delete Audience Group
Delete Audience Recipient From List
Delete Audience Recipient From List
Delete Audience Recipient Globally
Delete Audience Recipient Globally
Delete Content Source
Delete Content Source
Delete Email Message
Delete Email Message
Delete Image
Delete Image
MAIL_UP_DELETE_IMAGEDelete an image at an exact full MailUp path and verify its absence in the shared or list image collection. Deletion may succeed even if the subsequent verification fails.Input Parameters
Output
Delete List
Delete List
Delete Message Attachment
Delete Message Attachment
Delete Personalization Endpoint
Delete Personalization Endpoint
Delete Email Sending Task
Delete Email Sending Task
MAIL_UP_DELETE_SENDINGDelete an existing MailUp email sending task record; this does not recall email already delivered. MailUp permits at most 1 combined stop or delete call per 30 seconds. A process-local guard coordinates both actions in this worker only; MailUp remains authoritative across workers and other clients. Never retry automatically after a rejection or ambiguous result.Input Parameters
Output
Delete SMS Message
Delete SMS Message
Delete Source Content
Delete Source Content
Delete Tag
Delete Tag
Disable Trusted Sender
Disable Trusted Sender
MAIL_UP_DISABLE_TRUSTED_SENDER_BY_IDDisable a trusted sender registration by ID so it is no longer active for sending. The action verifies the sender address because MailUp may return one ID for multiple registrations, then supplies MailUp’s required request GUID internally. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.Input Parameters
Output
Disassociate Personalization Endpoint From List
Disassociate Personalization Endpoint From List
Empty Audience Group
Empty Audience Group
Set Email Message Dynamic Fields
Set Email Message Dynamic Fields
Set SMS Message Dynamic Fields
Set SMS Message Dynamic Fields
Set Tracking for Every List
Set Tracking for Every List
Set Tracking for List
Set Tracking for List
Find Recipients
Find Recipients
Get Account Details
Get Account Details
Get Account Info
Get Account Info
List Archived Email Messages
List Archived Email Messages
MAIL_UP_GET_ARCHIVED_MAIL_MESSAGES_BY_LISTReturn one page of archived email messages from a specific MailUp list.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.Subject eq 'Welcome'; Name eq 'VIP'.Output
Get Deferred Dispatch Date
Get Deferred Dispatch Date
Get Earliest Deferred SMS Dispatch Date
Get Earliest Deferred SMS Dispatch Date
MAIL_UP_GET_DATE_FOR_DEFERRED_SMS_DISPATCHReturn MailUp’s earliest useful scheduling date for one SMS sending task. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Output
List Deferred SMS Sendings
List Deferred SMS Sendings
MAIL_UP_GET_DEFERRED_SMS_SENDING_STATUSReturn SMS sending tasks scheduled for deferred dispatch. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get Email Message
Get Email Message
List Email Send History for List
List Email Send History for List
MAIL_UP_GET_EMAIL_SEND_HISTORYReturn one page of send-history records across all email messages in one MailUp list.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.Subject eq 'Welcome'; Name eq 'VIP'.Output
Get Email Template Details
Get Email Template Details
List Email Templates
List Email Templates
MAIL_UP_GET_EMAIL_TEMPLATESReturn one page of email templates defined in a specific MailUp list.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.Subject eq 'Welcome'; Name eq 'VIP'.Output
List Immediate SMS Sendings
List Immediate SMS Sendings
MAIL_UP_GET_IMMEDIATE_SMS_SENDING_STATUSReturn SMS sending tasks scheduled for immediate dispatch. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get Import Details
Get Import Details
Get Import Sending
Get Import Sending
Get Import Status
Get Import Status
List Last Sent SMS Messages
List Last Sent SMS Messages
MAIL_UP_GET_LAST_SENT_SMSReturn the most recently sent SMS messages and their account-billing costs for one list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get List
Get List
Get MailUp Login URL
Get MailUp Login URL
List Current User Email Messages
List Current User Email Messages
MAIL_UP_GET_MAIL_MESSAGES_BY_USERReturn one page of cloned and original email messages across lists for the current MailUp user.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.Subject eq 'Welcome'; Name eq 'VIP'.Output
List Message Attachments
List Message Attachments
Get Message Statistics
Get Message Statistics
Get Message Statistics Pages
Get Message Statistics Pages
MAIL_UP_GET_MESSAGE_STATISTICS_PAGESReturn MailUp’s precompiled public statistics-page URLs for one message: overall, click trend, opens, link tracking, readers, and sent reports, plus the console login URL. These human-facing pages expose less detail than the statistics API; the console URL can also reveal the account host. Legacy click/open filter pages are no longer available and are not returned by the current XSD.Input Parameters
Output
List Non-Temporary SMS Errors
List Non-Temporary SMS Errors
MAIL_UP_GET_NOT_TEMPORARY_SMS_ERRORSReturn undelivered SMS error totals grouped by originator address. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
List Pending SMS Recipients By List
List Pending SMS Recipients By List
MAIL_UP_GET_PENDING_SMS_RECIPIENTS_BY_LISTReturn recipients whose SMS subscription is pending in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get Personalization Endpoint
Get Personalization Endpoint
List Published Email Messages
List Published Email Messages
MAIL_UP_GET_PUBLISHED_MAIL_MESSAGES_BY_LISTReturn one page of email messages currently visible online for a specific MailUp list.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.Subject eq 'Welcome'; Name eq 'VIP'.Output
Get Recipient
Get Recipient
Get Recipient Statistics
Get Recipient Statistics
Request SMS Numeric Sender Confirmation Code
Request SMS Numeric Sender Confirmation Code
MAIL_UP_GET_SMS_CONFIRMATION_CODERequest the authentication code for a MailUp numeric SMS sender and return whether MailUp accepted the request. This mutates sender-verification state and may cause MailUp to issue a code; never retry automatically after any status or transport failure because the first request may have succeeded. The SMS channel and sender verification must be enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Output
Get SMS Message Details
Get SMS Message Details
MAIL_UP_GET_SMS_MESSAGE_DETAILSReturn the complete XSD-defined content and settings for one MailUp SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Output
List SMS Messages By List
List SMS Messages By List
MAIL_UP_GET_SMS_MESSAGES_BY_LISTReturn SMS campaign message summaries from one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
List SMS Message Send History
List SMS Message Send History
MAIL_UP_GET_SMS_MESSAGE_SEND_HISTORYReturn sending attempts and recipient counts for one SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get SMS Message Sending Report
Get SMS Message Sending Report
MAIL_UP_GET_SMS_MESSAGE_SENDING_REPORT_BY_SMS_IDReturn aggregate duration, cost, recipient-message, and billable SMS-part totals for one SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Output
List SMS Message Sending Report Details
List SMS Message Sending Report Details
MAIL_UP_GET_SMS_MESSAGE_SENDING_REPORT_DETAILS_BY_SMS_IDReturn per-recipient delivery statuses and errors for one SMS message. A DeliveryId filter returns at most one detail. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get SMS Numeric Sender Status
Get SMS Numeric Sender Status
MAIL_UP_GET_SMS_NUMERIC_SENDER_STATUSReturn the verification status code and description for one numeric MailUp SMS sender. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Output
List SMS Recipients By Group
List SMS Recipients By Group
MAIL_UP_GET_SMS_RECIPIENTS_BY_GROUPReturn recipients in one MailUp group using the SMS channel projection. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get SMTP+ Priority Codes
Get SMTP+ Priority Codes
List Subscribed SMS Recipients By List
List Subscribed SMS Recipients By List
MAIL_UP_GET_SUBSCRIBED_SMS_RECIPIENTS_BY_LISTReturn recipients subscribed to the SMS channel in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
List Temporary SMS Errors
List Temporary SMS Errors
MAIL_UP_GET_TEMPORARY_SMS_ERRORSReturn temporary undelivered SMS error totals grouped by originator address. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Get Tracking Status for Every List
Get Tracking Status for Every List
Get Tracking Status for List
Get Tracking Status for List
Get Trusted Sender
Get Trusted Sender
List Trusted Senders
List Trusted Senders
MAIL_UP_GET_TRUSTED_SENDERSReturn one page of trusted sender registrations. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id asc; IsActive desc, Id asc.Id gt 0; IsActive eq true.Output
List Unscheduled SMS Sendings
List Unscheduled SMS Sendings
MAIL_UP_GET_UNDEFINED_SMS_SENDING_STATUSReturn SMS sending tasks that still need a dispatch schedule. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
List Unsubscribed SMS Recipients By List
List Unsubscribed SMS Recipients By List
MAIL_UP_GET_UNSUBSCRIBED_SMS_RECIPIENTS_BY_LISTReturn recipients unsubscribed from the SMS channel in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.Output
Import Audience Recipient To Group
Import Audience Recipient To Group
MAIL_UP_IMPORT_AUDIENCE_RECIPIENT_TO_GROUPSynchronously create or update one email recipient and add them to a MailUp group, returning the recipient ID. For a new recipient, the group’s owning list becomes the owning list and they receive a Subscribed subscription status by default. confirm_email=true sends a confirmation email automatically and leaves a new recipient Pending; a Pending recipient receives another confirmation email and an Unsubscribed recipient moves to Pending. Never retry an ambiguous result because doing so can send duplicate confirmation email.Input Parameters
Output
Import Audience Recipient To List
Import Audience Recipient To List
MAIL_UP_IMPORT_AUDIENCE_RECIPIENT_TO_LISTSynchronously create or update one email recipient in a MailUp list and return the recipient ID. The target list becomes the recipient’s owning list; a new recipient receives a Subscribed subscription status by default. confirm_email=true sends a confirmation email automatically and leaves a new recipient Pending; a Pending recipient receives another confirmation email and an Unsubscribed recipient moves to Pending. Never retry an ambiguous result because doing so can send duplicate confirmation email.Input Parameters
Output
Import Recipients
Import Recipients
MAIL_UP_IMPORT_RECIPIENTSQueue an asynchronous import that adds or updates a non-empty recipient batch in one MailUp list or group. MailUp permits only one account import at a time; use the returned import ID with MAIL_UP_GET_IMPORT_STATUS until it completes. New recipients receive a Subscribed subscription status in the destination list or the group’s owning list by default; confirm_email=true instead leaves them Pending and generates confirmation emails for the confirmation-request queue. import_type=‘asOptout’ makes every supplied recipient Optout except recipients already Pending, so it can unsubscribe existing recipients. clear_missing_or_empty_fields can erase stored data and group remove_from_prev_groups can remove memberships. Never retry an ambiguous result because these effects may already have occurred.Input Parameters
Output
List Audience Email Opt-Ins By List
List Audience Email Opt-Ins By List
MAIL_UP_LIST_AUDIENCE_EMAIL_OPTINS_BY_LISTReturn one page of subscribed and unsubscribed email recipients for a MailUp list with complete opt-in and opt-out details.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Status asc; Email asc, Optin_Date desc.Status eq 'Subscribed'; Email eq 'ada@example.com'.Output
List Audience Email Opt-Ins By Recipient
List Audience Email Opt-Ins By Recipient
MAIL_UP_LIST_AUDIENCE_EMAIL_OPTINS_BY_RECIPIENTReturn one page of a MailUp recipient’s email subscription status and opt-in/opt-out history across lists.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdList asc; Status asc, IdList asc.IdList eq 7; Status eq 'Subscribed'.Output
List Audience SMS Opt-Ins By List
List Audience SMS Opt-Ins By List
MAIL_UP_LIST_AUDIENCE_SMS_OPTINS_BY_LISTReturn one page of subscribed and unsubscribed SMS recipients for a MailUp list with complete opt-in and opt-out details.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Status asc; MobilePrefix asc, MobileNumber asc.Status eq 'Subscribed'; MobilePrefix eq '+39'.Output
List Audience SMS Opt-Ins By Recipient
List Audience SMS Opt-Ins By Recipient
MAIL_UP_LIST_AUDIENCE_SMS_OPTINS_BY_RECIPIENTReturn one page of a MailUp recipient’s SMS subscription status and opt-in/opt-out history across lists.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdList asc; Status asc, IdList asc.IdList eq 7; Status eq 'Subscribed'.Output
List Content Sources
List Content Sources
MAIL_UP_LIST_CONTENT_SOURCESReturn one page of MailUp content-provider sources.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: SourceName asc; Label desc, IdEndpoint asc.SourceName eq 'Catalog'; Label eq 'CRM'.Output
List Country Codes
List Country Codes
List Dynamic Fields
List Dynamic Fields
MAIL_UP_LIST_DYNAMIC_FIELDSReturn one page of recipient dynamic-field definitions and IDs. Supports provider filter/order expressions and an opaque cursor; access follows console permissions and standard REST traffic is limited to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id asc; Description desc, Id asc.Id gt 0; Description ne null.Output
List Email Messages
List Email Messages
MAIL_UP_LIST_EMAIL_MESSAGESReturn one page of email campaign messages in a MailUp list, including message IDs used by message editing, sending, and statistics tools.Input Parameters
13,customers,'hello, world'.Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Subject asc, idMessage desc.Subject eq 'Welcome'; idMessage gt 0.Output
List Email Send History
List Email Send History
MAIL_UP_LIST_EMAIL_SEND_HISTORYReturn one page of completed send-history records for a specific MailUp email message.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id desc; Subject asc, Id desc.Id gt 0; Subject eq 'Welcome'.Output
List Email Sendings
List Email Sendings
MAIL_UP_LIST_EMAIL_SENDINGSReturn one page of MailUp email sending tasks for one queue state: pending scheduling, immediate, or deferred.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id desc; State asc, Id desc.Id gt 0; State eq 'Waiting'.Output
List Group Recipients
List Group Recipients
MAIL_UP_LIST_GROUP_RECIPIENTSReturn one page of recipients currently associated with a MailUp group.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Email asc; Email asc, idRecipient desc.Email eq 'ada@example.com'; idRecipient gt 0.Output
List Groups
List Groups
MAIL_UP_LIST_GROUPSReturn one page of recipient groups in a MailUp list, including group IDs used by group-scoped tools.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Name asc; Name asc, idGroup desc.Name eq 'Customers'; idGroup gt 0.Output
List Images
List Images
MAIL_UP_LIST_IMAGESReturn all full image paths from either the console-wide shared library or one MailUp list. The provider does not paginate these arrays; list access follows console permissions and calls count toward the 5-calls-per-second standard REST limit.Input Parameters
Output
List Imports
List Imports
MAIL_UP_LIST_IMPORTSReturn one page of MailUp recipient imports with status codes and row counts. Supports provider filter/order expressions and an opaque cursor; standard REST traffic is limited to 5 calls per second.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdImport desc; StatusCode asc, IdImport desc.IdImport gt 0; StatusCode eq 2.Output
List Import Status Codes
List Import Status Codes
List List Recipients
List List Recipients
MAIL_UP_LIST_LIST_RECIPIENTSReturn one page of recipients in a MailUp list for one subscription state: subscribed, pending, or unsubscribed.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Email asc; Email asc, idRecipient desc.Email eq 'ada@example.com'; idRecipient gt 0.Output
List Lists
List Lists
MAIL_UP_LIST_LISTSReturn one page of mailing lists available to the connected MailUp user, including the list IDs required by list-scoped tools.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Name asc; Name asc, IdList desc.Name eq 'Newsletter'; IdList gt 0.Output
List List Scopes
List List Scopes
List Message Events
List Message Events
MAIL_UP_LIST_MESSAGE_EVENTSReturn one page of recipient-level delivery, view, click, bounce, or unsubscription statistics for a sent MailUp email message. View and click rows are recipient rollups with Count, not individual event timestamps. Delivery details are retained for at most 12 months. If a message ID was reused, results aggregate every campaign sent with that ID.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdRecipient asc; Email asc, IdRecipient asc.IdRecipient gt 0; Email eq 'ada@example.com'.Output
List Message URL Click Details
List Message URL Click Details
MAIL_UP_LIST_MESSAGE_URL_CLICK_DETAILSReturn one page of clicked links for a MailUp message with each link’s total and per-recipient click counts. Full click details are retained for the console data-retention period. Reusing one message across campaigns merges its statistics; clone messages when campaign statistics must stay separate.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdRecipient asc; Email asc, IdRecipient asc.IdRecipient gt 0; Email eq 'ada@example.com'.Output
List Message URL Clicks
List Message URL Clicks
MAIL_UP_LIST_MESSAGE_URL_CLICKSReturn one page of links with at least one click for a MailUp message, with the click total for each URL or MailUp special-link label. Full click details are retained for the console data-retention period. Reusing one message across campaigns merges its statistics; clone messages when campaign statistics must stay separate.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Clicks desc; Clicks desc, Url asc.Url eq 'https://example.com'; Clicks gt 0.Output
List Personalization Endpoints
List Personalization Endpoints
MAIL_UP_LIST_PERSONALIZATION_ENDPOINTSReturn one page of MailUp personalization endpoints. This operation requires Personalization to be enabled by MailUp for the connected platform account.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: SourceName asc; Label desc, IdEndpoint asc.SourceName eq 'Catalog'; Label eq 'CRM'.Output
List Personalization Endpoints By List
List Personalization Endpoints By List
List Recipient Activity
List Recipient Activity
MAIL_UP_LIST_RECIPIENT_ACTIVITYReturn one page of sent-email delivery, view, click, bounce, or unsubscription statistics for one MailUp recipient. View and click rows are message-level rollups with Count, not individual event timestamps. Delivery details are retained for at most 12 months; reused message IDs aggregate campaigns.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; Subject asc, IdMessage desc.IdMessage gt 0; Subject eq 'Welcome'.Output
List Recipient Bounce Details
List Recipient Bounce Details
MAIL_UP_LIST_RECIPIENT_BOUNCE_DETAILSReturn one page of messages that bounced for a MailUp recipient, including message subject, notes, and bounce classification when available. Statistics are limited by the account’s configured data-retention period.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; Type asc, IdMessage desc.IdMessage gt 0; Type eq 'HardBounce'.Output
List Recipient Click Details
List Recipient Click Details
MAIL_UP_LIST_RECIPIENT_CLICK_DETAILSReturn one page of messages in which a MailUp recipient clicked, including each message’s total and per-URL click counts. URL values can be normal URLs or MailUp special-link labels. Full click details are retained for the console data-retention period.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdMessage desc, Url asc.IdMessage gt 0; Url eq 'https://example.com'.Output
List Recipient Groups
List Recipient Groups
MAIL_UP_LIST_RECIPIENT_GROUPSReturn one page of groups to which a recipient belongs within one MailUp list.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: idGroup asc; idList asc, idGroup desc.idGroup gt 0; idList eq 7.Output
List Source Contents
List Source Contents
MAIL_UP_LIST_SOURCE_CONTENTSReturn one page of content items from one MailUp content-provider source.Input Parameters
Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: ContentKey asc; ContentLoadingDate desc; ContentDate desc; Title asc.ContentKey eq 'sku-123'; ContentLoadingDate ge '2026-08-01'; ContentDate ge '2026-08-01'; Title eq 'Catalog item'.Output
List Time Zones
List Time Zones
Register Trusted Sender
Register Trusted Sender
MAIL_UP_REGISTER_TRUSTED_SENDERRegister an email address as a trusted sender and begin MailUp’s authorization process; registration does not itself guarantee authorization. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.Input Parameters
Output
Reset SMTP+ Account
Reset SMTP+ Account
MAIL_UP_RESET_SMTP_PLUS_ACCOUNTReset an existing SMTP+ user account and return a replacement password. The old password stops working; treat the returned password as a secret and store it securely without logging or exposing it. Never retry automatically after an ambiguous result. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account.Input Parameters
Output
Schedule Deferred Email Dispatch
Schedule Deferred Email Dispatch
MAIL_UP_SCHEDULE_DEFERRED_DISPATCHQueue an existing MailUp email campaign for deferred dispatch at the supplied UTC date in exact yyyy-MM-dd HH:mm:ssZ format. Dispatch may consume email credits. Never retry automatically after a rejection or ambiguous result; check the sending state before deciding whether to call again. This action is email-only; use SCHEDULE_DEFERRED_SMS_DISPATCH for SMS.Input Parameters
Output
Schedule Deferred SMS Dispatch
Schedule Deferred SMS Dispatch
MAIL_UP_SCHEDULE_DEFERRED_SMS_DISPATCHExplicitly schedule an existing MailUp SMS sending for a supplied future Date. The dispatch can consume SMS credits when it runs and repeating the request may change or duplicate scheduling; never retry an ambiguous result. Requires SMS entitlement and the 5 calls per second limit applies.Input Parameters
Output
Schedule Immediate Email Dispatch
Schedule Immediate Email Dispatch
MAIL_UP_SCHEDULE_IMMEDIATE_DISPATCHIrreversibly move an existing inactive MailUp email sending task into the immediate sending queue, where delivery can begin. Never automatically retry after an ambiguous timeout or transport failure; inspect the immediate and pending sending queues first. Use SCHEDULE_IMMEDIATE_SMS_DISPATCH for SMS.Input Parameters
Output
Schedule Immediate SMS Dispatch
Schedule Immediate SMS Dispatch
MAIL_UP_SCHEDULE_IMMEDIATE_SMS_DISPATCHExplicitly queue an existing MailUp SMS sending for immediate dispatch. This requires SMS entitlement and credits, may incur charges, and can duplicate a dispatch if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second.Input Parameters
Output
Send Email Message to Recipient
Send Email Message to Recipient
MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENTIrreversibly enqueue, defer, or snapshot an existing MailUp email message for one recipient email address. An omitted or now datetime starts queued delivery; a UTC datetime creates an immutable schedule; undefined creates an inactive recipient snapshot. This can consume credits and produce duplicate email if repeated. Never retry after an ambiguous timeout, connection loss, or unknown outcome; inspect the sending queues first.Input Parameters
now to enqueue delivery, use undefined to create an inactive recipient snapshot for later scheduling, or provide a UTC date and time in exact yyyy-MM-dd HH:mm:ssZ format for immutable deferred delivery.Output
Send Email Message to Group
Send Email Message to Group
MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENT_IN_GROUPIrreversibly enqueue, defer, or snapshot an existing MailUp email message for recipients in one group. An omitted or now datetime starts queued delivery; a UTC datetime creates an immutable schedule; undefined creates an inactive recipient snapshot. This can consume credits and deliver duplicate email if repeated. Never automatically retry after an ambiguous timeout or transport failure; inspect the sending queues first.Input Parameters
now to enqueue delivery, use undefined to create an inactive recipient snapshot for later scheduling, or provide a UTC date and time in exact yyyy-MM-dd HH:mm:ssZ format for immutable deferred delivery.Output
Send Email Message to List
Send Email Message to List
MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENT_IN_LISTIrreversibly enqueue, defer, or snapshot an existing MailUp email message for recipients in one list, optionally including or excluding groups. An omitted or now datetime starts queued delivery; a UTC datetime creates an immutable schedule; undefined creates an inactive recipient snapshot. This can consume credits and deliver duplicate email if repeated; never automatically retry after an ambiguous timeout or transport failure; inspect the sending queues first.Input Parameters
now to enqueue delivery, use undefined to create an inactive recipient snapshot for later scheduling, or provide a UTC date and time in exact yyyy-MM-dd HH:mm:ssZ format for immutable deferred delivery.12,23,45. Omit rather than pass an empty value, which MailUp ignores and would broaden delivery to all list recipients.12,23,45. MailUp ignores the entire exclusion if any ID is not a group in this list.Output
Send SMS Message To Recipient
Send SMS Message To Recipient
MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENTIrreversibly send an existing MailUp SMS message directly to one Prefix/Number. This requires SMS entitlement, a confirmed sender, and credits; it may incur a charge and duplicate delivery if repeated. Never retry an ambiguous result and limit traffic to 5 calls per second.Input Parameters
Output
Send SMS Message To Group
Send SMS Message To Group
MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENT_IN_GROUPIrreversibly send or schedule an existing SMS message to recipients in one MailUp group. MailUp uses the SMS sender configured on the group’s list, regardless of the message’s Sender field. This requires SMS entitlement and credits, may incur charges, and may duplicate delivery if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second.Input Parameters
Output
Send SMS Message To List
Send SMS Message To List
MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENT_IN_LISTIrreversibly send or schedule an existing SMS message to recipients in one MailUp list. MailUp uses the SMS sender configured on the list, regardless of the message’s Sender field. This requires SMS entitlement and credits, may incur charges, and may duplicate delivery if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second.Input Parameters
Output
Stop Email Sending Task
Stop Email Sending Task
MAIL_UP_STOP_SENDINGStop an existing MailUp email sending task and prevent its remaining queued email deliveries. MailUp permits at most 1 combined stop or delete call per 30 seconds. A process-local guard coordinates both actions in this worker only; MailUp remains authoritative across workers and other clients. Never retry automatically after a rejection or ambiguous result.Input Parameters
Output
Subscribe Audience Recipient To Group
Subscribe Audience Recipient To Group
MAIL_UP_SUBSCRIBE_AUDIENCE_RECIPIENT_TO_GROUPAdd an existing MailUp recipient to one group. With confirm_subscription=true, also subscribe the recipient to the group’s owning list; with confirm_subscription=false, assign the recipient to the group without changing the list subscription.Input Parameters
Output
Subscribe Recipient To List
Subscribe Recipient To List
MAIL_UP_SUBSCRIBE_RECIPIENT_TO_LISTExtend an already-subscribed email recipient’s membership to one additional MailUp list; this cannot reactivate an unsubscribed email recipient. The tool reads back the recipient’s email subscription state after requesting the change, so verification can fail after the subscription request has been sent.Input Parameters
Output
Subscribe SMS Recipient To Group
Subscribe SMS Recipient To Group
MAIL_UP_SUBSCRIBE_SMS_RECIPIENT_TO_GROUPAdd an existing SMS recipient to one MailUp group. With confirm_subscription=true, also subscribe the recipient to the group’s owning list; with confirm_subscription=false, assign the recipient to the group without changing the list subscription. The account must have SMS service entitlement; observe MailUp’s limit of 5 calls per second.Input Parameters
Output
Subscribe SMS Recipient To List
Subscribe SMS Recipient To List
MAIL_UP_SUBSCRIBE_SMS_RECIPIENT_TO_LISTSubscribe an existing recipient to the SMS channel of one MailUp list and read back the resulting SMS subscription state; verification can fail after the subscription request has been sent. SMS entitlement is required; observe the 5 calls per second limit.Input Parameters
Output
Unsubscribe Audience Recipient From Group
Unsubscribe Audience Recipient From Group
Unsubscribe Audience Recipient From Lists
Unsubscribe Audience Recipient From Lists
Unsubscribe Recipient From List
Unsubscribe Recipient From List
Unsubscribe SMS Recipient From List
Unsubscribe SMS Recipient From List
Unsubscribe SMS Recipient From Lists
Unsubscribe SMS Recipient From Lists
Update Audience Group
Update Audience Group
Update Audience Recipient Detail
Update Audience Recipient Detail
Update Content Source
Update Content Source
Update Email Message
Update Email Message
MAIL_UP_UPDATE_EMAIL_MESSAGEUpdate an existing MailUp email message’s subject and content while preserving omitted settings; this changes the draft and does not send it.Input Parameters
Output
Update List
Update List
MAIL_UP_UPDATE_LISTUpdate settings on one MailUp list by merging supplied values with the current settings; concurrent changes may be overwritten. This does not change membership or send messages; access depends on list permissions and standard REST traffic is limited to 5 calls per second.Input Parameters
Output
Update Online Email Visibility
Update Online Email Visibility
Update Personalization Endpoint
Update Personalization Endpoint
MAIL_UP_UPDATE_PERSONALIZATION_ENDPOINTReplace the configuration of one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account.Input Parameters
Output
Update SMS Message
Update SMS Message
MAIL_UP_UPDATE_SMS_MESSAGEReplace documented fields of one MailUp SMS draft without sending it. The account needs SMS entitlement; observe MailUp’s limit of 5 calls per second.Input Parameters
Output
Update Source Contents
Update Source Contents