Add MailUp to your AI agent

Create a recipient group in one MailUp list and return the complete group record.

Create a named content-provider source in MailUp.

Create a draft email campaign message in one MailUp list without sending it.

Create a new draft email message in a MailUp list from an existing template without sending it.

Create 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.

Create a MailUp endpoint used to obtain external personalization data. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Create a MailUp SMS draft without sending or consuming delivery credits. The account needs SMS entitlement; observe MailUp's limit of 5 calls per second.

Create 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.

Create a named tag in one MailUp list for organizing email messages.

Permanently delete one MailUp group. This does not delete its recipients from the parent list.

Delete one recipient record from one MailUp list only; other list memberships are unaffected.

Permanently delete one MailUp recipient from every list in the account. This high-impact operation can remove all list memberships and returns a result for each affected list.

Permanently delete one MailUp content-provider source.

Permanently delete one MailUp email message from a list. This does not cancel an already queued sending.

Permanently delete the image at an exact full MailUp path from provider storage. This destructive operation has no list-specific route, requires image access, and counts toward the 5-calls-per-second standard REST limit.

Permanently delete one MailUp list and its list-scoped configuration. This destructive operation requires console permission, cannot be undone, and is subject to MailUp's 5-calls-per-second standard REST limit.

Permanently remove the attachment in one slot from a MailUp email message and return the remaining attachments.

Permanently delete one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Delete 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.

Permanently delete one MailUp SMS draft without sending it. Requires SMS service entitlement; observe MailUp's limit of 5 calls per second.

Permanently delete one keyed content item from a MailUp content-provider source.

Permanently delete one tag from a MailUp list; messages using it may lose that classification.

Disable 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.

Remove one MailUp personalization endpoint association from a list. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Remove every recipient membership from one MailUp group. This high-impact operation leaves the group and parent-list recipients intact.

Enable or disable dynamic recipient-field substitution on one MailUp email message and return its complete current details.

Explicitly enable or disable dynamic recipient-field substitution for one MailUp SMS draft. Requires SMS entitlement; limit traffic to 5 calls per second.

Explicitly enable or disable email tracking for one recipient across every MailUp list. The enable boolean is the desired final state.

Explicitly enable or disable email tracking for one recipient on one MailUp list. The enable boolean is the desired final state.

Find MailUp recipients by email address, mobile number, or both; this endpoint cannot list recipients without a lookup value.

Return the connected MailUp account identity, plan, trial status, expiry, and available credits; use this before credit-dependent sending.

Return the authenticated MailUp account identity, console version, trial flag, and optional expiry/URL. This is account metadata, not credits or plan details, and is subject to the 5-calls-per-second standard REST limit.

Return one page of archived email messages from a specific MailUp list.

Get the first useful MailUp date for scheduling a sending task.

Return 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.

Return 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.

Return the content, subject, tracking settings, tags, dynamic fields, and attachments for one MailUp email message.

Return one page of send-history records across all email messages in one MailUp list.

Return metadata and content for one email template in a MailUp list.

Return one page of email templates defined in a specific MailUp list.

Return 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.

Return the complete MailUp import configuration and nested valid/invalid row totals for one import ID. Access follows the connected user's list permissions and standard REST traffic is limited to 5 calls per second.

Return the sending and message IDs for confirmation requests generated by one MailUp import. Data exists only when that import generated confirmation messages; standard REST traffic is limited to 5 calls per second.

Return completion and recipient outcome counts for an asynchronous MailUp import ID.

Return 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.

Return configuration and sender details for one MailUp mailing list by ID.

Create an ephemeral URL that logs a user into the MailUp platform. This is a feature-gated SSO operation: MailUp must enable SSO for the connected platform account before this action can succeed.

Return one page of cloned and original email messages across lists for the current MailUp user.

Return all attachment slots currently configured on one MailUp email message.

Return aggregate recipient, view, click, bounce, and unsubscription counts for one MailUp email message using five read-only statistics calls. Counts can be zero after MailUp's message-recipient retention period expires.

Return 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.

Return 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.

Return 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.

Retrieve one MailUp personalization endpoint including its configured details. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Return one page of email messages currently visible online for a specific MailUp list.

Return contact details, dynamic fields, and list membership states for one MailUp recipient ID.

Return aggregate delivery, view, click, bounce, and unsubscription counts for one MailUp recipient using five rate-limited, read-only statistics calls. Counts can be zero after MailUp's message-recipient retention period expires.

Request 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.

Return 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.

Return 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.

Return 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.

Return 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.

Return 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.

Return 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.

Return 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.

List the SMTP+ priority codes available in MailUp. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account.

Return 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.

Return one page of enabled tags configured for a specific MailUp list.

Return 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.

Get one recipient's email tracking status across every MailUp list.

Get one recipient's email tracking status for a specific MailUp list.

Get one trusted sender registration by ID. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.

Return one page of trusted sender registrations. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.

Return 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.

Return 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.

Synchronously 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.

Synchronously 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.

Queue 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.

Return one page of subscribed and unsubscribed email recipients for a MailUp list with complete opt-in and opt-out details.

Return one page of a MailUp recipient's email subscription status and opt-in/opt-out history across lists.

Return one page of subscribed and unsubscribed SMS recipients for a MailUp list with complete opt-in and opt-out details.

Return one page of a MailUp recipient's SMS subscription status and opt-in/opt-out history across lists.

Return one page of MailUp content-provider sources.

Return MailUp's complete unpaged country-code reference for list sender settings. Availability follows console access and the call is subject to the 5-calls-per-second standard REST limit.

Return 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.

Return one page of email campaign messages in a MailUp list, including message IDs used by message editing, sending, and statistics tools.

Return one page of completed send-history records for a specific MailUp email message.

Return one page of MailUp email sending tasks for one queue state: pending scheduling, immediate, or deferred.

Return one page of recipients currently associated with a MailUp group.

Return one page of recipient groups in a MailUp list, including group IDs used by group-scoped tools.

Return 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.

Return MailUp's complete reference table for interpreting import status_code values. This unpaged metadata call is subject to the 5-calls-per-second standard REST limit.

Return 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.

Return one page of recipients in a MailUp list for one subscription state: subscribed, pending, or unsubscribed.

Return MailUp's complete unpaged list-purpose reference table for scope_code settings. These are provider list-purpose codes, not OAuth scopes; the call is subject to the 5-calls-per-second standard REST limit.

Return one page of mailing lists available to the connected MailUp user, including the list IDs required by list-scoped tools.

Return 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.

Return 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.

Return 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.

Return one page of MailUp personalization endpoints. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Retrieve all personalization endpoints associated with one MailUp list. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Return 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.

Return 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.

Return 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.

Return one page of groups to which a recipient belongs within one MailUp list.

Return one page of content items from one MailUp content-provider source.

Return MailUp's complete unpaged time-zone reference for list settings. Availability follows Console access and the call is subject to MailUp's 5-calls-per-second standard REST limit.

Register 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.

Reset 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.

Queue 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.

Explicitly 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.

Irreversibly 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.

Explicitly 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.

Irreversibly 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.

Irreversibly 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.

Irreversibly 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.

Irreversibly 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.

Irreversibly 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.

Irreversibly 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.

Stop 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.

Add 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.

Extend an already-subscribed email recipient's membership to one additional MailUp list. This cannot reactivate an email recipient who is unsubscribed.

Add 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.

Subscribe an existing recipient to the SMS channel of one MailUp list. The account must have SMS entitlement; observe the 5 calls per second limit.

Remove one recipient from a MailUp group without unsubscribing that recipient from the parent list.

Unsubscribe one recipient from every explicitly supplied MailUp list ID in one request. This high-impact bulk subscription change does not delete the recipient record and reports both successful and failed list IDs.

Unsubscribe an existing email recipient from one MailUp list and remove the recipient from every group owned by that list, without deleting the global recipient record or changing the SMS channel.

Remove one recipient's SMS subscription from one MailUp list without deleting the recipient. Requires SMS entitlement; observe the 5 calls per second limit.

Remove one recipient's SMS subscriptions from an explicit set of MailUp lists and report per-list results. Requires SMS entitlement; limit traffic to 5 calls per second.

Update explicitly supplied fields of a MailUp group; omitted body fields are not sent.

Update explicitly supplied contact and dynamic-field details for a MailUp address-book recipient; omitted fields are not sent.

Update supplied settings of one MailUp content-provider source.

Update an existing MailUp email message's subject and content while preserving omitted settings; this changes the draft and does not send it.

Update only supplied settings on one MailUp list. This does not change membership or send messages; access depends on list permissions and standard REST traffic is limited to 5 calls per second.

Publish or hide one MailUp email message on the list's online archive; this does not send the message.

Replace the configuration of one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Replace documented fields of one MailUp SMS draft without sending it. The account needs SMS entitlement; observe MailUp's limit of 5 calls per second.

Add or update content items in one MailUp content-provider source and return the activity ID.

Replace the name and optionally the enabled state of one tag in a MailUp list.