> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Unione

> UniOne is an email delivery service offering a versatile Web API and SMTP API for sending transactional and marketing emails.

![Unione logo](https://mintcdn.com/composio-preview/DMB8UrgJmE7r-ZQ5/images/toolkits/unione.svg?fit=max\&auto=format\&n=DMB8UrgJmE7r-ZQ5\&q=85\&s=e09d99063ff5852b7e0deb5c7da4c6fd)

* **Category:** transactional email
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 32
* **Triggers:** 0
* **Slug:** `UNIONE`
* **Version:** 20261101\_00

## Tools

> [accordion] Delete Event Dump
>
> **Slug:** `UNIONE_DELETE_EVENT_DUMP`
>
> Tool 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
>
> **dump\_id** `string` *required*
>
> Event dump ID to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `UNIONE_DELETE_TEMPLATE`
>
> Tool to delete a template by ID. Use when you need to permanently remove a template from the account.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Template UUID to delete. Must be a valid template identifier.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `UNIONE_DELETE_WEBHOOK`
>
> Tool 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
>
> **url** `string` *required*
>
> The URL of the webhook to delete. Must match the exact webhook URL that was previously registered.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Balance
>
> **Slug:** `UNIONE_EMAIL_BALANCE`
>
> Retrieves account information and billing-period email usage from UniOne, including emails included and sent. The response requires account-level accounting information.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel Scheduled Email
>
> **Slug:** `UNIONE_EMAIL_CANCEL`
>
> Tool 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
>
> **job\_id** `string` *required*
>
> ID of the scheduled email job to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Domain Management
>
> **Slug:** `UNIONE_EMAIL_DOMAIN`
>
> Manage 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
>
> **limit** `integer`
>
> Maximum number of items to return (only for 'list').
>
> **domain** `string`
>
> Domain name to operate on. Required for all operations except 'list'.
>
> **offset** `integer`
>
> Index of first item (0-based) (only for 'list').
>
> **operation** `string ("get_dns_records" | "validate_verification_record" | "validate_dkim" | "list" | "delete")` *required*
>
> Operation to perform on sender domains.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Event
>
> **Slug:** `UNIONE_EMAIL_EVENT_GET`
>
> Tool to retrieve details of a specific email event by its ID. Use when you need event information for auditing or diagnostics.
>
> #### Input Parameters
>
> **event\_id** `string` *required*
>
> Unique identifier of the email event to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Send Job
>
> **Slug:** `UNIONE_EMAIL_GET`
>
> Tool to retrieve detailed information about a specific email send job. Use when you need its delivery metrics and history.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> Unique identifier of the email send job
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email List (Export)
>
> **Slug:** `UNIONE_EMAIL_LIST`
>
> Tool 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
>
> **email** `string`
>
> Recipient email address
>
> **limit** `integer`
>
> Max events per dump file (default 50). If >100000, multiple files are created.
>
> **domain** `string`
>
> Recipient domain
>
> **format** `string ("csv" | "csv_gzip")`
>
> Output format: 'csv' (default) or 'csv\_gzip'
>
> **status** `string ("accepted" | "sent" | "delivered" | "opened" | "clicked" | "unsubscribed" | "subscribed" | "soft_bounced" | "hard_bounced" | "spam")`
>
> Email status filter
>
> **date\_to** `string`
>
> ISO 8601 end timestamp
>
> **aggregate** `string ("day_status" | "")`
>
> Aggregation over the period; cannot combine with filters when set
>
> **date\_from** `string` *required*
>
> ISO 8601 start timestamp
>
> **delimiter** `string ("," | ";")`
>
> CSV delimiter: ',' or ';'
>
> **from\_email** `string`
>
> Sender email address
>
> **campaign\_id** `string`
>
> Campaign identifier (decimal or UUID up to 128-bit)
>
> **dump\_fields** `array`
>
> Ordered list of columns for the report. Defaults to a useful set if omitted.
>
> **delivery\_status** `string`
>
> Comma-separated internal delivery statuses
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resend Sent Email
>
> **Slug:** `UNIONE_EMAIL_RESEND`
>
> Tool 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
>
> **job\_id** `string` *required*
>
> Unique job ID of the originally sent email to resend.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Resubscribe
>
> **Slug:** `UNIONE_EMAIL_RESUBSCRIBE`
>
> Send 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
>
> **to\_email** `string` *required*
>
> Email address of the user to be resubscribed
>
> **from\_name** `string` *required*
>
> Name of the sender displayed to the recipient
>
> **from\_email** `string` *required*
>
> Sender's email address to send the resubscribe message
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume Paused Email
>
> **Slug:** `UNIONE_EMAIL_RESUME`
>
> Tool to resume a paused transactional email by its job ID. Use when you need to restart a paused pending email send.
>
> #### Input Parameters
>
> **job\_id** `string` *required*
>
> ID of the paused email job to resume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email SMTP Configuration
>
> **Slug:** `UNIONE_EMAIL_SMTP`
>
> Construct SMTP configuration details from the connection's region and API key, including a derived host, ports, username and password.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Statistics
>
> **Slug:** `UNIONE_EMAIL_STATISTICS`
>
> Retrieve 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
>
> **date\_to** `string` *required*
>
> End date (inclusive) in YYYY-MM-DD format
>
> **date\_from** `string` *required*
>
> Start date (inclusive) in YYYY-MM-DD format
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Unsubscribe
>
> **Slug:** `UNIONE_EMAIL_UNSUBSCRIBE`
>
> Add an email address to the UniOne suppression list with an unsubscribed cause, suppressing future sends in the applicable account or project.
>
> #### Input Parameters
>
> **cause** `string` *required*
>
> Suppression reason; must be 'unsubscribed' for this action
>
> **email** `string` *required*
>
> Email address to unsubscribe
>
> **created** `string`
>
> UTC timestamp when the suppression was created (YYYY-MM-DD hh:mm:ss)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Batch Email Validation
>
> **Slug:** `UNIONE_EMAIL_VALIDATE_BATCH`
>
> Validates 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
>
> **emails** `array` *required*
>
> List of email addresses to validate (must be valid email format).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Email from Suppression List
>
> **Slug:** `UNIONE_EMAIL_VALIDATE_DELETE`
>
> Remove deletable suppression records for an email address from the UniOne suppression list. Some suppression records cannot be deleted.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to remove from the suppression list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retry Email Validation
>
> **Slug:** `UNIONE_EMAIL_VALIDATE_RETRY`
>
> Tool to retry an email validation request. Updated to re-run validation via the official single validation endpoint using the provided email address.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Email address to (re)validate (previously: request ID)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Email Webhook Types
>
> **Slug:** `UNIONE_EMAIL_WEBHOOK_TYPES`
>
> Collects 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
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Event Dump
>
> **Slug:** `UNIONE_EVENT_DUMP_CREATE`
>
> Tool to create an asynchronous CSV event dump. Use when you need to export transactional email events for a specified time window.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Max events per file (default 50). If >100000, multiple files of 100000 events are created.
>
> **filter** `object`
>
> Filters to apply when selecting events for the dump.
>
> **format** `string ("csv" | "csv_gzip")`
>
> Output format: 'csv' (default) or 'csv\_gzip'.
>
> **end\_time** `string`
>
> End of time window (non-inclusive) in UTC 'YYYY-MM-DD hh:mm:ss'.
>
> **aggregate** `string ("day_status" | "")`
>
> Aggregation over the period: 'day\_status' for daily stats. Cannot combine with filters when set.
>
> **delimiter** `string ("," | ";")`
>
> Field delimiter for CSV: ',' or ';'.
>
> **start\_time** `string` *required*
>
> Start of time window in UTC 'YYYY-MM-DD hh:mm:ss'.
>
> **dump\_fields** `array`
>
> Ordered list of columns for the report. Defaults to all standard fields if omitted.
>
> **all\_projects** `boolean`
>
> If true and projects are enabled, fetches data across all projects.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Event Dump List
>
> **Slug:** `UNIONE_EVENT_DUMP_LIST`
>
> Tool to retrieve the full list of event dumps. Use when you need to view all existing event-dump tasks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event Dump
>
> **Slug:** `UNIONE_GET_EVENT_DUMP`
>
> Retrieve 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
>
> **dump\_id** `string` *required*
>
> Unique identifier of the event dump task (UUID format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Suppression Details
>
> **Slug:** `UNIONE_GET_SUPPRESSION`
>
> Tool to check if an email is suppressed and retrieve the reason and date. Use when verifying why an email cannot receive messages.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address to check for suppression status
>
> **all\_projects** `boolean`
>
> Check across all projects. If not provided, checks only the current project.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `UNIONE_GET_TEMPLATE`
>
> Tool to get template properties by ID. Use when you need to retrieve the full template configuration and content for a specific template.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Template UUID
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook Configuration
>
> **Slug:** `UNIONE_GET_WEBHOOK`
>
> Retrieves a UniOne webhook configuration by its URL. Use it to check the current settings of an event notification handler.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Webhook URL to retrieve configuration for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Schedule Email
>
> **Slug:** `UNIONE_SCHEDULE_EMAIL`
>
> Tool 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
>
> **message** `object` *required*
>
> Email message container with scheduling options
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Suppression List
>
> **Slug:** `UNIONE_SUPPRESSION_LIST`
>
> Tool to return the suppression list since a given date. Use when auditing bounced, unsubscribed, or blocked recipients.
>
> #### Input Parameters
>
> **cause** `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.
>
> **limit** `integer`
>
> Maximum number of records to return. Defaults to 50.
>
> **cursor** `string`
>
> Pagination cursor. Omit for first call; use `cursor` from previous response for subsequent pages.
>
> **source** `string ("user" | "system" | "subscriber")`
>
> Optional source filter. One of: user (set via suppression/set), system, subscriber.
>
> **start\_time** `string`
>
> UTC start time (YYYY-MM-DD hh:mm:ss) to fetch suppressions from. Ignored if `cursor` is provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Tag
>
> **Slug:** `UNIONE_TAG_DELETE`
>
> Tool to delete a specific tag. Use when you have confirmed the tag ID you wish to remove.
>
> #### Input Parameters
>
> **tag\_id** `integer` *required*
>
> Unique identifier of the tag to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Tag List
>
> **Slug:** `UNIONE_TAG_LIST`
>
> Tool to retrieve all user-defined tags. Use when you need to fetch the full list of tags after authentication.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] UniOne Template List
>
> **Slug:** `UNIONE_TEMPLATE_LIST`
>
> Tool to list email templates. Use when you need to retrieve available templates for transactional emails.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum number of templates to return, must be at least 1.
>
> **offset** `integer`
>
> Starting index (0-based) for pagination.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Template
>
> **Slug:** `UNIONE_TEMPLATE_SET`
>
> Tool to set or update an email template. Use when you need to create or modify transactional email templates before sending messages.
>
> #### Input Parameters
>
> **template** `object` *required*
>
> Template object to create or update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Webhook
>
> **Slug:** `UNIONE_WEBHOOK_SET`
>
> Tool to set or edit a webhook event notification handler. Use when you need to configure your webhook for event callbacks.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Target URL to receive event notifications; ASCII only (use Punycode for non-ASCII)
>
> **events** `object`
>
> Events container for webhook notifications
>
> **status** `string ("active" | "disabled" | "stopped")`
>
> Webhook status: 'active' (default), 'disabled' (user-disabled), or 'stopped' (auto-stopped after 24h of failed calls)
>
> **event\_format** `string ("json_post" | "json_post_gzip")`
>
> Notification format: 'json\_post' (default) or 'json\_post\_gzip'
>
> **max\_parallel** `integer`
>
> Maximum number of parallel requests allowed (5-100)
>
> **single\_event** `integer`
>
> 1 to send single event per call, 0 to batch multiple
>
> **delivery\_info** `integer`
>
> 1 to include detailed delivery info, 0 otherwise
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
