Skip to main content
Unione logo
  • Category: transactional email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 32
  • Triggers: 0
  • Slug: UNIONE
  • Version: 20261101_00

Tools

Slug: UNIONE_DELETE_EVENT_DUMPTool to delete an event dump file and remove it from the queue or storage. Use when you need to clean up an existing event dump by its dump_id.

Input Parameters

string
required
Event dump ID to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_DELETE_TEMPLATETool to delete a template by ID. Use when you need to permanently remove a template from the account.

Input Parameters

string
required
Template UUID to delete. Must be a valid template identifier.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_DELETE_WEBHOOKTool to delete a webhook event notification handler by its URL. Use when you need to stop receiving callback notifications for a specific webhook.

Input Parameters

string
required
The URL of the webhook to delete. Must match the exact webhook URL that was previously registered.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_BALANCERetrieves account information and billing-period email usage from UniOne, including emails included and sent. The response requires account-level accounting information.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_CANCELTool to cancel a scheduled transactional email by its job ID. Use when you need to stop a pending email send before it’s dispatched.

Input Parameters

string
required
ID of the scheduled email job to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_DOMAINManage UniOne sender domains: obtain DNS verification records, trigger ownership or DKIM checks, list domains, or delete a domain. Requesting DNS records can also register a new domain.

Input Parameters

integer
Maximum number of items to return (only for ‘list’).
string
Domain name to operate on. Required for all operations except ‘list’.
integer
Index of first item (0-based) (only for ‘list’).
string ("get_dns_records" | "validate_verification_record" | "validate_dkim" | "list" | "delete")
required
Operation to perform on sender domains.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_EVENT_GETTool to retrieve details of a specific email event by its ID. Use when you need event information for auditing or diagnostics.

Input Parameters

string
required
Unique identifier of the email event to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_GETTool to retrieve detailed information about a specific email send job. Use when you need its delivery metrics and history.

Input Parameters

string
required
Unique identifier of the email send job

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_LISTTool to export email events within a specified time frame. It creates an asynchronous event dump which can later be downloaded and parsed using UNIONE_EVENT_DUMP_GET.

Input Parameters

string
Recipient email address
integer
Max events per dump file (default 50). If >100000, multiple files are created.
string
Recipient domain
string ("csv" | "csv_gzip")
Output format: ‘csv’ (default) or ‘csv_gzip’
string ("accepted" | "sent" | "delivered" | "opened" | "clicked" | "unsubscribed" | "subscribed" | "soft_bounced" | "hard_bounced" | "spam")
Email status filter
string
ISO 8601 end timestamp
string ("day_status" | "")
Aggregation over the period; cannot combine with filters when set
string
required
ISO 8601 start timestamp
string ("," | ";")
CSV delimiter: ’,’ or ’;’
string
Sender email address
string
Campaign identifier (decimal or UUID up to 128-bit)
array
Ordered list of columns for the report. Defaults to a useful set if omitted.
string
Comma-separated internal delivery statuses

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_RESENDTool to resend a previously sent email by its job ID. Use when you need to trigger a resend of an email that has already been sent and you have the original job ID.

Input Parameters

string
required
Unique job ID of the originally sent email to resend.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_RESUBSCRIBESend a resubscription link to a previously unsubscribed recipient or one blocked due to complaints. The subscription is restored when the recipient clicks the link.

Input Parameters

string
required
Email address of the user to be resubscribed
string
required
Name of the sender displayed to the recipient
string
required
Sender’s email address to send the resubscribe message

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_RESUMETool to resume a paused transactional email by its job ID. Use when you need to restart a paused pending email send.

Input Parameters

string
required
ID of the paused email job to resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_SMTPConstruct SMTP configuration details from the connection’s region and API key, including a derived host, ports, username and password.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_STATISTICSRetrieve daily and total email statistics for an inclusive date range, including sent, delivered, bounced, opened, and clicked counts. The result covers at most one event-dump file.

Input Parameters

string
required
End date (inclusive) in YYYY-MM-DD format
string
required
Start date (inclusive) in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_UNSUBSCRIBEAdd an email address to the UniOne suppression list with an unsubscribed cause, suppressing future sends in the applicable account or project.

Input Parameters

string
required
Suppression reason; must be ‘unsubscribed’ for this action
string
required
Email address to unsubscribe
string
UTC timestamp when the suppression was created (YYYY-MM-DD hh:mm:ss)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_VALIDATE_BATCHValidates a list of email addresses using UniOne’s single-address checks. Results can include validity classifications, scores, and details useful for assessing address deliverability.

Input Parameters

array
required
List of email addresses to validate (must be valid email format).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_VALIDATE_DELETERemove deletable suppression records for an email address from the UniOne suppression list. Some suppression records cannot be deleted.

Input Parameters

string
required
Email address to remove from the suppression list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_VALIDATE_RETRYTool to retry an email validation request. Updated to re-run validation via the official single validation endpoint using the provided email address.

Input Parameters

string
required
Email address to (re)validate (previously: request ID)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EMAIL_WEBHOOK_TYPESCollects the distinct spam-block and email-status event types configured on the webhooks returned by one webhook-list request. The result may not include all supported event types.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EVENT_DUMP_CREATETool to create an asynchronous CSV event dump. Use when you need to export transactional email events for a specified time window.

Input Parameters

integer
Max events per file (default 50). If >100000, multiple files of 100000 events are created.
object
Filters to apply when selecting events for the dump.
string ("csv" | "csv_gzip")
Output format: ‘csv’ (default) or ‘csv_gzip’.
string
End of time window (non-inclusive) in UTC ‘YYYY-MM-DD hh:mm:ss’.
string ("day_status" | "")
Aggregation over the period: ‘day_status’ for daily stats. Cannot combine with filters when set.
string ("," | ";")
Field delimiter for CSV: ’,’ or ’;’.
string
required
Start of time window in UTC ‘YYYY-MM-DD hh:mm:ss’.
array
Ordered list of columns for the report. Defaults to all standard fields if omitted.
boolean
If true and projects are enabled, fetches data across all projects.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_EVENT_DUMP_LISTTool to retrieve the full list of event dumps. Use when you need to view all existing event-dump tasks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_GET_EVENT_DUMPRetrieve an event dump’s status and available download URLs by dump ID. Use this to check whether the dump is ready; files already listed can be downloaded even while processing continues.

Input Parameters

string
required
Unique identifier of the event dump task (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_GET_SUPPRESSIONTool to check if an email is suppressed and retrieve the reason and date. Use when verifying why an email cannot receive messages.

Input Parameters

string
required
Email address to check for suppression status
boolean
Check across all projects. If not provided, checks only the current project.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_GET_TEMPLATETool to get template properties by ID. Use when you need to retrieve the full template configuration and content for a specific template.

Input Parameters

string
required
Template UUID

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_GET_WEBHOOKRetrieves a UniOne webhook configuration by its URL. Use it to check the current settings of an event notification handler.

Input Parameters

string
required
Webhook URL to retrieve configuration for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_SCHEDULE_EMAILTool to schedule a transactional email up to 24 hours ahead. Use when you need to send an email at a specific future time.

Input Parameters

object
required
Email message container with scheduling options

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_SUPPRESSION_LISTTool to return the suppression list since a given date. Use when auditing bounced, unsubscribed, or blocked recipients.

Input Parameters

string ("unsubscribed" | "temporary_unavailable" | "permanent_unavailable" | "complained" | "blocked")
Optional cause filter. One of: unsubscribed, temporary_unavailable, permanent_unavailable, complained, blocked. New causes may be added.
integer
Maximum number of records to return. Defaults to 50.
string
Pagination cursor. Omit for first call; use cursor from previous response for subsequent pages.
string ("user" | "system" | "subscriber")
Optional source filter. One of: user (set via suppression/set), system, subscriber.
string
UTC start time (YYYY-MM-DD hh:mm:ss) to fetch suppressions from. Ignored if cursor is provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_TAG_DELETETool to delete a specific tag. Use when you have confirmed the tag ID you wish to remove.

Input Parameters

integer
required
Unique identifier of the tag to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_TAG_LISTTool to retrieve all user-defined tags. Use when you need to fetch the full list of tags after authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_TEMPLATE_LISTTool to list email templates. Use when you need to retrieve available templates for transactional emails.

Input Parameters

integer
Maximum number of templates to return, must be at least 1.
integer
Starting index (0-based) for pagination.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_TEMPLATE_SETTool to set or update an email template. Use when you need to create or modify transactional email templates before sending messages.

Input Parameters

object
required
Template object to create or update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: UNIONE_WEBHOOK_SETTool to set or edit a webhook event notification handler. Use when you need to configure your webhook for event callbacks.

Input Parameters

string
required
Target URL to receive event notifications; ASCII only (use Punycode for non-ASCII)
object
Events container for webhook notifications
string ("active" | "disabled" | "stopped")
Webhook status: ‘active’ (default), ‘disabled’ (user-disabled), or ‘stopped’ (auto-stopped after 24h of failed calls)
string ("json_post" | "json_post_gzip")
Notification format: ‘json_post’ (default) or ‘json_post_gzip’
integer
Maximum number of parallel requests allowed (5-100)
integer
1 to send single event per call, 0 to batch multiple
integer
1 to include detailed delivery info, 0 otherwise

Output

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