--- canonical_url: "https://docs.composio.dev/toolkits/mail_up" markdown_url: "https://docs.composio.dev/toolkits/mail_up.md" product: "platform" version: null last_updated: null --- # MailUp MailUp is an email and SMS marketing platform for managing lists, recipients, campaigns, and engagement statistics. - **Category:** email - **Auth:** OAUTH2 - **Composio-managed OAuth available?** No - **Tools:** 151 - **Triggers:** 0 - **Slug:** `MAIL_UP` - **Version:** 00000000_00 ## Tools ### Add Image **Slug:** `MAIL_UP_ADD_IMAGE` Decode 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Required image filename; the provider XSD permits null, although MailUp may reject it. | | `scope` | string ("shared" | "list") | Yes | Use shared to add to the console library or list to add to one mailing list. | | `list_id` | integer | No | Required only when scope is list; omitted for shared images. | | `base64_data` | string | Yes | Required base64-encoded image bytes without a data-URL prefix; the provider XSD permits null, although MailUp may reject it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Add Message Attachment **Slug:** `MAIL_UP_ADD_MESSAGE_ATTACHMENTS` Upload base64-encoded bytes into a specific attachment slot on one MailUp email message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Attachment file name; MailUp's contract permits null. | | `slot` | integer | Yes | Zero-based MailUp attachment slot. | | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `message_id` | integer | Yes | Positive MailUp email message ID. | | `base64_data` | string | Yes | Base64-encoded attachment bytes; MailUp's contract permits null. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Associate Personalization Endpoint With List **Slug:** `MAIL_UP_ASSOCIATE_PERSONALIZATION_ENDPOINT_WITH_LIST` Associate an existing MailUp personalization endpoint with one list. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to associate with the endpoint. | | `endpoint_id` | integer | Yes | Personalization endpoint ID to associate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import SMS Recipients To Group **Slug:** `MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENTS_TO_GROUP` Asynchronously 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | MailUp group ID that will receive the SMS recipients. | | `recipients` | string | Yes | SMS recipient array; the provider XSD permits null and null items. | | `remove_from_prev_groups` | boolean | No | When true, remove recipients from previous groups before adding them to this group. | | `clear_missing_or_empty_fields` | boolean | No | When true, clear MailUp recipient fields omitted or empty in this import. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import SMS Recipients To List **Slug:** `MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENTS_TO_LIST` Asynchronously 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID that will receive the SMS recipients. | | `recipients` | string | Yes | SMS recipient array; the provider XSD permits null and null items. | | `clear_missing_or_empty_fields` | boolean | No | When true, clear MailUp recipient fields omitted or empty in this import. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import One SMS Recipient To Group **Slug:** `MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENT_TO_GROUP` Add 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Required recipient Name string; an empty string is allowed. | | `group_id` | integer | Yes | MailUp group ID that will receive the SMS recipient. | | `recipient_id` | integer | No | Optional existing idRecipient; omit rather than sending null. | | `mobile_number` | string | Yes | Required recipient MobileNumber without its prefix; cannot be null. | | `mobile_prefix` | string | Yes | Required recipient MobilePrefix string; an empty string is allowed. | | `dynamic_fields` | array | No | Optional Fields array; null entries are accepted by the XSD. | | `remove_from_prev_groups` | boolean | No | When true, remove the recipient from previous groups before adding it to this group. | | `clear_missing_or_empty_fields` | boolean | No | When true, clear MailUp recipient fields omitted or empty in this import. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import One SMS Recipient To List **Slug:** `MAIL_UP_ASYNC_IMPORT_SMS_RECIPIENT_TO_LIST` Add 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Required recipient Name string; an empty string is allowed. | | `list_id` | integer | Yes | MailUp list ID that will receive the SMS recipient. | | `recipient_id` | integer | No | Optional existing idRecipient; omit rather than sending null. | | `mobile_number` | string | Yes | Required recipient MobileNumber without its prefix; cannot be null. | | `mobile_prefix` | string | Yes | Required recipient MobilePrefix string; an empty string is allowed. | | `dynamic_fields` | array | No | Optional Fields array; null entries are accepted by the XSD. | | `clear_missing_or_empty_fields` | boolean | No | When true, clear MailUp recipient fields omitted or empty in this import. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Batch Unsubscribe Recipients From List **Slug:** `MAIL_UP_BATCH_UNSUBSCRIBE_RECIPIENTS_FROM_LIST` Remove 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID from which to remove every recipient membership. | | `recipient_ids` | array | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Confirm SMS Numeric Sender **Slug:** `MAIL_UP_CONFIRM_SMS_NUMERIC_SENDER` Confirm 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sender_number` | string | Yes | Numeric SMS sender that previously requested a confirmation code. | | `confirmation_code` | string | Yes | Confirmation code as a raw JSON string; required but nullable by the contract. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Copy Email Message **Slug:** `MAIL_UP_COPY_EMAIL_MESSAGE` Create a copy of one MailUp email message, optionally replacing its subject or internal notes; this does not send it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `notes` | string | No | Internal notes for the copy; omission leaves Notes out of the body. | | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `subject` | string | No | Subject for the copy; omission leaves Subject out of the body. | | `message_id` | integer | Yes | Positive MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Message Sending Recipients **Slug:** `MAIL_UP_COUNT_MESSAGE_SENDING_RECIPIENTS` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | integer | Yes | MailUp email message ID whose sending-recipient count to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Count Subscribers **Slug:** `MAIL_UP_COUNT_SUBSCRIBERS` Return the subscribed-recipient count for a MailUp list or, when group_id is supplied, for one group in that list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID whose subscribers to count. | | `group_id` | integer | No | Optional MailUp group ID; when supplied, count subscribers in this group instead of the whole list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Audience Group **Slug:** `MAIL_UP_CREATE_AUDIENCE_GROUP` Create a recipient group in one MailUp list and return the complete group record. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Group name; null is accepted by the provider contract. | | `count` | integer | No | Provider-maintained recipient count; normally omit when creating a group. | | `notes` | string | No | Group notes; null is accepted by the provider contract. | | `list_id` | integer | Yes | MailUp list ID in which to create the group. | | `group_id` | integer | No | Provider-assigned group ID; normally omit when creating a new group. | | `deletable` | boolean | No | Whether MailUp may delete the group; normally omit so MailUp chooses. | | `body_list_id` | integer | No | Owning list ID repeated in the body; normally omit because list_id selects it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Content Source **Slug:** `MAIL_UP_CREATE_CONTENT_SOURCE` Create a named content-provider source in MailUp. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `is_enabled` | boolean | Yes | Whether the new content source is enabled. | | `source_name` | string | Yes | Content source name; MailUp accepts an explicit null value. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Email Message **Slug:** `MAIL_UP_CREATE_EMAIL_MESSAGE` Create a draft email campaign message in one MailUp list without sending it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Optional message tags that already exist in the target MailUp list; explicit null is sent as null. | | `notes` | string | No | Optional internal notes for the message; explicit null is preserved. | | `content` | string | Yes | Email body content in the format expected by the list, commonly HTML. | | `list_id` | integer | Yes | MailUp list ID in which to create the draft message. | | `subject` | string | Yes | Email subject line. | | `tracking` | object | No | MailUp tracking configuration; omission sends tracking disabled. | | `structure` | string | No | Provider-defined structured-editor metadata. Normally omit this; only supply a Structure value copied from MAIL_UP_GET_EMAIL_MESSAGE. | | `pre_header` | string | No | Optional preview text; explicit null is preserved. | | `embed_images` | boolean | No | Whether MailUp should embed referenced images. | | `dynamic_fields` | array | No | 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. | | `is_confirmation` | boolean | No | Whether this draft is a confirmation message. | | `use_dynamic_fields` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Email Message from Template **Slug:** `MAIL_UP_CREATE_EMAIL_MESSAGE_FROM_TEMPLATE` Create a new draft email message in a MailUp list from an existing template without sending it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the template. | | `template_id` | integer | Yes | Positive MailUp email template ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create List **Slug:** `MAIL_UP_CREATE_LIST` Create a MailUp mailing list without adding recipients or sending messages. The request must supply at least one settings source: id_settings or use_default_settings. Availability and accepted settings depend on the connected user's console permissions; MailUp limits standard REST traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | Yes | Required sender city; MailUp accepts null. | | `name` | string | Yes | Required list name; MailUp accepts null. | | `phone` | string | No | Optional sender phone number. | | `format` | string ("html" | "text") | No | Default email format: 'html' or 'text'. Use multipart_text separately to enable multipart text. | | `kb_max` | integer | No | Maximum message size in kilobytes. | | `public` | boolean | No | Whether the list is public. | | `address` | string | Yes | Required sender postal address; MailUp accepts null. | | `charset` | string | No | Character set used by the list. | | `business` | string | Yes | Required business-account flag; MailUp accepts null. | | `customer` | string | Yes | Required customer-account flag; MailUp accepts null. | | `reply_to` | string | Yes | Required reply-to address; MailUp accepts null. | | `disclaimer` | string | No | List disclaimer text. | | `display_as` | string | No | Optional display name. | | `scope_code` | integer | No | List-purpose code returned by the public MAIL_UP_LIST_LIST_SCOPES tool; use it to select a valid value. | | `description` | string | No | List description. | | `id_settings` | integer | No | Source settings ID to copy. Supply this field or use_default_settings; at least one is required. | | `optout_type` | integer | No | MailUp opt-out mode code configured for the account; preserve an existing value unless the intended account mode is known. | | `owner_email` | string | Yes | Required list owner email; MailUp accepts null. | | `postal_code` | string | No | Optional sender postal code. | | `company_name` | string | Yes | Required sender company name; MailUp accepts null. | | `contact_name` | string | Yes | Required sender contact name; MailUp accepts null. | | `country_code` | string | Yes | Required country code; MailUp accepts null. Use GET_COUNTRY_CODES for valid values. | | `notify_email` | string | No | Notification email address. | | `web_site_url` | string | Yes | Required sender website URL; MailUp accepts null. | | `bounced_email` | string | No | Address used for bounced email notifications. | | `frontend_form` | boolean | No | Whether the front-end subscription form is enabled. | | `default_prefix` | string | No | Default international mobile prefix. | | `header_x_abuse` | string | No | X-Abuse header value. | | `multipart_text` | boolean | No | Whether multipart text is enabled. | | `nl_sender_name` | string | Yes | Required newsletter sender name; MailUp accepts null. | | `time_zone_code` | string | No | MailUp list time-zone code. | | `sms_sender_name` | string | No | SMS sender name. | | `track_on_opened` | boolean | No | Whether opened-message tracking is enabled. | | `send_confirm_sms` | boolean | No | Whether subscription confirmation SMS is sent. | | `subscribed_email` | boolean | No | Whether subscription email notifications are enabled. | | `multi_optout_list` | string | No | Comma-separated MailUp list IDs also affected by a multi-list opt-out. | | `send_email_optout` | boolean | No | Whether an email is sent on opt-out. | | `state_or_province` | string | No | Optional sender state or province. | | `copy_from_webhooks` | boolean | No | Copy webhook settings when MailUp supports the source settings. | | `permission_reminder` | string | Yes | Required permission reminder; MailUp accepts null. | | `use_default_settings` | boolean | No | Whether MailUp should apply default list settings. Supply this field or id_settings; at least one is required. | | `conversionlab_track_code` | string | No | ConversionLab tracking code. | | `header_list_unsubscriber` | string | No | List-Unsubscribe header value. | | `link_tracking_parameters` | string | No | Parameters appended for link tracking. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Personalization Endpoint **Slug:** `MAIL_UP_CREATE_PERSONALIZATION_ENDPOINT` Create 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Endpoint URL; the MailUp contract permits null. | | `label` | string | Yes | Endpoint label; the MailUp contract permits null. | | `headers` | array | No | Optional endpoint headers, or null. | | `recipient` | object | No | Optional recipient mapping, or null. | | `parameters` | array | No | Optional personalization parameters, or null. | | `credentials` | object | No | Optional endpoint username and password, or null. | | `update_date` | string | No | Provider-managed endpoint update timestamp; normally omit on create or update. | | `creation_date` | string | No | Provider-managed endpoint creation timestamp; normally omit on create or update. | | `endpoint_body_id` | integer | No | Existing numeric personalization endpoint ID repeated in the body; omit on create and normally omit on update because the route identifies it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create SMS Message **Slug:** `MAIL_UP_CREATE_SMS_MESSAGE` Create a MailUp SMS draft without sending or consuming delivery credits. The account needs SMS entitlement; observe MailUp's limit of 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Optional Tags array; null entries are accepted by XSD. | | `notes` | string | No | Optional internal Notes. | | `sender` | string | No | Optional draft Sender value; MailUp uses the list-level SMS sender for delivery regardless of this field. | | `content` | string | Yes | SMS Content; required but nullable by XSD. | | `list_id` | integer | Yes | MailUp list ID in which to create the SMS draft. | | `subject` | string | Yes | SMS Subject; required but nullable by XSD. | | `structure` | string | No | MailUp editor structure metadata; omit unless preserving a Structure value obtained from MailUp. | | `is_unicode` | boolean | No | Optional non-null IsUnicode flag. | | `message_id` | integer | No | Provider-assigned numeric SMS message ID; normally omit when creating a draft. | | `creation_date` | string | No | Provider-managed SMS draft creation timestamp; normally omit when creating. | | `dynamic_fields` | array | No | Optional Fields array; null entries are accepted by XSD. | | `use_dynamic_fields` | boolean | No | Optional non-null UseDynamicField flag. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create SMTP+ Account **Slug:** `MAIL_UP_CREATE_SMTP_PLUS_ACCOUNT` Create an SMTP+ user account for a MailUp list and return its generated credentials. Supply at least one non-empty trusted domain or confirmed trusted sender, and choose priority_code from GET_SMTP_PLUS_PRIORITY_CODES. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `note` | string | Yes | Account note; MailUp accepts null. | | `list_id` | integer | Yes | MailUp list ID. | | `is_enabled` | boolean | Yes | Whether the new SMTP+ account is enabled. | | `priority_code` | integer | Yes | SMTP+ priority code returned by GET_SMTP_PLUS_PRIORITY_CODES. | | `trusted_domains` | string | Yes | Trusted domains. At least one non-empty domain or trusted sender is required. | | `trusted_senders` | string | Yes | Confirmed trusted sender addresses. At least one non-empty sender or trusted domain is required. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Create Tag **Slug:** `MAIL_UP_CREATE_TAG` Create a named tag in one MailUp list for organizing email messages. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Name of the new MailUp tag. | | `list_id` | integer | Yes | Positive MailUp list ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Audience Group **Slug:** `MAIL_UP_DELETE_AUDIENCE_GROUP` Permanently delete one MailUp group. This does not delete its recipients from the parent list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Owning MailUp list ID. | | `group_id` | integer | Yes | MailUp group ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Audience Recipient From List **Slug:** `MAIL_UP_DELETE_AUDIENCE_RECIPIENT_FROM_LIST` Delete one recipient record from one MailUp list only; other list memberships are unaffected. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID from which to delete the recipient. | | `recipient_id` | integer | Yes | MailUp recipient ID to delete from this list only. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Audience Recipient Globally **Slug:** `MAIL_UP_DELETE_AUDIENCE_RECIPIENT_GLOBALLY` Permanently delete one MailUp recipient from every list in the account. This high-impact operation can remove all list memberships and returns a result for each affected list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `recipient_id` | integer | Yes | MailUp recipient ID to delete from every list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Content Source **Slug:** `MAIL_UP_DELETE_CONTENT_SOURCE` Permanently delete one MailUp content-provider source. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | integer | Yes | Content source ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Email Message **Slug:** `MAIL_UP_DELETE_EMAIL_MESSAGE` Permanently delete one MailUp email message from a list. This does not cancel an already queued sending. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID containing the message. | | `message_id` | integer | Yes | MailUp email message ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Image **Slug:** `MAIL_UP_DELETE_IMAGE` Permanently delete the image at an exact full MailUp path from provider storage. This destructive operation has no list-specific route, requires image access, and counts toward the 5-calls-per-second standard REST limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `image_path` | string | Yes | Exact full image path returned by LIST_IMAGES. MailUp receives this as a raw JSON string body. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete List **Slug:** `MAIL_UP_DELETE_LIST` Permanently delete one MailUp list and its list-scoped configuration. This destructive operation requires console permission, cannot be undone, and is subject to MailUp's 5-calls-per-second standard REST limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Message Attachment **Slug:** `MAIL_UP_DELETE_MESSAGE_ATTACHMENTS` Permanently remove the attachment in one slot from a MailUp email message and return the remaining attachments. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `slot` | integer | Yes | Zero-based MailUp attachment slot. | | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `message_id` | integer | Yes | Positive MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Personalization Endpoint **Slug:** `MAIL_UP_DELETE_PERSONALIZATION_ENDPOINT` Permanently delete one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `endpoint_id` | integer | Yes | Personalization endpoint ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Email Sending Task **Slug:** `MAIL_UP_DELETE_SENDING` Delete an existing MailUp email sending task record; this does not recall email already delivered. MailUp permits at most 1 combined stop or delete call per 30 seconds. A process-local guard coordinates both actions in this worker only; MailUp remains authoritative across workers and other clients. Never retry automatically after a rejection or ambiguous result. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | MailUp sending task ID to delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete SMS Message **Slug:** `MAIL_UP_DELETE_SMS_MESSAGE` Permanently delete one MailUp SMS draft without sending it. Requires SMS service entitlement; observe MailUp's limit of 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID containing the SMS message. | | `message_id` | integer | Yes | MailUp SMS message ID to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Source Content **Slug:** `MAIL_UP_DELETE_SOURCE_CONTENT` Permanently delete one keyed content item from a MailUp content-provider source. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | integer | Yes | Content source ID containing the item. | | `content_key` | string | Yes | Source-specific content key to permanently delete. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Delete Tag **Slug:** `MAIL_UP_DELETE_TAG` Permanently delete one tag from a MailUp list; messages using it may lose that classification. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tag_id` | integer | Yes | Positive MailUp tag ID. | | `list_id` | integer | Yes | Positive MailUp list ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disable Trusted Sender **Slug:** `MAIL_UP_DISABLE_TRUSTED_SENDER_BY_ID` Disable a trusted sender registration by ID so it is no longer active for sending. The action verifies the sender address because MailUp may return one ID for multiple registrations, then supplies MailUp's required request GUID internally. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trusted_sender_id` | string | Yes | MailUp trusted sender ID to disable. | | `expected_email_address` | string | Yes | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Disassociate Personalization Endpoint From List **Slug:** `MAIL_UP_DISASSOCIATE_PERSONALIZATION_ENDPOINT_FROM_LIST` Remove one MailUp personalization endpoint association from a list. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to disassociate from the endpoint. | | `endpoint_id` | integer | Yes | Personalization endpoint ID to disassociate. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Empty Audience Group **Slug:** `MAIL_UP_EMPTY_AUDIENCE_GROUP` Remove every recipient membership from one MailUp group. This high-impact operation leaves the group and parent-list recipients intact. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Owning MailUp list ID. | | `group_id` | integer | Yes | MailUp group ID to empty. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Email Message Dynamic Fields **Slug:** `MAIL_UP_ENABLE_DYN_FIELDS_ON_EMAIL_MESSAGE` Enable or disable dynamic recipient-field substitution on one MailUp email message and return its complete current details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `enable` | string ("true" | "false") | Yes | Use 'true' to enable dynamic fields or 'false' to disable them. | | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `message_id` | integer | Yes | Positive MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set SMS Message Dynamic Fields **Slug:** `MAIL_UP_ENABLE_DYN_FIELDS_ON_SMS_MESSAGE` Explicitly enable or disable dynamic recipient-field substitution for one MailUp SMS draft. Requires SMS entitlement; limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `enable` | string ("true" | "false") | Yes | Use 'true' to enable or 'false' to disable dynamic-field substitution. | | `list_id` | integer | Yes | MailUp list ID containing the SMS message. | | `message_id` | integer | Yes | MailUp SMS message ID whose setting will change. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Tracking for Every List **Slug:** `MAIL_UP_ENABLE_TRACKING_FOR_EVERY_LIST` Explicitly enable or disable email tracking for one recipient across every MailUp list. The enable boolean is the desired final state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `enable` | boolean | Yes | Set true to enable tracking or false to disable it across every list. | | `recipient_id` | integer | Yes | MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Set Tracking for List **Slug:** `MAIL_UP_ENABLE_TRACKING_FOR_SINGLE_LIST` Explicitly enable or disable email tracking for one recipient on one MailUp list. The enable boolean is the desired final state. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `enable` | boolean | Yes | Set true to enable tracking or false to disable it for this list. | | `list_id` | integer | Yes | MailUp list ID. | | `recipient_id` | integer | Yes | MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Find Recipients **Slug:** `MAIL_UP_FIND_RECIPIENTS` Find MailUp recipients by email address, mobile number, or both; this endpoint cannot list recipients without a lookup value. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | No | Email address to find; email or mobile_number must be supplied. | | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `page_size` | integer | No | Maximum matching recipients to return in this page. | | `mobile_number` | string | No | Mobile number to find; email or mobile_number must be supplied. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account Details **Slug:** `MAIL_UP_GET_ACCOUNT_DETAILS` Return the connected MailUp account identity, plan, trial status, expiry, and available credits; use this before credit-dependent sending. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Account Info **Slug:** `MAIL_UP_GET_ACCOUNT_INFO` Return the authenticated MailUp account identity, console version, trial flag, and optional expiry/URL. This is account metadata, not credits or plan details, and is subject to the 5-calls-per-second standard REST limit. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Archived Email Messages **Slug:** `MAIL_UP_GET_ARCHIVED_MAIL_MESSAGES_BY_LIST` Return one page of archived email messages from a specific MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | Positive MailUp list ID. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Deferred Dispatch Date **Slug:** `MAIL_UP_GET_DATE_FOR_DEFERRED_DISPATCH` Get the first useful MailUp date for scheduling a sending task. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | MailUp sending task ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Earliest Deferred SMS Dispatch Date **Slug:** `MAIL_UP_GET_DATE_FOR_DEFERRED_SMS_DISPATCH` Return MailUp's earliest useful scheduling date for one SMS sending task. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | Positive MailUp SMS sending-task ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Deferred SMS Sendings **Slug:** `MAIL_UP_GET_DEFERRED_SMS_SENDING_STATUS` Return SMS sending tasks scheduled for deferred dispatch. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Email Message **Slug:** `MAIL_UP_GET_EMAIL_MESSAGE` Return the content, subject, tracking settings, tags, dynamic fields, and attachments for one MailUp email message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID containing the message. | | `message_id` | integer | Yes | MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Send History for List **Slug:** `MAIL_UP_GET_EMAIL_SEND_HISTORY` Return one page of send-history records across all email messages in one MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | Positive MailUp list ID. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Email Template Details **Slug:** `MAIL_UP_GET_EMAIL_TEMPLATE_DETAILS` Return metadata and content for one email template in a MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the template. | | `template_id` | integer | Yes | Positive MailUp email template ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Templates **Slug:** `MAIL_UP_GET_EMAIL_TEMPLATES` Return one page of email templates defined in a specific MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | Positive MailUp list ID. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Immediate SMS Sendings **Slug:** `MAIL_UP_GET_IMMEDIATE_SMS_SENDING_STATUS` Return SMS sending tasks scheduled for immediate dispatch. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Import Details **Slug:** `MAIL_UP_GET_IMPORT_DETAILS` Return the complete MailUp import configuration and nested valid/invalid row totals for one import ID. Access follows the connected user's list permissions and standard REST traffic is limited to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `import_id` | integer | Yes | MailUp import ID to inspect. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Import Sending **Slug:** `MAIL_UP_GET_IMPORT_SENDING` Return the sending and message IDs for confirmation requests generated by one MailUp import. Data exists only when that import generated confirmation messages; standard REST traffic is limited to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `import_id` | integer | Yes | Import ID whose confirmation-message sending linkage to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Import Status **Slug:** `MAIL_UP_GET_IMPORT_STATUS` Return completion and recipient outcome counts for an asynchronous MailUp import ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `import_id` | integer | Yes | Import ID returned by a MailUp recipient import tool. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Last Sent SMS Messages **Slug:** `MAIL_UP_GET_LAST_SENT_SMS` Return the most recently sent SMS messages and their account-billing costs for one list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get List **Slug:** `MAIL_UP_GET_LIST` Return configuration and sender details for one MailUp mailing list by ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID, available from MAIL_UP_LIST_LISTS. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get MailUp Login URL **Slug:** `MAIL_UP_GET_LOGIN_URL` Create an ephemeral URL that logs a user into the MailUp platform. This is a feature-gated SSO operation: MailUp must enable SSO for the connected platform account before this action can succeed. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Current User Email Messages **Slug:** `MAIL_UP_GET_MAIL_MESSAGES_BY_USER` Return one page of cloned and original email messages across lists for the current MailUp user. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Message Attachments **Slug:** `MAIL_UP_GET_MESSAGE_ATTACHMENTS` Return all attachment slots currently configured on one MailUp email message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `message_id` | integer | Yes | Positive MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Message Statistics **Slug:** `MAIL_UP_GET_MESSAGE_STATISTICS` Return aggregate recipient, view, click, bounce, and unsubscription counts for one MailUp email message using five read-only statistics calls. Counts can be zero after MailUp's message-recipient retention period expires. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | integer | Yes | MailUp email message ID whose aggregate statistics to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Message Statistics Pages **Slug:** `MAIL_UP_GET_MESSAGE_STATISTICS_PAGES` Return MailUp's precompiled public statistics-page URLs for one message: overall, click trend, opens, link tracking, readers, and sent reports, plus the console login URL. These human-facing pages expose less detail than the statistics API; the console URL can also reveal the account host. Legacy click/open filter pages are no longer available and are not returned by the current XSD. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | integer | Yes | MailUp email message ID whose precompiled statistics-page URLs to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Non-Temporary SMS Errors **Slug:** `MAIL_UP_GET_NOT_TEMPORARY_SMS_ERRORS` Return undelivered SMS error totals grouped by originator address. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | | `start_date` | string | Yes | Required inclusive history start date in exactly yyyyMMdd format. MailUp rejects the locale-formatted default it generates when this value is omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Pending SMS Recipients By List **Slug:** `MAIL_UP_GET_PENDING_SMS_RECIPIENTS_BY_LIST` Return recipients whose SMS subscription is pending in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Personalization Endpoint **Slug:** `MAIL_UP_GET_PERSONALIZATION_ENDPOINT` Retrieve one MailUp personalization endpoint including its configured details. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `endpoint_id` | integer | Yes | Personalization endpoint ID to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Published Email Messages **Slug:** `MAIL_UP_GET_PUBLISHED_MAIL_MESSAGES_BY_LIST` Return one page of email messages currently visible online for a specific MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | Positive MailUp list ID. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Recipient **Slug:** `MAIL_UP_GET_RECIPIENT` Return contact details, dynamic fields, and list membership states for one MailUp recipient ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `recipient_id` | integer | Yes | MailUp recipient ID returned by a recipient list, group, import, or lookup tool. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Recipient Statistics **Slug:** `MAIL_UP_GET_RECIPIENT_STATISTICS` Return aggregate delivery, view, click, bounce, and unsubscription counts for one MailUp recipient using five rate-limited, read-only statistics calls. Counts can be zero after MailUp's message-recipient retention period expires. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `recipient_id` | integer | Yes | MailUp recipient ID whose aggregate engagement statistics to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Request SMS Numeric Sender Confirmation Code **Slug:** `MAIL_UP_GET_SMS_CONFIRMATION_CODE` Request the authentication code for a MailUp numeric SMS sender and return whether MailUp accepted the request. This mutates sender-verification state and may cause MailUp to issue a code; never retry automatically after any status or transport failure because the first request may have succeeded. The SMS channel and sender verification must be enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sender_number` | string | Yes | Numeric SMS sender registered with MailUp. A leading E.164 plus is accepted and normalized to digits for MailUp's IIS path. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SMS Message Details **Slug:** `MAIL_UP_GET_SMS_MESSAGE_DETAILS` Return the complete XSD-defined content and settings for one MailUp SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the SMS message. | | `message_id` | integer | Yes | Positive MailUp SMS message ID within the specified list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SMS Messages By List **Slug:** `MAIL_UP_GET_SMS_MESSAGES_BY_LIST` Return SMS campaign message summaries from one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SMS Message Send History **Slug:** `MAIL_UP_GET_SMS_MESSAGE_SEND_HISTORY` Return sending attempts and recipient counts for one SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | | `message_id` | integer | Yes | Positive MailUp SMS message ID within the specified list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SMS Message Sending Report **Slug:** `MAIL_UP_GET_SMS_MESSAGE_SENDING_REPORT_BY_SMS_ID` Return aggregate duration, cost, recipient-message, and billable SMS-part totals for one SMS message. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `message_id` | integer | Yes | Positive MailUp SMS message ID whose aggregate report is requested. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SMS Message Sending Report Details **Slug:** `MAIL_UP_GET_SMS_MESSAGE_SENDING_REPORT_DETAILS_BY_SMS_ID` Return per-recipient delivery statuses and errors for one SMS message. A DeliveryId filter returns at most one detail. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | | `message_id` | integer | Yes | Positive MailUp SMS message ID whose sending report is requested. | | `delivery_id` | integer | No | Optional Transactional SMS DeliveryId. When supplied, MailUp returns at most one detail, so further filtering and paging are unnecessary. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SMS Numeric Sender Status **Slug:** `MAIL_UP_GET_SMS_NUMERIC_SENDER_STATUS` Return the verification status code and description for one numeric MailUp SMS sender. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sender_number` | string | Yes | Numeric SMS sender registered with MailUp. A leading E.164 plus is accepted and normalized to digits for MailUp's IIS path. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List SMS Recipients By Group **Slug:** `MAIL_UP_GET_SMS_RECIPIENTS_BY_GROUP` Return recipients in one MailUp group using the SMS channel projection. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `group_id` | integer | Yes | Positive MailUp group ID whose SMS-channel recipients are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get SMTP+ Priority Codes **Slug:** `MAIL_UP_GET_SMTP_PLUS_PRIORITY_CODES` List the SMTP+ priority codes available in MailUp. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Subscribed SMS Recipients By List **Slug:** `MAIL_UP_GET_SUBSCRIBED_SMS_RECIPIENTS_BY_LIST` Return recipients subscribed to the SMS channel in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Enabled Tags **Slug:** `MAIL_UP_GET_TAGS` Return one page of enabled tags configured for a specific MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | Positive MailUp list ID. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Temporary SMS Errors **Slug:** `MAIL_UP_GET_TEMPORARY_SMS_ERRORS` Return temporary undelivered SMS error totals grouped by originator address. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | | `start_date` | string | Yes | Required inclusive history start date in exactly yyyyMMdd format. MailUp rejects the locale-formatted default it generates when this value is omitted. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tracking Status for Every List **Slug:** `MAIL_UP_GET_TRACKING_STATUS_FOR_EVERY_LIST` Get one recipient's email tracking status across every MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `recipient_id` | integer | Yes | MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Tracking Status for List **Slug:** `MAIL_UP_GET_TRACKING_STATUS_FOR_SINGLE_LIST` Get one recipient's email tracking status for a specific MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID. | | `recipient_id` | integer | Yes | MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Get Trusted Sender **Slug:** `MAIL_UP_GET_TRUSTED_SENDER` Get 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `trusted_sender_id` | string | Yes | MailUp trusted sender ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Trusted Senders **Slug:** `MAIL_UP_GET_TRUSTED_SENDERS` Return 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum trusted senders to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Unscheduled SMS Sendings **Slug:** `MAIL_UP_GET_UNDEFINED_SMS_SENDING_STATUS` Return SMS sending tasks that still need a dispatch schedule. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Unsubscribed SMS Recipients By List **Slug:** `MAIL_UP_GET_UNSUBSCRIBED_SMS_RECIPIENTS_BY_LIST` Return recipients unsubscribed from the SMS channel in one MailUp list. This is a read-only Console API operation: it does not send SMS or consume SMS credits. The connected MailUp account and relevant list must have the SMS channel enabled. MailUp limits Console API traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from this action's previous page; omit for page zero. | | `list_id` | integer | Yes | Positive MailUp list ID whose SMS-channel records are requested. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records in this page; defaults to 10. MailUp supports larger requested pages. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Audience Recipient To Group **Slug:** `MAIL_UP_IMPORT_AUDIENCE_RECIPIENT_TO_GROUP` Synchronously create or update one email recipient and add them to a MailUp group, returning the recipient ID. For a new recipient, the group's owning list becomes the owning list and they receive a Subscribed subscription status by default. confirm_email=true sends a confirmation email automatically and leaves a new recipient Pending; a Pending recipient receives another confirmation email and an Unsubscribed recipient moves to Pending. Never retry an ambiguous result because doing so can send duplicate confirmation email. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Recipient name. | | `email` | string | Yes | Recipient email address; required by MailUp but may be null. | | `group_id` | integer | Yes | MailUp group ID that will receive the recipient. | | `recipient_id` | integer | No | Existing MailUp recipient ID, when known. | | `confirm_email` | boolean | No | 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. | | `mobile_number` | string | No | Recipient mobile number. | | `mobile_prefix` | string | No | Recipient international prefix. | | `dynamic_fields` | array | No | Dynamic fields to write; omission preserves provider defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Audience Recipient To List **Slug:** `MAIL_UP_IMPORT_AUDIENCE_RECIPIENT_TO_LIST` Synchronously create or update one email recipient in a MailUp list and return the recipient ID. The target list becomes the recipient's owning list; a new recipient receives a Subscribed subscription status by default. confirm_email=true sends a confirmation email automatically and leaves a new recipient Pending; a Pending recipient receives another confirmation email and an Unsubscribed recipient moves to Pending. Never retry an ambiguous result because doing so can send duplicate confirmation email. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Recipient name. | | `email` | string | Yes | Recipient email address; required by MailUp but may be null. | | `list_id` | integer | Yes | MailUp list ID that will receive the recipient. | | `recipient_id` | integer | No | Existing MailUp recipient ID, when known. | | `confirm_email` | boolean | No | 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. | | `mobile_number` | string | No | Recipient mobile number. | | `mobile_prefix` | string | No | Recipient international prefix. | | `dynamic_fields` | array | No | Dynamic fields to write; omission preserves provider defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Import Recipients **Slug:** `MAIL_UP_IMPORT_RECIPIENTS` Queue an asynchronous import that adds or updates a non-empty recipient batch in one MailUp list or group. MailUp permits only one account import at a time; use the returned import ID with MAIL_UP_GET_IMPORT_STATUS until it completes. New recipients receive a Subscribed subscription status in the destination list or the group's owning list by default; confirm_email=true instead leaves them Pending and generates confirmation emails for the confirmation-request queue. import_type='asOptout' makes every supplied recipient Optout except recipients already Pending, so it can unsubscribe existing recipients. clear_missing_or_empty_fields can erase stored data and group remove_from_prev_groups can remove memberships. Never retry an ambiguous result because these effects may already have occurred. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `recipients` | array | Yes | Non-empty recipient batch. Every recipient requires recipient_id, email, or mobile_number; supplying more than one identifier is allowed. | | `import_type` | string | No | 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. | | `confirm_email` | boolean | No | False immediately subscribes new recipients, matching MailUp's default. True leaves new recipients Pending and generates confirmation emails, but does not send them. | | `ignore_mobile` | boolean | No | When true, ignore mobile-number data in the imported recipient rows. | | `destination_id` | integer | Yes | Positive MailUp list or group ID selected by destination_type. | | `destination_type` | string ("list" | "group") | Yes | Whether destination_id identifies a MailUp list or group. | | `remove_from_prev_groups` | boolean | No | Group imports only. When true, remove recipients from their previous groups before adding them to the destination group. | | `clear_missing_or_empty_fields` | boolean | No | When true, permanently clear stored recipient fields that are missing or empty in the imported rows. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audience Email Opt-Ins By List **Slug:** `MAIL_UP_LIST_AUDIENCE_EMAIL_OPTINS_BY_LIST` Return one page of subscribed and unsubscribed email recipients for a MailUp list with complete opt-in and opt-out details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID whose email opt-ins to list. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum opt-in records to return, from 1 through 10. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audience Email Opt-Ins By Recipient **Slug:** `MAIL_UP_LIST_AUDIENCE_EMAIL_OPTINS_BY_RECIPIENT` Return one page of a MailUp recipient's email subscription status and opt-in/opt-out history across lists. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum opt-in records to return, from 1 through 10. | | `recipient_id` | integer | Yes | MailUp recipient ID whose email list opt-ins to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audience SMS Opt-Ins By List **Slug:** `MAIL_UP_LIST_AUDIENCE_SMS_OPTINS_BY_LIST` Return one page of subscribed and unsubscribed SMS recipients for a MailUp list with complete opt-in and opt-out details. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID whose SMS opt-ins to list. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum opt-in records to return, from 1 through 10. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Audience SMS Opt-Ins By Recipient **Slug:** `MAIL_UP_LIST_AUDIENCE_SMS_OPTINS_BY_RECIPIENT` Return one page of a MailUp recipient's SMS subscription status and opt-in/opt-out history across lists. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum opt-in records to return, from 1 through 10. | | `recipient_id` | integer | Yes | MailUp recipient ID whose SMS list opt-ins to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Content Sources **Slug:** `MAIL_UP_LIST_CONTENT_SOURCES` Return one page of MailUp content-provider sources. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Country Codes **Slug:** `MAIL_UP_LIST_COUNTRY_CODES` Return MailUp's complete unpaged country-code reference for list sender settings. Availability follows console access and the call is subject to the 5-calls-per-second standard REST limit. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Dynamic Fields **Slug:** `MAIL_UP_LIST_DYNAMIC_FIELDS` Return one page of recipient dynamic-field definitions and IDs. Supports provider filter/order expressions and an opaque cursor; access follows console permissions and standard REST traffic is limited to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum dynamic fields to return in this page; MailUp collection calls are capped here at 10. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Messages **Slug:** `MAIL_UP_LIST_EMAIL_MESSAGES` Return one page of email campaign messages in a MailUp list, including message IDs used by message editing, sending, and statistics tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | string | No | 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'`. | | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID containing the email messages. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum messages to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Send History **Slug:** `MAIL_UP_LIST_EMAIL_SEND_HISTORY` Return one page of completed send-history records for a specific MailUp email message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID containing the message. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum history records to return in this page. | | `message_id` | integer | Yes | MailUp email message ID whose history to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Email Sendings **Slug:** `MAIL_UP_LIST_EMAIL_SENDINGS` Return one page of MailUp email sending tasks for one queue state: pending scheduling, immediate, or deferred. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum sending tasks to return in this page. | | `queue_state` | string ("pending_scheduling" | "immediate" | "deferred") | Yes | Sending queue state to inspect. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Group Recipients **Slug:** `MAIL_UP_LIST_GROUP_RECIPIENTS` Return one page of recipients currently associated with a MailUp group. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `group_id` | integer | Yes | MailUp group ID, available from MAIL_UP_LIST_GROUPS. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum recipients to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Groups **Slug:** `MAIL_UP_LIST_GROUPS` Return one page of recipient groups in a MailUp list, including group IDs used by group-scoped tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID containing the groups. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum groups to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Images **Slug:** `MAIL_UP_LIST_IMAGES` Return all full image paths from either the console-wide shared library or one MailUp list. The provider does not paginate these arrays; list access follows console permissions and calls count toward the 5-calls-per-second standard REST limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `scope` | string ("shared" | "list") | Yes | Use shared for console-wide images or list for images belonging to one mailing list. | | `list_id` | integer | No | Required only when scope is list; omitted for shared images. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Imports **Slug:** `MAIL_UP_LIST_IMPORTS` Return one page of MailUp recipient imports with status codes and row counts. Supports provider filter/order expressions and an opaque cursor; standard REST traffic is limited to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum imports to return in this page; MailUp collection calls are capped here at 10. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Import Status Codes **Slug:** `MAIL_UP_LIST_IMPORT_STATUS_CODES` Return MailUp's complete reference table for interpreting import status_code values. This unpaged metadata call is subject to the 5-calls-per-second standard REST limit. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List List Recipients **Slug:** `MAIL_UP_LIST_LIST_RECIPIENTS` Return one page of recipients in a MailUp list for one subscription state: subscribed, pending, or unsubscribed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID whose recipients to return. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum recipients to return in this page. | | `subscription_status` | string ("subscribed" | "pending" | "unsubscribed") | No | Subscription state to return: subscribed, pending, or unsubscribed. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Lists **Slug:** `MAIL_UP_LIST_LISTS` Return one page of mailing lists available to the connected MailUp user, including the list IDs required by list-scoped tools. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum lists to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List List Scopes **Slug:** `MAIL_UP_LIST_LIST_SCOPES` Return MailUp's complete unpaged list-purpose reference table for scope_code settings. These are provider list-purpose codes, not OAuth scopes; the call is subject to the 5-calls-per-second standard REST limit. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Message Events **Slug:** `MAIL_UP_LIST_MESSAGE_EVENTS` Return one page of recipient-level delivery, view, click, bounce, or unsubscription statistics for a sent MailUp email message. View and click rows are recipient rollups with Count, not individual event timestamps. Delivery details are retained for at most 12 months. If a message ID was reused, results aggregate every campaign sent with that ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum events to return in this page. | | `event_type` | string ("delivery" | "view" | "click" | "bounce" | "unsubscription") | Yes | Recipient-level event type to return. | | `message_id` | integer | Yes | MailUp email message ID whose events to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Message URL Click Details **Slug:** `MAIL_UP_LIST_MESSAGE_URL_CLICK_DETAILS` Return one page of clicked links for a MailUp message with each link's total and per-recipient click counts. Full click details are retained for the console data-retention period. Reusing one message across campaigns merges its statistics; clone messages when campaign statistics must stay separate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; it preserves message, page size, filter, and order. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum clicked-link details in this page, capped at 10. | | `message_id` | integer | Yes | MailUp email message ID whose per-link recipient details to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Message URL Clicks **Slug:** `MAIL_UP_LIST_MESSAGE_URL_CLICKS` Return one page of links with at least one click for a MailUp message, with the click total for each URL or MailUp special-link label. Full click details are retained for the console data-retention period. Reusing one message across campaigns merges its statistics; clone messages when campaign statistics must stay separate. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; it preserves message, page size, filter, and order. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum clicked-link rollups to return in this page, capped at 10. | | `message_id` | integer | Yes | MailUp email message ID whose clicked-link rollups to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Personalization Endpoints **Slug:** `MAIL_UP_LIST_PERSONALIZATION_ENDPOINTS` Return one page of MailUp personalization endpoints. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Personalization Endpoints By List **Slug:** `MAIL_UP_LIST_PERSONALIZATION_ENDPOINTS_BY_LIST` Retrieve all personalization endpoints associated with one MailUp list. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID whose associated endpoints to retrieve. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recipient Activity **Slug:** `MAIL_UP_LIST_RECIPIENT_ACTIVITY` Return one page of sent-email delivery, view, click, bounce, or unsubscription statistics for one MailUp recipient. View and click rows are message-level rollups with Count, not individual event timestamps. Delivery details are retained for at most 12 months; reused message IDs aggregate campaigns. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum activity records to return in this page. | | `recipient_id` | integer | Yes | MailUp recipient ID whose activity to return. | | `activity_type` | string ("delivery" | "view" | "click" | "bounce" | "unsubscription") | Yes | Recipient activity type to return: delivery, view, click, bounce, or unsubscription. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recipient Bounce Details **Slug:** `MAIL_UP_LIST_RECIPIENT_BOUNCE_DETAILS` Return one page of messages that bounced for a MailUp recipient, including message subject, notes, and bounce classification when available. Statistics are limited by the account's configured data-retention period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; it preserves recipient, page size, filter, and order. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum bounce details in this page, capped at 10. | | `recipient_id` | integer | Yes | MailUp recipient ID whose detailed message bounces to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recipient Click Details **Slug:** `MAIL_UP_LIST_RECIPIENT_CLICK_DETAILS` Return one page of messages in which a MailUp recipient clicked, including each message's total and per-URL click counts. URL values can be normal URLs or MailUp special-link labels. Full click details are retained for the console data-retention period. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; it preserves recipient, page size, filter, and order. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum message click details in this page, capped at 10. | | `recipient_id` | integer | Yes | MailUp recipient ID whose per-message clicked-link details to return. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Recipient Groups **Slug:** `MAIL_UP_LIST_RECIPIENT_GROUPS` Return one page of groups to which a recipient belongs within one MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque continuation cursor; omit for the first page. | | `list_id` | integer | Yes | MailUp list ID containing the recipient. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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`. | | `page_size` | integer | No | Maximum groups to return, from 1 through 10. | | `recipient_id` | integer | Yes | MailUp recipient ID whose group memberships to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Source Contents **Slug:** `MAIL_UP_LIST_SOURCE_CONTENTS` Return one page of content items from one MailUp content-provider source. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `cursor` | string | No | Opaque next_cursor from a previous call; omit for the first page. | | `order_by` | string | No | 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`. | | `filter_by` | string | No | 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'`. | | `page_size` | integer | No | Maximum records to return in this page. | | `source_id` | integer | Yes | Content source ID whose items to list. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### List Time Zones **Slug:** `MAIL_UP_LIST_TIME_ZONES` Return MailUp's complete unpaged time-zone reference for list settings. Availability follows Console access and the call is subject to MailUp's 5-calls-per-second standard REST limit. #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Register Trusted Sender **Slug:** `MAIL_UP_REGISTER_TRUSTED_SENDER` Register an email address as a trusted sender and begin MailUp's authorization process; registration does not itself guarantee authorization. This feature-gated operation requires Trusted Senders to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Sender email address to register; MailUp accepts null. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Reset SMTP+ Account **Slug:** `MAIL_UP_RESET_SMTP_PLUS_ACCOUNT` Reset an existing SMTP+ user account and return a replacement password. The old password stops working; treat the returned password as a secret and store it securely without logging or exposing it. Never retry automatically after an ambiguous result. This feature-gated operation requires SMTP+ to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID. | | `username` | string | Yes | SMTP+ username to reset; MailUp accepts null. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Schedule Deferred Email Dispatch **Slug:** `MAIL_UP_SCHEDULE_DEFERRED_DISPATCH` Queue an existing MailUp email campaign for deferred dispatch at the supplied UTC date in exact yyyy-MM-dd HH:mm:ssZ format. Dispatch may consume email credits. Never retry automatically after a rejection or ambiguous result; check the sending state before deciding whether to call again. This action is email-only; use SCHEDULE_DEFERRED_SMS_DISPATCH for SMS. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | UTC dispatch date in exact yyyy-MM-dd HH:mm:ssZ format, for example 2026-09-02 10:00:00Z; MailUp accepts null. | | `sending_id` | integer | Yes | MailUp sending task ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Schedule Deferred SMS Dispatch **Slug:** `MAIL_UP_SCHEDULE_DEFERRED_SMS_DISPATCH` Explicitly schedule an existing MailUp SMS sending for a supplied future Date. The dispatch can consume SMS credits when it runs and repeating the request may change or duplicate scheduling; never retry an ambiguous result. Requires SMS entitlement and the 5 calls per second limit applies. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `date` | string | Yes | Explicit provider-formatted Date for deferred dispatch; required but nullable by XSD. | | `sending_id` | integer | Yes | Existing MailUp SMS sending task ID to schedule. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Schedule Immediate Email Dispatch **Slug:** `MAIL_UP_SCHEDULE_IMMEDIATE_DISPATCH` Irreversibly move an existing inactive MailUp email sending task into the immediate sending queue, where delivery can begin. Never automatically retry after an ambiguous timeout or transport failure; inspect the immediate and pending sending queues first. Use SCHEDULE_IMMEDIATE_SMS_DISPATCH for SMS. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | MailUp sending task ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Schedule Immediate SMS Dispatch **Slug:** `MAIL_UP_SCHEDULE_IMMEDIATE_SMS_DISPATCH` Explicitly queue an existing MailUp SMS sending for immediate dispatch. This requires SMS entitlement and credits, may incur charges, and can duplicate a dispatch if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | Existing MailUp SMS sending task ID to dispatch immediately. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Email Message to Recipient **Slug:** `MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENT` Irreversibly enqueue, defer, or snapshot an existing MailUp email message for one recipient email address. An omitted or `now` datetime starts queued delivery; a UTC datetime creates an immutable schedule; `undefined` creates an inactive recipient snapshot. This can consume credits and produce duplicate email if repeated. Never retry after an ambiguous timeout, connection loss, or unknown outcome; inspect the sending queues first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `email` | string | Yes | Recipient email address; MailUp accepts null. | | `datetime` | string | No | 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. | | `reply_to` | string | No | Reply-to email address for this sending; omit to use MailUp's configured default. | | `message_id` | integer | Yes | Existing MailUp email message ID. | | `sender_name` | string | No | Sender display name override. Supply sender_address with it; omit both to use the list defaults. | | `sender_address` | string | No | Verified sender email address override. Supply sender_name with it; omit both to use the list defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Email Message to Group **Slug:** `MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENT_IN_GROUP` Irreversibly enqueue, defer, or snapshot an existing MailUp email message for recipients in one group. An omitted or `now` datetime starts queued delivery; a UTC datetime creates an immutable schedule; `undefined` creates an inactive recipient snapshot. This can consume credits and deliver duplicate email if repeated. Never automatically retry after an ambiguous timeout or transport failure; inspect the sending queues first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datetime` | string | No | 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. | | `group_id` | integer | Yes | Positive MailUp group ID whose recipients receive the message. | | `reply_to` | string | No | Reply-to email address for this sending; omit to use MailUp's configured default. | | `message_id` | integer | Yes | Positive MailUp email message ID to send. | | `sender_name` | string | No | Sender display name override. Supply sender_address with it; omit both to use the list defaults. | | `sender_address` | string | No | Verified sender email address override. Supply sender_name with it; omit both to use the list defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send Email Message to List **Slug:** `MAIL_UP_SEND_MAIL_MESSAGE_TO_RECIPIENT_IN_LIST` Irreversibly enqueue, defer, or snapshot an existing MailUp email message for recipients in one list, optionally including or excluding groups. An omitted or `now` datetime starts queued delivery; a UTC datetime creates an immutable schedule; `undefined` creates an inactive recipient snapshot. This can consume credits and deliver duplicate email if repeated; never automatically retry after an ambiguous timeout or transport failure; inspect the sending queues first. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `datetime` | string | No | 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. | | `reply_to` | string | No | Reply-to email address for this sending; omit to use MailUp's configured default. | | `in_groups` | string | No | 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. | | `message_id` | integer | Yes | Positive MailUp email message ID. | | `sender_name` | string | No | Sender display name override. Supply sender_address with it; omit both to use the list defaults. | | `not_in_groups` | string | No | 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. | | `sender_address` | string | No | Verified sender email address override. Supply sender_name with it; omit both to use the list defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send SMS Message To Recipient **Slug:** `MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENT` Irreversibly send an existing MailUp SMS message directly to one Prefix/Number. This requires SMS entitlement, a confirmed sender, and credits; it may incur a charge and duplicate delivery if repeated. Never retry an ambiguous result and limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `number` | string | Yes | Destination Number without country prefix; required but nullable by XSD. | | `prefix` | integer | Yes | Integer international Prefix required by this endpoint. | | `message_id` | integer | Yes | Existing MailUp SMS idMessage to send. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send SMS Message To Group **Slug:** `MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENT_IN_GROUP` Irreversibly send or schedule an existing SMS message to recipients in one MailUp group. MailUp uses the SMS sender configured on the group's list, regardless of the message's Sender field. This requires SMS entitlement and credits, may incur charges, and may duplicate delivery if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `datetime` | string | No | Optional UTC schedule in exactly yyyy-MM-dd HH:mm:ssZ format; omit to send immediately. | | `group_id` | integer | Yes | MailUp group ID whose SMS recipients will receive the message. | | `message_id` | integer | Yes | Existing MailUp SMS message ID to send. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Send SMS Message To List **Slug:** `MAIL_UP_SEND_SMS_MESSAGE_TO_RECIPIENT_IN_LIST` Irreversibly send or schedule an existing SMS message to recipients in one MailUp list. MailUp uses the SMS sender configured on the list, regardless of the message's Sender field. This requires SMS entitlement and credits, may incur charges, and may duplicate delivery if repeated; never retry an ambiguous result. Limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID whose SMS recipients will receive the message. | | `datetime` | string | No | Optional UTC schedule in exactly yyyy-MM-dd HH:mm:ssZ format; omit to send immediately. | | `message_id` | integer | Yes | Existing MailUp SMS message ID to send. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Stop Email Sending Task **Slug:** `MAIL_UP_STOP_SENDING` Stop an existing MailUp email sending task and prevent its remaining queued email deliveries. MailUp permits at most 1 combined stop or delete call per 30 seconds. A process-local guard coordinates both actions in this worker only; MailUp remains authoritative across workers and other clients. Never retry automatically after a rejection or ambiguous result. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `sending_id` | integer | Yes | MailUp sending task ID to stop. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Subscribe Audience Recipient To Group **Slug:** `MAIL_UP_SUBSCRIBE_AUDIENCE_RECIPIENT_TO_GROUP` Add an existing MailUp recipient to one group. With confirm_subscription=true, also subscribe the recipient to the group's owning list; with confirm_subscription=false, assign the recipient to the group without changing the list subscription. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | MailUp group ID. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID to add to the group. | | `confirm_subscription` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Subscribe Recipient To List **Slug:** `MAIL_UP_SUBSCRIBE_RECIPIENT_TO_LIST` Extend an already-subscribed email recipient's membership to one additional MailUp list. This cannot reactivate an email recipient who is unsubscribed. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to subscribe the recipient to. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Subscribe SMS Recipient To Group **Slug:** `MAIL_UP_SUBSCRIBE_SMS_RECIPIENT_TO_GROUP` Add an existing SMS recipient to one MailUp group. With confirm_subscription=true, also subscribe the recipient to the group's owning list; with confirm_subscription=false, assign the recipient to the group without changing the list subscription. The account must have SMS service entitlement; observe MailUp's limit of 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | MailUp group ID to receive the SMS recipient. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID to subscribe in the group. | | `confirm_subscription` | boolean | No | 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Subscribe SMS Recipient To List **Slug:** `MAIL_UP_SUBSCRIBE_SMS_RECIPIENT_TO_LIST` Subscribe an existing recipient to the SMS channel of one MailUp list. The account must have SMS entitlement; observe the 5 calls per second limit. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to receive the SMS subscription. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID to subscribe to SMS. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsubscribe Audience Recipient From Group **Slug:** `MAIL_UP_UNSUBSCRIBE_AUDIENCE_RECIPIENT_FROM_GROUP` Remove one recipient from a MailUp group without unsubscribing that recipient from the parent list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `group_id` | integer | Yes | MailUp group ID. | | `recipient_id` | integer | Yes | MailUp recipient ID to remove from the group. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsubscribe Audience Recipient From Lists **Slug:** `MAIL_UP_UNSUBSCRIBE_AUDIENCE_RECIPIENT_FROM_LISTS` Unsubscribe one recipient from every explicitly supplied MailUp list ID in one request. This high-impact bulk subscription change does not delete the recipient record and reports both successful and failed list IDs. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_ids` | array | Yes | Non-empty MailUp list IDs from which to unsubscribe the recipient. | | `recipient_id` | integer | Yes | MailUp recipient ID to unsubscribe. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsubscribe Recipient From List **Slug:** `MAIL_UP_UNSUBSCRIBE_RECIPIENT_FROM_LIST` Unsubscribe an existing email recipient from one MailUp list and remove the recipient from every group owned by that list, without deleting the global recipient record or changing the SMS channel. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID to unsubscribe the recipient from. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsubscribe SMS Recipient From List **Slug:** `MAIL_UP_UNSUBSCRIBE_SMS_RECIPIENT_FROM_LIST` Remove 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 | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | MailUp list ID whose SMS subscription will be removed. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID to unsubscribe from SMS. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Unsubscribe SMS Recipient From Lists **Slug:** `MAIL_UP_UNSUBSCRIBE_SMS_RECIPIENT_FROM_LISTS` Remove one recipient's SMS subscriptions from an explicit set of MailUp lists and report per-list results. Requires SMS entitlement; limit traffic to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_ids` | string | Yes | List IDs to unsubscribe from; null is accepted by the provider XSD. | | `recipient_id` | integer | Yes | Existing MailUp recipient ID to unsubscribe from SMS lists. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Audience Group **Slug:** `MAIL_UP_UPDATE_AUDIENCE_GROUP` Update explicitly supplied fields of a MailUp group; omitted body fields are not sent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Replacement group name; omission leaves the key out of the request. | | `count` | integer | No | Replacement count when explicitly supplied. | | `notes` | string | No | Replacement group notes; omission leaves the key out of the request. | | `list_id` | integer | Yes | Owning MailUp list ID. | | `group_id` | integer | Yes | MailUp group ID to update. | | `deletable` | boolean | No | Replacement deletion flag when explicitly supplied. | | `body_list_id` | integer | No | Optional list ID included in the body. | | `body_group_id` | integer | No | Optional group ID included in the body. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Audience Recipient Detail **Slug:** `MAIL_UP_UPDATE_AUDIENCE_RECIPIENT_DETAIL` Update explicitly supplied contact and dynamic-field details for a MailUp address-book recipient; omitted fields are not sent. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | No | Recipient name. | | `email` | string | Yes | Recipient email address; required by MailUp but may be null. | | `recipient_id` | integer | No | Existing MailUp recipient ID, when known. | | `mobile_number` | string | No | Recipient mobile number. | | `mobile_prefix` | string | No | Recipient international prefix. | | `dynamic_fields` | array | No | Dynamic fields to write; omission preserves provider defaults. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Content Source **Slug:** `MAIL_UP_UPDATE_CONTENT_SOURCE` Update supplied settings of one MailUp content-provider source. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `source_id` | integer | Yes | Content source ID to update. | | `is_enabled` | boolean | No | New enabled state; omit to leave this provider field unsupplied. | | `source_name` | string | No | New source name; omit to leave it unsupplied or send null to clear it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Email Message **Slug:** `MAIL_UP_UPDATE_EMAIL_MESSAGE` Update an existing MailUp email message's subject and content while preserving omitted settings; this changes the draft and does not send it. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | 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. | | `notes` | string | No | Replacement internal notes. Omit to preserve the current value. | | `content` | string | Yes | Complete replacement email body content. | | `list_id` | integer | Yes | MailUp list ID containing the message. | | `subject` | string | Yes | Complete replacement subject line. | | `tracking` | object | No | Replacement tracking configuration. Omit to preserve it. | | `structure` | string | No | 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. | | `message_id` | integer | Yes | MailUp email message ID to update. | | `pre_header` | string | No | Replacement preview text. Omit to preserve the current value. | | `clear_notes` | boolean | No | Set true to send Notes as null; cannot be combined with notes. | | `embed_images` | boolean | No | Whether referenced images are embedded. Omit to preserve the current setting. | | `clear_tracking` | boolean | No | Set true to send TrackingInfo as null; cannot be combined with tracking. | | `dynamic_fields` | array | No | Dynamic-field replacement sent as Fields. Omit to preserve the current value; an empty list sends Fields as an empty array. | | `clear_structure` | boolean | No | Set true to send Structure as null; cannot be combined with structure. | | `is_confirmation` | boolean | No | Whether this is a confirmation message. Omit to preserve the current setting. | | `clear_pre_header` | boolean | No | Set true to send PreHeader as null; cannot be combined with pre_header. | | `use_dynamic_fields` | boolean | No | Whether dynamic recipient fields are enabled. Omit to preserve the current setting. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update List **Slug:** `MAIL_UP_UPDATE_LIST` Update only supplied settings on one MailUp list. This does not change membership or send messages; access depends on list permissions and standard REST traffic is limited to 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `city` | string | No | Sender city; omission preserves the provider value. | | `name` | string | No | List name; omission preserves the provider value. | | `phone` | string | No | Sender phone number; omission preserves the provider value. | | `format` | string ("html" | "text") | No | Default email format: 'html' or 'text'. Use multipart_text separately to enable multipart text. | | `kb_max` | integer | No | Maximum message size in kilobytes. | | `public` | boolean | No | Whether the list is public. | | `address` | string | No | Sender postal address; omission preserves the provider value. | | `charset` | string | No | Character set used by the list. | | `list_id` | integer | Yes | MailUp list ID to update. | | `business` | boolean | No | Business-account flag; omission preserves the provider value. | | `customer` | boolean | No | Customer-account flag; omission preserves the provider value. | | `reply_to` | string | No | Reply-to address; omission preserves the provider value. | | `disclaimer` | string | No | List disclaimer text. | | `display_as` | string | No | Display name; omission preserves the provider value. | | `scope_code` | integer | No | List-purpose code returned by the public MAIL_UP_LIST_LIST_SCOPES tool; use it to select a valid value. | | `description` | string | No | List description. | | `optout_type` | integer | No | MailUp opt-out mode code configured for the account; preserve an existing value unless the intended account mode is known. | | `owner_email` | string | No | List owner email; omission preserves the provider value. | | `postal_code` | string | No | Sender postal code; omission preserves the provider value. | | `company_name` | string | No | Sender company name; omission preserves the provider value. | | `contact_name` | string | No | Sender contact name; omission preserves the provider value. | | `country_code` | string | No | Country code; use GET_COUNTRY_CODES for valid values. | | `notify_email` | string | No | Notification email address. | | `web_site_url` | string | No | Sender website URL; omission preserves the provider value. | | `bounced_email` | string | No | Address used for bounced email notifications. | | `frontend_form` | boolean | No | Whether the front-end subscription form is enabled. | | `default_prefix` | string | No | Default international mobile prefix. | | `header_x_abuse` | string | No | X-Abuse header value. | | `multipart_text` | boolean | No | Whether multipart text is enabled. | | `nl_sender_name` | string | No | Newsletter sender name; omission preserves the provider value. | | `time_zone_code` | string | No | MailUp list time-zone code. | | `sms_sender_name` | string | No | SMS sender name. | | `track_on_opened` | boolean | No | Whether opened-message tracking is enabled. | | `send_confirm_sms` | boolean | No | Whether subscription confirmation SMS is sent. | | `subscribed_email` | boolean | No | Whether subscription email notifications are enabled. | | `multi_optout_list` | string | No | Comma-separated MailUp list IDs also affected by a multi-list opt-out. | | `send_email_optout` | boolean | No | Whether an email is sent on opt-out. | | `state_or_province` | string | No | Sender state or province; omission preserves the provider value. | | `permission_reminder` | string | No | Permission reminder; omission preserves the provider value. | | `conversionlab_track_code` | string | No | ConversionLab tracking code. | | `header_list_unsubscriber` | string | No | List-Unsubscribe header value. | | `link_tracking_parameters` | string | No | Parameters appended for link tracking. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Online Email Visibility **Slug:** `MAIL_UP_UPDATE_ONLINE_EMAIL_MESSAGE_VISIBILITY` Publish or hide one MailUp email message on the list's online archive; this does not send the message. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `list_id` | integer | Yes | Positive MailUp list ID containing the email message. | | `visible` | boolean | Yes | True to publish the message online, or false to hide it. | | `message_id` | integer | Yes | Positive MailUp email message ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Personalization Endpoint **Slug:** `MAIL_UP_UPDATE_PERSONALIZATION_ENDPOINT` Replace the configuration of one MailUp personalization endpoint. This operation requires Personalization to be enabled by MailUp for the connected platform account. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `url` | string | Yes | Endpoint URL; the MailUp contract permits null. | | `label` | string | Yes | Endpoint label; the MailUp contract permits null. | | `headers` | array | No | Optional endpoint headers, or null. | | `recipient` | object | No | Optional recipient mapping, or null. | | `parameters` | array | No | Optional personalization parameters, or null. | | `credentials` | object | No | Optional endpoint username and password, or null. | | `endpoint_id` | integer | Yes | Personalization endpoint ID to replace. | | `update_date` | string | No | Provider-managed endpoint update timestamp; normally omit on create or update. | | `creation_date` | string | No | Provider-managed endpoint creation timestamp; normally omit on create or update. | | `endpoint_body_id` | integer | No | Existing numeric personalization endpoint ID repeated in the body; omit on create and normally omit on update because the route identifies it. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update SMS Message **Slug:** `MAIL_UP_UPDATE_SMS_MESSAGE` Replace documented fields of one MailUp SMS draft without sending it. The account needs SMS entitlement; observe MailUp's limit of 5 calls per second. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `tags` | array | No | Optional replacement Tags array; null items are permitted. | | `notes` | string | No | Optional replacement Notes. Omit to preserve the current value. | | `sender` | string | No | Optional replacement draft Sender value; MailUp uses the list-level SMS sender for delivery regardless of this field. | | `content` | string | Yes | Replacement Content; required but nullable by XSD. | | `list_id` | integer | Yes | MailUp list ID containing the SMS message. | | `subject` | string | Yes | Replacement Subject; required but nullable by XSD. | | `structure` | string | No | Replacement MailUp editor structure metadata; only send a Structure value obtained from MailUp. | | `is_unicode` | boolean | No | Optional non-null IsUnicode flag. | | `message_id` | integer | Yes | MailUp SMS message ID to update. | | `creation_date` | string | No | Provider-managed SMS draft creation timestamp; normally preserve by omitting it. | | `dynamic_fields` | array | No | Optional replacement Fields array; null items are permitted. | | `use_dynamic_fields` | boolean | No | Optional non-null UseDynamicField flag. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Source Contents **Slug:** `MAIL_UP_UPDATE_SOURCE_CONTENTS` Add or update content items in one MailUp content-provider source and return the activity ID. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `items` | array | No | Content items; omit, send null, or provide items according to the upload mode. | | `source_id` | integer | Yes | Content source ID to add content to or update. | | `upload_mode` | integer | No | MailUp upload-mode code; omit to use provider behavior. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not | ### Update Tag **Slug:** `MAIL_UP_UPDATE_TAG` Replace the name and optionally the enabled state of one tag in a MailUp list. #### Input Parameters | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `name` | string | Yes | Replacement tag name; MailUp permits null. | | `tag_id` | integer | Yes | Positive MailUp tag ID. | | `enabled` | boolean | No | Replacement enabled state; omit to leave Enabled unchanged; cannot be null. | | `list_id` | integer | Yes | Positive MailUp list ID. | #### Output | Parameter | Type | Required | Description | |-----------|------|----------|-------------| | `data` | string | Yes | Data from the action execution | | `error` | string | No | Error if any occurred during the execution of the action | | `successful` | boolean | Yes | Whether or not the action execution was successful or not |