Skip to main content
MailUp logo
  • Category: email
  • Auth: OAUTH2
  • Composio-managed OAuth available? No
  • Tools: 151
  • Triggers: 0
  • Slug: MAIL_UP
  • Version: 20261101_00

Tools

Slug: 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

string
required
Required image filename; the provider XSD permits null, although MailUp may reject it.
string ("shared" | "list")
required
Use shared to add to the console library or list to add to one mailing list.
integer
Required only when scope is list; omitted for shared images.
string
required
Required base64-encoded image bytes without a data-URL prefix; the provider XSD permits null, although MailUp may reject it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ADD_MESSAGE_ATTACHMENTSUpload base64-encoded bytes into a specific attachment slot on one MailUp email message.

Input Parameters

string
required
Attachment file name; MailUp’s contract permits null.
integer
required
Zero-based MailUp attachment slot.
integer
required
Positive MailUp list ID containing the email message.
integer
required
Positive MailUp email message ID.
string
required
Base64-encoded attachment bytes; MailUp’s contract permits null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ASSOCIATE_PERSONALIZATION_ENDPOINT_WITH_LISTAssociate an existing MailUp personalization endpoint with one list. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Input Parameters

integer
required
MailUp list ID to associate with the endpoint.
integer
required
Personalization endpoint ID to associate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp group ID that will receive the SMS recipients.
string
required
SMS recipient array; the provider XSD permits null and null items.
boolean
When true, remove recipients from previous groups before adding them to this group.
boolean
When true, clear MailUp recipient fields omitted or empty in this import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID that will receive the SMS recipients.
string
required
SMS recipient array; the provider XSD permits null and null items.
boolean
When true, clear MailUp recipient fields omitted or empty in this import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Required recipient Name string; an empty string is allowed.
integer
required
MailUp group ID that will receive the SMS recipient.
integer
Optional existing idRecipient; omit rather than sending null.
string
required
Required recipient MobileNumber without its prefix; cannot be null.
string
required
Required recipient MobilePrefix string; an empty string is allowed.
array
Optional Fields array; null entries are accepted by the XSD.
boolean
When true, remove the recipient from previous groups before adding it to this group.
boolean
When true, clear MailUp recipient fields omitted or empty in this import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Required recipient Name string; an empty string is allowed.
integer
required
MailUp list ID that will receive the SMS recipient.
integer
Optional existing idRecipient; omit rather than sending null.
string
required
Required recipient MobileNumber without its prefix; cannot be null.
string
required
Required recipient MobilePrefix string; an empty string is allowed.
array
Optional Fields array; null entries are accepted by the XSD.
boolean
When true, clear MailUp recipient fields omitted or empty in this import.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID from which to remove every recipient membership.
array
required
Unique positive MailUp recipient IDs to unsubscribe sequentially, in request order. Pass 1-20 IDs; the conservative cap and 210 ms spacing keep this action below MailUp’s limit of 5 requests per second.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CONFIRM_SMS_NUMERIC_SENDERConfirm a MailUp numeric SMS sender using the code previously delivered by the sender-confirmation flow. Confirmation and SMS entitlement may be required before sending; observe MailUp’s limit of 5 calls per second.

Input Parameters

string
required
Numeric SMS sender that previously requested a confirmation code.
string
required
Confirmation code as a raw JSON string; required but nullable by the contract.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_COPY_EMAIL_MESSAGECreate a copy of one MailUp email message, optionally replacing its subject or internal notes; this does not send it.

Input Parameters

string
Internal notes for the copy; omission leaves Notes out of the body.
integer
required
Positive MailUp list ID containing the email message.
string
Subject for the copy; omission leaves Subject out of the body.
integer
required
Positive MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp email message ID whose sending-recipient count to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_COUNT_SUBSCRIBERSReturn the subscribed-recipient count for a MailUp list or, when group_id is supplied, for one group in that list.

Input Parameters

integer
required
MailUp list ID whose subscribers to count.
integer
Optional MailUp group ID; when supplied, count subscribers in this group instead of the whole list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CREATE_AUDIENCE_GROUPCreate a recipient group in one MailUp list and return the complete group record.

Input Parameters

string
Group name; null is accepted by the provider contract.
integer
Provider-maintained recipient count; normally omit when creating a group.
string
Group notes; null is accepted by the provider contract.
integer
required
MailUp list ID in which to create the group.
integer
Provider-assigned group ID; normally omit when creating a new group.
boolean
Whether MailUp may delete the group; normally omit so MailUp chooses.
integer
Owning list ID repeated in the body; normally omit because list_id selects it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CREATE_CONTENT_SOURCECreate a named content-provider source in MailUp.

Input Parameters

boolean
required
Whether the new content source is enabled.
string
required
Content source name; MailUp accepts an explicit null value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CREATE_EMAIL_MESSAGECreate a draft email campaign message in one MailUp list without sending it.

Input Parameters

array
Optional message tags that already exist in the target MailUp list; explicit null is sent as null.
string
Optional internal notes for the message; explicit null is preserved.
string
required
Email body content in the format expected by the list, commonly HTML.
integer
required
MailUp list ID in which to create the draft message.
string
required
Email subject line.
object
MailUp tracking configuration; omission sends tracking disabled.
string
Provider-defined structured-editor metadata. Normally omit this; only supply a Structure value copied from MAIL_UP_GET_EMAIL_MESSAGE.
string
Optional preview text; explicit null is preserved.
boolean
Whether MailUp should embed referenced images.
array
Optional dynamic-field definitions. To activate them, supply the definitions and set use_dynamic_fields to true; otherwise leave both omitted for the disabled default. Explicit null is sent as null.
boolean
Whether this draft is a confirmation message.
boolean
Set true with dynamic_fields to activate dynamic recipient fields, or false to keep them disabled. Omission uses MailUp’s disabled default; explicit null is not accepted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CREATE_EMAIL_MESSAGE_FROM_TEMPLATECreate a new draft email message in a MailUp list from an existing template without sending it.

Input Parameters

integer
required
Positive MailUp list ID containing the template.
integer
required
Positive MailUp email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Required sender city; MailUp accepts null.
string
required
Required list name; MailUp accepts null.
string
Optional sender phone number.
string ("html" | "text")
Default email format: ‘html’ or ‘text’. Use multipart_text separately to enable multipart text.
integer
Maximum message size in kilobytes.
boolean
Whether the list is public.
string
required
Required sender postal address; MailUp accepts null.
string
Character set used by the list.
string
required
Required business-account flag; MailUp accepts null.
string
required
Required customer-account flag; MailUp accepts null.
string
required
Required reply-to address; MailUp accepts null.
string
List disclaimer text.
string
Optional display name.
integer
List-purpose code returned by the public MAIL_UP_LIST_LIST_SCOPES tool; use it to select a valid value.
string
List description.
integer
Source settings ID to copy. Supply this field or use_default_settings; at least one is required.
integer
MailUp opt-out mode code configured for the account; preserve an existing value unless the intended account mode is known.
string
required
Required list owner email; MailUp accepts null.
string
Optional sender postal code.
string
required
Required sender company name; MailUp accepts null.
string
required
Required sender contact name; MailUp accepts null.
string
required
Required country code; MailUp accepts null. Use GET_COUNTRY_CODES for valid values.
string
Notification email address.
string
required
Required sender website URL; MailUp accepts null.
string
Address used for bounced email notifications.
boolean
Whether the front-end subscription form is enabled.
string
Default international mobile prefix.
string
X-Abuse header value.
boolean
Whether multipart text is enabled.
string
required
Required newsletter sender name; MailUp accepts null.
string
MailUp list time-zone code.
string
SMS sender name.
boolean
Whether opened-message tracking is enabled.
boolean
Whether subscription confirmation SMS is sent.
boolean
Whether subscription email notifications are enabled.
string
Comma-separated MailUp list IDs also affected by a multi-list opt-out.
boolean
Whether an email is sent on opt-out.
string
Optional sender state or province.
boolean
Copy webhook settings when MailUp supports the source settings.
string
required
Required permission reminder; MailUp accepts null.
boolean
Whether MailUp should apply default list settings. Supply this field or id_settings; at least one is required.
string
ConversionLab tracking code.
string
List-Unsubscribe header value.
Parameters appended for link tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Endpoint URL; the MailUp contract permits null.
string
required
Endpoint label; the MailUp contract permits null.
array
Optional endpoint headers, or null.
object
Optional recipient mapping, or null.
array
Optional personalization parameters, or null.
object
Optional endpoint username and password, or null.
string
Provider-managed endpoint update timestamp; normally omit on create or update.
string
Provider-managed endpoint creation timestamp; normally omit on create or update.
integer
Existing numeric personalization endpoint ID repeated in the body; omit on create and normally omit on update because the route identifies it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional Tags array; null entries are accepted by XSD.
string
Optional internal Notes.
string
Optional draft Sender value; MailUp uses the list-level SMS sender for delivery regardless of this field.
string
required
SMS Content; required but nullable by XSD.
integer
required
MailUp list ID in which to create the SMS draft.
string
required
SMS Subject; required but nullable by XSD.
string
MailUp editor structure metadata; omit unless preserving a Structure value obtained from MailUp.
boolean
Optional non-null IsUnicode flag.
integer
Provider-assigned numeric SMS message ID; normally omit when creating a draft.
string
Provider-managed SMS draft creation timestamp; normally omit when creating.
array
Optional Fields array; null entries are accepted by XSD.
boolean
Optional non-null UseDynamicField flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Account note; MailUp accepts null.
integer
required
MailUp list ID.
boolean
required
Whether the new SMTP+ account is enabled.
integer
required
SMTP+ priority code returned by GET_SMTP_PLUS_PRIORITY_CODES.
string
required
Trusted domains. At least one non-empty domain or trusted sender is required.
string
required
Confirmed trusted sender addresses. At least one non-empty sender or trusted domain is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_CREATE_TAGCreate a named tag in one MailUp list for organizing email messages.

Input Parameters

string
required
Name of the new MailUp tag.
integer
required
Positive MailUp list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_AUDIENCE_GROUPPermanently delete one MailUp group. This does not delete its recipients from the parent list.

Input Parameters

integer
required
Owning MailUp list ID.
integer
required
MailUp group ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_AUDIENCE_RECIPIENT_FROM_LISTDelete one recipient record from one MailUp list only; other list memberships are unaffected.

Input Parameters

integer
required
MailUp list ID from which to delete the recipient.
integer
required
MailUp recipient ID to delete from this list only.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_AUDIENCE_RECIPIENT_GLOBALLYPermanently 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.

Input Parameters

integer
required
MailUp recipient ID to delete from every list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_CONTENT_SOURCEPermanently delete one MailUp content-provider source.

Input Parameters

integer
required
Content source ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_EMAIL_MESSAGEPermanently delete one MailUp email message from a list. This does not cancel an already queued sending.

Input Parameters

integer
required
MailUp list ID containing the message.
integer
required
MailUp email message ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Exact full image path returned by LIST_IMAGES. MailUp receives this as a raw JSON string body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_LISTPermanently 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.

Input Parameters

integer
required
MailUp list ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_MESSAGE_ATTACHMENTSPermanently remove the attachment in one slot from a MailUp email message and return the remaining attachments.

Input Parameters

integer
required
Zero-based MailUp attachment slot.
integer
required
Positive MailUp list ID containing the email message.
integer
required
Positive MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_PERSONALIZATION_ENDPOINTPermanently delete one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Input Parameters

integer
required
Personalization endpoint ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp sending task ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_SMS_MESSAGEPermanently delete one MailUp SMS draft without sending it, then verify its absence from the list; verification can fail after deletion. Requires SMS service entitlement; observe MailUp’s limit of 5 calls per second.

Input Parameters

integer
required
MailUp list ID containing the SMS message.
integer
required
MailUp SMS message ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_SOURCE_CONTENTPermanently delete one keyed content item from a MailUp content-provider source.

Input Parameters

integer
required
Content source ID containing the item.
string
required
Source-specific content key to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DELETE_TAGPermanently delete one tag from a MailUp list; messages using it may lose that classification.

Input Parameters

integer
required
Positive MailUp tag ID.
integer
required
Positive MailUp list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
MailUp trusted sender ID to disable.
string
required
Exact trusted sender email address expected for trusted_sender_id. The action checks this before deletion because MailUp may return the same ID for multiple senders.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_DISASSOCIATE_PERSONALIZATION_ENDPOINT_FROM_LISTRemove one MailUp personalization endpoint association from a list. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Input Parameters

integer
required
MailUp list ID to disassociate from the endpoint.
integer
required
Personalization endpoint ID to disassociate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_EMPTY_AUDIENCE_GROUPRemove every recipient membership from one MailUp group. This high-impact operation leaves the group and parent-list recipients intact.

Input Parameters

integer
required
Owning MailUp list ID.
integer
required
MailUp group ID to empty.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ENABLE_DYN_FIELDS_ON_EMAIL_MESSAGEEnable or disable dynamic recipient-field substitution on one MailUp email message and return its complete current details.

Input Parameters

string ("true" | "false")
required
Use ‘true’ to enable dynamic fields or ‘false’ to disable them.
integer
required
Positive MailUp list ID containing the email message.
integer
required
Positive MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ENABLE_DYN_FIELDS_ON_SMS_MESSAGEExplicitly enable or disable dynamic recipient-field substitution for one MailUp SMS draft. Requires SMS entitlement; limit traffic to 5 calls per second.

Input Parameters

string ("true" | "false")
required
Use ‘true’ to enable or ‘false’ to disable dynamic-field substitution.
integer
required
MailUp list ID containing the SMS message.
integer
required
MailUp SMS message ID whose setting will change.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ENABLE_TRACKING_FOR_EVERY_LISTExplicitly enable or disable email tracking for one recipient across every MailUp list. The enable boolean is the desired final state.

Input Parameters

boolean
required
Set true to enable tracking or false to disable it across every list.
integer
required
MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_ENABLE_TRACKING_FOR_SINGLE_LISTExplicitly enable or disable email tracking for one recipient on one MailUp list. The enable boolean is the desired final state.

Input Parameters

boolean
required
Set true to enable tracking or false to disable it for this list.
integer
required
MailUp list ID.
integer
required
MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_FIND_RECIPIENTSFind MailUp recipients by email address, mobile number, or both; this endpoint cannot list recipients without a lookup value.

Input Parameters

string
Email address to find; email or mobile_number must be supplied.
string
Opaque next_cursor from a previous call; omit for the first page.
integer
Maximum matching recipients to return in this page.
string
Mobile number to find; email or mobile_number must be supplied.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_ACCOUNT_DETAILSReturn the connected MailUp account identity, plan, trial status, expiry, and available credits; use this before credit-dependent sending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_ACCOUNT_INFOReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_ARCHIVED_MAIL_MESSAGES_BY_LISTReturn one page of archived email messages from a specific MailUp list.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
Positive MailUp list ID.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_DATE_FOR_DEFERRED_DISPATCHGet the first useful MailUp date for scheduling a sending task.

Input Parameters

integer
required
MailUp sending task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Positive MailUp SMS sending-task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_EMAIL_MESSAGEReturn the content, subject, tracking settings, tags, dynamic fields, and attachments for one MailUp email message.

Input Parameters

integer
required
MailUp list ID containing the message.
integer
required
MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_EMAIL_SEND_HISTORYReturn one page of send-history records across all email messages in one MailUp list.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
Positive MailUp list ID.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_EMAIL_TEMPLATE_DETAILSReturn metadata and content for one email template in a MailUp list.

Input Parameters

integer
required
Positive MailUp list ID containing the template.
integer
required
Positive MailUp email template ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_EMAIL_TEMPLATESReturn one page of email templates defined in a specific MailUp list.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
Positive MailUp list ID.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_IMPORT_DETAILSReturn 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.

Input Parameters

integer
required
MailUp import ID to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_IMPORT_SENDINGReturn confirmation-message sending linkage for one MailUp import, including sending and message IDs when available. An empty response is returned as unavailable with null linkage fields.

Input Parameters

integer
required
Import ID whose confirmation-message sending linkage to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_IMPORT_STATUSReturn completion and recipient outcome counts for an asynchronous MailUp import ID.

Input Parameters

integer
required
Import ID returned by a MailUp recipient import tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_LISTReturn configuration and sender details for one MailUp mailing list by ID.

Input Parameters

integer
required
MailUp list ID, available from MAIL_UP_LIST_LISTS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_LOGIN_URLCreate 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_MAIL_MESSAGES_BY_USERReturn one page of cloned and original email messages across lists for the current MailUp user.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_MESSAGE_ATTACHMENTSReturn all attachment slots currently configured on one MailUp email message.

Input Parameters

integer
required
Positive MailUp list ID containing the email message.
integer
required
Positive MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_MESSAGE_STATISTICSReturn 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.

Input Parameters

integer
required
MailUp email message ID whose aggregate statistics to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp email message ID whose precompiled statistics-page URLs to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.
string
required
Required inclusive history start date in exactly yyyyMMdd format. MailUp rejects the locale-formatted default it generates when this value is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_PERSONALIZATION_ENDPOINTRetrieve one MailUp personalization endpoint including its configured details. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Input Parameters

integer
required
Personalization endpoint ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_PUBLISHED_MAIL_MESSAGES_BY_LISTReturn one page of email messages currently visible online for a specific MailUp list.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
Positive MailUp list ID.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_RECIPIENTReturn contact details, dynamic fields, and list membership states for one MailUp recipient ID.

Input Parameters

integer
required
MailUp recipient ID returned by a recipient list, group, import, or lookup tool.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_RECIPIENT_STATISTICSReturn 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.

Input Parameters

integer
required
MailUp recipient ID whose aggregate engagement statistics to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Numeric SMS sender registered with MailUp. A leading E.164 plus is accepted and normalized to digits for MailUp’s IIS path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Positive MailUp list ID containing the SMS message.
integer
required
Positive MailUp SMS message ID within the specified list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.
integer
required
Positive MailUp SMS message ID within the specified list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Positive MailUp SMS message ID whose aggregate report is requested.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.
integer
required
Positive MailUp SMS message ID whose sending report is requested.
integer
Optional Transactional SMS DeliveryId. When supplied, MailUp returns at most one detail, so further filtering and paging are unnecessary.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Numeric SMS sender registered with MailUp. A leading E.164 plus is accepted and normalized to digits for MailUp’s IIS path.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp group ID whose SMS-channel recipients are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_SMTP_PLUS_PRIORITY_CODESList the SMTP+ priority codes available in MailUp. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_TAGSReturn one page of enabled tags configured for a specific MailUp list.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
Positive MailUp list ID.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Name desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; Name eq 'VIP'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.
string
required
Required inclusive history start date in exactly yyyyMMdd format. MailUp rejects the locale-formatted default it generates when this value is omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_TRACKING_STATUS_FOR_EVERY_LISTGet one recipient’s email tracking status across every MailUp list.

Input Parameters

integer
required
MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_TRACKING_STATUS_FOR_SINGLE_LISTGet one recipient’s email tracking status for a specific MailUp list.

Input Parameters

integer
required
MailUp list ID.
integer
required
MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_GET_TRUSTED_SENDERGet one trusted sender registration by ID. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account.

Input Parameters

string
required
MailUp trusted sender ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id asc; IsActive desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Id gt 0; IsActive eq true.
integer
Maximum trusted senders to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from this action’s previous page; omit for page zero.
integer
required
Positive MailUp list ID whose SMS-channel records are requested.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdRecipient asc; Status asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; IdRecipient gt 0; Status eq 'Subscribed'.
integer
Maximum records in this page; defaults to 10. MailUp supports larger requested pages.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Recipient name.
string
required
Recipient email address; required by MailUp but may be null.
integer
required
MailUp group ID that will receive the recipient.
integer
Existing MailUp recipient ID, when known.
boolean
False immediately subscribes a new recipient, matching MailUp’s default. True sends a confirmation email automatically and leaves a new recipient Pending. A Pending recipient receives another confirmation email; an Unsubscribed recipient moves to Pending.
string
Recipient mobile number.
string
Recipient international prefix.
array
Dynamic fields to write; omission preserves provider defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Recipient name.
string
required
Recipient email address; required by MailUp but may be null.
integer
required
MailUp list ID that will receive the recipient.
integer
Existing MailUp recipient ID, when known.
boolean
False immediately subscribes a new recipient, matching MailUp’s default. True sends a confirmation email automatically and leaves a new recipient Pending. A Pending recipient receives another confirmation email; an Unsubscribed recipient moves to Pending.
string
Recipient mobile number.
string
Recipient international prefix.
array
Dynamic fields to write; omission preserves provider defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
required
Non-empty recipient batch. Every recipient requires recipient_id, email, or mobile_number; supplying more than one identifier is allowed.
string
Set to asOptout to make every supplied recipient Optout except recipients already Pending; this can unsubscribe existing Subscribed recipients. Omit for MailUp’s normal subscription behavior.
boolean
False immediately subscribes new recipients, matching MailUp’s default. True leaves new recipients Pending and generates confirmation emails, but does not send them.
boolean
When true, ignore mobile-number data in the imported recipient rows.
integer
required
Positive MailUp list or group ID selected by destination_type.
string ("list" | "group")
required
Whether destination_id identifies a MailUp list or group.
boolean
Group imports only. When true, remove recipients from their previous groups before adding them to the destination group.
boolean
When true, permanently clear stored recipient fields that are missing or empty in the imported rows.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque continuation cursor; omit for the first page.
integer
required
MailUp list ID whose email opt-ins to list.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Status asc; Email asc, Optin_Date desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Status eq 'Subscribed'; Email eq 'ada@example.com'.
integer
Maximum opt-in records to return, from 1 through 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque continuation cursor; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdList asc; Status asc, IdList asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdList eq 7; Status eq 'Subscribed'.
integer
Maximum opt-in records to return, from 1 through 10.
integer
required
MailUp recipient ID whose email list opt-ins to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque continuation cursor; omit for the first page.
integer
required
MailUp list ID whose SMS opt-ins to list.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Status asc; MobilePrefix asc, MobileNumber asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Status eq 'Subscribed'; MobilePrefix eq '+39'.
integer
Maximum opt-in records to return, from 1 through 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque continuation cursor; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdList asc; Status asc, IdList asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdList eq 7; Status eq 'Subscribed'.
integer
Maximum opt-in records to return, from 1 through 10.
integer
required
MailUp recipient ID whose SMS list opt-ins to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_CONTENT_SOURCESReturn one page of MailUp content-provider sources.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: SourceName asc; Label desc, IdEndpoint asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: SourceName eq 'Catalog'; Label eq 'CRM'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_COUNTRY_CODESReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id asc; Description desc, Id asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Id gt 0; Description ne null.
integer
Maximum dynamic fields to return in this page; MailUp collection calls are capped here at 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Raw comma-separated tag IDs or names; a message matches when it has at least one. Quote a tag name containing a comma, for example 13,customers,'hello, world'.
string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
MailUp list ID containing the email messages.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Subject asc; Subject asc, idMessage desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Subject eq 'Welcome'; idMessage gt 0.
integer
Maximum messages to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_EMAIL_SEND_HISTORYReturn one page of completed send-history records for a specific MailUp email message.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
MailUp list ID containing the message.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id desc; Subject asc, Id desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Id gt 0; Subject eq 'Welcome'.
integer
Maximum history records to return in this page.
integer
required
MailUp email message ID whose history to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_EMAIL_SENDINGSReturn one page of MailUp email sending tasks for one queue state: pending scheduling, immediate, or deferred.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Id desc; State asc, Id desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Id gt 0; State eq 'Waiting'.
integer
Maximum sending tasks to return in this page.
string ("pending_scheduling" | "immediate" | "deferred")
required
Sending queue state to inspect.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_GROUP_RECIPIENTSReturn one page of recipients currently associated with a MailUp group.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
MailUp group ID, available from MAIL_UP_LIST_GROUPS.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Email asc; Email asc, idRecipient desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Email eq 'ada@example.com'; idRecipient gt 0.
integer
Maximum recipients to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_GROUPSReturn one page of recipient groups in a MailUp list, including group IDs used by group-scoped tools.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
MailUp list ID containing the groups.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Name asc; Name asc, idGroup desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Name eq 'Customers'; idGroup gt 0.
integer
Maximum groups to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string ("shared" | "list")
required
Use shared for console-wide images or list for images belonging to one mailing list.
integer
Required only when scope is list; omitted for shared images.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdImport desc; StatusCode asc, IdImport desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdImport gt 0; StatusCode eq 2.
integer
Maximum imports to return in this page; MailUp collection calls are capped here at 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_IMPORT_STATUS_CODESReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_LIST_RECIPIENTSReturn one page of recipients in a MailUp list for one subscription state: subscribed, pending, or unsubscribed.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
integer
required
MailUp list ID whose recipients to return.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Email asc; Email asc, idRecipient desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Email eq 'ada@example.com'; idRecipient gt 0.
integer
Maximum recipients to return in this page.
string ("subscribed" | "pending" | "unsubscribed")
Subscription state to return: subscribed, pending, or unsubscribed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Name asc; Name asc, IdList desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Name eq 'Newsletter'; IdList gt 0.
integer
Maximum lists to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_LIST_SCOPESReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdRecipient asc; Email asc, IdRecipient asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdRecipient gt 0; Email eq 'ada@example.com'.
integer
Maximum events to return in this page.
string ("delivery" | "view" | "click" | "bounce" | "unsubscription")
required
Recipient-level event type to return.
integer
required
MailUp email message ID whose events to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; it preserves message, page size, filter, and order.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdRecipient asc; Email asc, IdRecipient asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdRecipient gt 0; Email eq 'ada@example.com'.
integer
Maximum clicked-link details in this page, capped at 10.
integer
required
MailUp email message ID whose per-link recipient details to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; it preserves message, page size, filter, and order.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: Clicks desc; Clicks desc, Url asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: Url eq 'https://example.com'; Clicks gt 0.
integer
Maximum clicked-link rollups to return in this page, capped at 10.
integer
required
MailUp email message ID whose clicked-link rollups to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: SourceName asc; Label desc, IdEndpoint asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: SourceName eq 'Catalog'; Label eq 'CRM'.
integer
Maximum records to return in this page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_PERSONALIZATION_ENDPOINTS_BY_LISTRetrieve all personalization endpoints associated with one MailUp list. This operation requires Personalization to be enabled by MailUp for the connected platform account.

Input Parameters

integer
required
MailUp list ID whose associated endpoints to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; Subject asc, IdMessage desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; Subject eq 'Welcome'.
integer
Maximum activity records to return in this page.
integer
required
MailUp recipient ID whose activity to return.
string ("delivery" | "view" | "click" | "bounce" | "unsubscription")
required
Recipient activity type to return: delivery, view, click, bounce, or unsubscription.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; it preserves recipient, page size, filter, and order.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; Type asc, IdMessage desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; Type eq 'HardBounce'.
integer
Maximum bounce details in this page, capped at 10.
integer
required
MailUp recipient ID whose detailed message bounces to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Opaque next_cursor from a previous call; it preserves recipient, page size, filter, and order.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: IdMessage desc; IdMessage desc, Url asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: IdMessage gt 0; Url eq 'https://example.com'.
integer
Maximum message click details in this page, capped at 10.
integer
required
MailUp recipient ID whose per-message clicked-link details to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_RECIPIENT_GROUPSReturn one page of groups to which a recipient belongs within one MailUp list.

Input Parameters

string
Opaque continuation cursor; omit for the first page.
integer
required
MailUp list ID containing the recipient.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: idGroup asc; idList asc, idGroup desc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: idGroup gt 0; idList eq 7.
integer
Maximum groups to return, from 1 through 10.
integer
required
MailUp recipient ID whose group memberships to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_SOURCE_CONTENTSReturn one page of content items from one MailUp content-provider source.

Input Parameters

string
Opaque next_cursor from a previous call; omit for the first page.
string
Raw, unencoded MailUp order expression; the transport URL-encodes it. Use Field asc or Field desc. Separate multiple fields with commas. Endpoint-valid examples: ContentKey asc; ContentLoadingDate desc; ContentDate desc; Title asc.
string
Raw, unencoded MailUp filter expression; the transport URL-encodes it. Use comparison operators eq, ne, gt, ge, lt, and le; logical operators and, or, and not; and supported methods startswith, endswith, and substringof. Endpoint-valid examples: ContentKey eq 'sku-123'; ContentLoadingDate ge '2026-08-01'; ContentDate ge '2026-08-01'; Title eq 'Catalog item'.
integer
Maximum records to return in this page.
integer
required
Content source ID whose items to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_LIST_TIME_ZONESReturn 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.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Sender email address to register; MailUp accepts null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID.
string
required
SMTP+ username to reset; MailUp accepts null.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
UTC dispatch date in exact yyyy-MM-dd HH:mm:ssZ format, for example 2026-09-02 10:00:00Z; MailUp accepts null.
integer
required
MailUp sending task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Explicit provider-formatted Date for deferred dispatch; required but nullable by XSD.
integer
required
Existing MailUp SMS sending task ID to schedule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp sending task ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Existing MailUp SMS sending task ID to dispatch immediately.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Recipient email address; MailUp accepts null.
string
Dispatch control: omit or use 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.
string
Reply-to email address for this sending; omit to use MailUp’s configured default.
integer
required
Existing MailUp email message ID.
string
Sender display name override. Supply sender_address with it; omit both to use the list defaults.
string
Verified sender email address override. Supply sender_name with it; omit both to use the list defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Dispatch control: omit or use 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.
integer
required
Positive MailUp group ID whose recipients receive the message.
string
Reply-to email address for this sending; omit to use MailUp’s configured default.
integer
required
Positive MailUp email message ID to send.
string
Sender display name override. Supply sender_address with it; omit both to use the list defaults.
string
Verified sender email address override. Supply sender_name with it; omit both to use the list defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
Positive MailUp list ID containing the email message.
string
Dispatch control: omit or use 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.
string
Reply-to email address for this sending; omit to use MailUp’s configured default.
string
Comma-separated positive IDs of groups in this list whose members to include, for example 12,23,45. Omit rather than pass an empty value, which MailUp ignores and would broaden delivery to all list recipients.
integer
required
Positive MailUp email message ID.
string
Sender display name override. Supply sender_address with it; omit both to use the list defaults.
string
Comma-separated positive IDs of groups in this list whose members to exclude, for example 12,23,45. MailUp ignores the entire exclusion if any ID is not a group in this list.
string
Verified sender email address override. Supply sender_name with it; omit both to use the list defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Destination Number without country prefix; required but nullable by XSD.
integer
required
Integer international Prefix required by this endpoint.
integer
required
Existing MailUp SMS idMessage to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Optional UTC schedule in exactly yyyy-MM-dd HH:mm:ssZ format; omit to send immediately.
integer
required
MailUp group ID whose SMS recipients will receive the message.
integer
required
Existing MailUp SMS message ID to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID whose SMS recipients will receive the message.
string
Optional UTC schedule in exactly yyyy-MM-dd HH:mm:ssZ format; omit to send immediately.
integer
required
Existing MailUp SMS message ID to send.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp sending task ID to stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp group ID.
integer
required
Existing MailUp recipient ID to add to the group.
boolean
When true, also subscribe the recipient to the group’s owning list. When false, assign the recipient to the group without changing the list subscription. Defaults to true, matching MailUp’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID to subscribe the recipient to.
integer
required
Existing MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp group ID to receive the SMS recipient.
integer
required
Existing MailUp recipient ID to subscribe in the group.
boolean
When true, also subscribe the recipient to the group’s owning list. When false, assign the recipient to the group without changing the list subscription. Defaults to true, matching MailUp’s default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

integer
required
MailUp list ID to receive the SMS subscription.
integer
required
Existing MailUp recipient ID to subscribe to SMS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UNSUBSCRIBE_AUDIENCE_RECIPIENT_FROM_GROUPRemove one recipient from a MailUp group without unsubscribing that recipient from the parent list.

Input Parameters

integer
required
MailUp group ID.
integer
required
MailUp recipient ID to remove from the group.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UNSUBSCRIBE_AUDIENCE_RECIPIENT_FROM_LISTSUnsubscribe 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.

Input Parameters

array
required
Non-empty MailUp list IDs from which to unsubscribe the recipient.
integer
required
MailUp recipient ID to unsubscribe.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UNSUBSCRIBE_RECIPIENT_FROM_LISTUnsubscribe 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.

Input Parameters

integer
required
MailUp list ID to unsubscribe the recipient from.
integer
required
Existing MailUp recipient ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UNSUBSCRIBE_SMS_RECIPIENT_FROM_LISTRemove one recipient’s SMS subscription from one MailUp list without deleting the recipient. Requires SMS entitlement; observe the 5 calls per second limit.

Input Parameters

integer
required
MailUp list ID whose SMS subscription will be removed.
integer
required
Existing MailUp recipient ID to unsubscribe from SMS.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UNSUBSCRIBE_SMS_RECIPIENT_FROM_LISTSRemove 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.

Input Parameters

string
required
List IDs to unsubscribe from; null is accepted by the provider XSD.
integer
required
Existing MailUp recipient ID to unsubscribe from SMS lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_AUDIENCE_GROUPUpdate explicitly supplied fields of a MailUp group; omitted body fields are not sent.

Input Parameters

string
Replacement group name; omission leaves the key out of the request.
integer
Replacement count when explicitly supplied.
string
Replacement group notes; omission leaves the key out of the request.
integer
required
Owning MailUp list ID.
integer
required
MailUp group ID to update.
boolean
Replacement deletion flag when explicitly supplied.
integer
Optional list ID included in the body.
integer
Optional group ID included in the body.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_AUDIENCE_RECIPIENT_DETAILUpdate contact and dynamic-field details for a MailUp address-book recipient. The email field is required and is sent even when null; other omitted fields are not sent.

Input Parameters

string
Recipient name.
string
required
Recipient email address; required by MailUp but may be null.
integer
Existing MailUp recipient ID, when known.
string
Recipient mobile number.
string
Recipient international prefix.
array
Dynamic fields to write; omission preserves provider defaults.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_CONTENT_SOURCEUpdate supplied settings of one MailUp content-provider source.

Input Parameters

integer
required
Content source ID to update.
boolean
New enabled state; omit to leave this provider field unsupplied.
string
New source name; omit to leave it unsupplied or send null to clear it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Tag replacement sent as Tags. Omit to preserve existing tags. An empty list sends an empty Tags array, which MailUp also treats as preserving existing tags.
string
Replacement internal notes. Omit to preserve the current value.
string
required
Complete replacement email body content.
integer
required
MailUp list ID containing the message.
string
required
Complete replacement subject line.
object
Replacement tracking configuration. Omit to preserve it.
string
Provider-defined structured-editor metadata. Normally omit this to preserve the current value; only replace it with a value from MAIL_UP_GET_EMAIL_MESSAGE.
integer
required
MailUp email message ID to update.
string
Replacement preview text. Omit to preserve the current value.
boolean
Set true to send Notes as null; cannot be combined with notes.
boolean
Whether referenced images are embedded. Omit to preserve the current setting.
boolean
Set true to send TrackingInfo as null; cannot be combined with tracking.
array
Dynamic-field replacement sent as Fields. Omit to preserve the current value; an empty list sends Fields as an empty array.
boolean
Set true to send Structure as null; cannot be combined with structure.
boolean
Whether this is a confirmation message. Omit to preserve the current setting.
boolean
Set true to send PreHeader as null; cannot be combined with pre_header.
boolean
Whether dynamic recipient fields are enabled. Omit to preserve the current setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
Sender city; omission preserves the provider value.
string
List name; omission preserves the provider value.
string
Sender phone number; omission preserves the provider value.
string ("html" | "text")
Default email format: ‘html’ or ‘text’. Use multipart_text separately to enable multipart text.
integer
Maximum message size in kilobytes.
boolean
Whether the list is public.
string
Sender postal address; omission preserves the provider value.
string
Character set used by the list.
integer
required
MailUp list ID to update.
boolean
Business-account flag; omission preserves the provider value.
boolean
Customer-account flag; omission preserves the provider value.
string
Reply-to address; omission preserves the provider value.
string
List disclaimer text.
string
Display name; omission preserves the provider value.
integer
List-purpose code returned by the public MAIL_UP_LIST_LIST_SCOPES tool; use it to select a valid value.
string
List description.
integer
MailUp opt-out mode code configured for the account; preserve an existing value unless the intended account mode is known.
string
List owner email; omission preserves the provider value.
string
Sender postal code; omission preserves the provider value.
string
Sender company name; omission preserves the provider value.
string
Sender contact name; omission preserves the provider value.
string
Country code; use GET_COUNTRY_CODES for valid values.
string
Notification email address.
string
Sender website URL; omission preserves the provider value.
string
Address used for bounced email notifications.
boolean
Whether the front-end subscription form is enabled.
string
Default international mobile prefix.
string
X-Abuse header value.
boolean
Whether multipart text is enabled.
string
Newsletter sender name; omission preserves the provider value.
string
MailUp list time-zone code.
string
SMS sender name.
boolean
Whether opened-message tracking is enabled.
boolean
Whether subscription confirmation SMS is sent.
boolean
Whether subscription email notifications are enabled.
string
Comma-separated MailUp list IDs also affected by a multi-list opt-out.
boolean
Whether an email is sent on opt-out.
string
Sender state or province; omission preserves the provider value.
string
Permission reminder; omission preserves the provider value.
string
ConversionLab tracking code.
string
List-Unsubscribe header value.
Parameters appended for link tracking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_ONLINE_EMAIL_MESSAGE_VISIBILITYPublish or hide one MailUp email message on the list’s online archive; this does not send the message.

Input Parameters

integer
required
Positive MailUp list ID containing the email message.
boolean
required
True to publish the message online, or false to hide it.
integer
required
Positive MailUp email message ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

string
required
Endpoint URL; the MailUp contract permits null.
string
required
Endpoint label; the MailUp contract permits null.
array
Optional endpoint headers, or null.
object
Optional recipient mapping, or null.
array
Optional personalization parameters, or null.
object
Optional endpoint username and password, or null.
integer
required
Personalization endpoint ID to replace.
string
Provider-managed endpoint update timestamp; normally omit on create or update.
string
Provider-managed endpoint creation timestamp; normally omit on create or update.
integer
Existing numeric personalization endpoint ID repeated in the body; omit on create and normally omit on update because the route identifies it.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: 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

array
Optional replacement Tags array; null items are permitted.
string
Optional replacement Notes. Omit to preserve the current value.
string
Optional replacement draft Sender value; MailUp uses the list-level SMS sender for delivery regardless of this field.
string
required
Replacement Content; required but nullable by XSD.
integer
required
MailUp list ID containing the SMS message.
string
required
Replacement Subject; required but nullable by XSD.
string
Replacement MailUp editor structure metadata; only send a Structure value obtained from MailUp.
boolean
Optional non-null IsUnicode flag.
integer
required
MailUp SMS message ID to update.
string
Provider-managed SMS draft creation timestamp; normally preserve by omitting it.
array
Optional replacement Fields array; null items are permitted.
boolean
Optional non-null UseDynamicField flag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_SOURCE_CONTENTSAdd or update content items in one MailUp content-provider source and return the activity ID.

Input Parameters

array
Content items; omit, send null, or provide items according to the upload mode.
integer
required
Content source ID to add content to or update.
integer
MailUp upload-mode code; omit to use provider behavior.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: MAIL_UP_UPDATE_TAGReplace the name and optionally the enabled state of one tag in a MailUp list. If the enabled state is omitted, the tool looks it up; it uses true if the matching tag has no boolean state and false if the tag is absent from the returned list.

Input Parameters

string
required
Replacement tag name; MailUp permits null.
integer
required
Positive MailUp tag ID.
boolean
Replacement enabled state; omit to leave Enabled unchanged; cannot be null.
integer
required
Positive MailUp list ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not