---
canonical_url: "https://docs.composio.dev/toolkits/mail_channels"
markdown_url: "https://docs.composio.dev/toolkits/mail_channels.md"
product: "platform"
version: null
last_updated: null
---

# MailChannels

MailChannels provides transactional email delivery, domain and DKIM management, sub-account administration, usage reporting, suppression lists, metrics, and webhooks.

- **Category:** email
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 43
- **Triggers:** 0
- **Slug:** `MAIL_CHANNELS`
- **Version:** 00000000_00

## Tools

### Activate Sub-account

**Slug:** `MAIL_CHANNELS_ACTIVATE_SUB_ACCOUNT`

Reactivate a suspended sub-account, restoring its ability to send email.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the suspended sub-account to reactivate. |

#### 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 |

### Check Domain Authentication

**Slug:** `MAIL_CHANNELS_CHECK_DOMAIN_AUTHENTICATION`

Check a sending domain's DKIM, SPF, sender-domain DNS, and Domain Lockdown configuration without changing it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Sending domain to check. Stored DKIM keys for this domain are used when no more specific DKIM setting is supplied. |
| `sender_id` | string | No | MailChannels sender ID used for Domain Lockdown verification, if configured. |
| `dkim_settings` | array | No | DKIM settings to check. Omit to use stored keys for domain; at most 10 settings are allowed. |
| `envelope_from_domain` | string | No | Envelope sender domain used for SPF and Domain Lockdown checks when it differs from domain. |

#### 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 DKIM Key

**Slug:** `MAIL_CHANNELS_CREATE_DKIM_KEY`

Create a MailChannels-managed DKIM key pair and return the public key and DNS record that must be published.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain for the new MailChannels-managed DKIM key. |
| `selector` | string | Yes | Unique DKIM selector for the domain (1-63 characters). |
| `algorithm` | string | No | Key algorithm. MailChannels currently supports only rsa. |
| `key_length` | integer | No | RSA key length in bits, from 1024 to 4096 in multiples of 1024. |

#### 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 Sub-account

**Slug:** `MAIL_CHANNELS_CREATE_SUB_ACCOUNT`

Create a sub-account under the connected parent account. This creates persistent tenant state but no API or SMTP credential.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | No | Unique lowercase alphanumeric handle (3-128 characters). Omit to let MailChannels generate one. |
| `company_name` | string | Yes | Display company name for the sub-account (3-128 characters). |

#### 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 Sub-account API Key

**Slug:** `MAIL_CHANNELS_CREATE_SUB_ACCOUNT_API_KEY`

Explicitly create a sensitive API credential for a sub-account. The returned secret may be shown only once; store it securely because tool or application logs can expose it. This provider-created credential is output for the sub-account and is never connection authentication for this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account for which a new API key will be created. |

#### 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 Sub-account SMTP Password

**Slug:** `MAIL_CHANNELS_CREATE_SUB_ACCOUNT_SMTP_PASSWORD`

Explicitly create a sensitive SMTP credential for a sub-account. The returned password may be shown only once; store it securely because tool or application logs can expose it. This provider-created credential is output for SMTP use and is never connection authentication for this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account for which a new SMTP password will be created. |

#### 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 Suppression Entries

**Slug:** `MAIL_CHANNELS_CREATE_SUPPRESSION_ENTRIES`

Atomically add one or more recipients to the connected account's suppression list, optionally also applying them to all associated sub-accounts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `add_to_sub_accounts` | boolean | No | Also create these entries for every associated sub-account. Applicable only to parent accounts. |
| `suppression_entries` | array | Yes | Suppression entries to create atomically; the account-wide total created by this request cannot exceed 1000. |

#### 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 All Webhooks

**Slug:** `MAIL_CHANNELS_DELETE_ALL_WEBHOOKS`

Permanently remove every webhook endpoint enrolled for the connected MailChannels account. This destructive action has no endpoint selector and must not be used when any existing webhook configuration should be retained.

#### 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 Custom Tracking Domain

**Slug:** `MAIL_CHANNELS_DELETE_CUSTOM_TRACKING_DOMAIN`

Permanently delete one custom tracking domain by exact hostname and scope. This destructive action immediately breaks tracking and unsubscribe URLs in previously sent messages that use the domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `scope` | string ("click" | "open" | "unsubscribe") | Yes | Event scope identifying the custom tracking domain to permanently delete. |
| `hostname` | string | Yes | Exact hostname to permanently delete. Existing tracking and unsubscribe links using it will stop working 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 |

### Delete Sub-account

**Slug:** `MAIL_CHANNELS_DELETE_SUB_ACCOUNT`

Permanently and irreversibly delete one MailChannels sub-account by its exact handle. This destructive action cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Exact handle of the sub-account to permanently and irreversibly delete. Verify the handle before calling this action. |

#### 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 Sub-account API Key

**Slug:** `MAIL_CHANNELS_DELETE_SUB_ACCOUNT_API_KEY`

Permanently revoke one sub-account API key by exact sub-account handle and key ID. This explicit destructive credential deletion cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Exact provider-assigned ID of the sub-account API key to revoke. |
| `handle` | string | Yes | Exact handle of the sub-account whose API key will be revoked. |

#### 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 Sub-account Limit

**Slug:** `MAIL_CHANNELS_DELETE_SUB_ACCOUNT_LIMIT`

Delete a sub-account's explicit monthly send limit. This destructive quota reset makes the sub-account inherit the parent account's remaining send capacity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Exact handle of the sub-account whose explicit monthly send limit will be removed. After removal, the sub-account inherits the parent account's remaining send capacity. |

#### 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 Sub-account SMTP Password

**Slug:** `MAIL_CHANNELS_DELETE_SUB_ACCOUNT_SMTP_PASSWORD`

Permanently revoke one sub-account SMTP password by exact sub-account handle and password ID. This explicit destructive credential deletion cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | integer | Yes | Exact provider-assigned ID of the SMTP password to revoke. |
| `handle` | string | Yes | Exact handle of the sub-account whose SMTP password will be revoked. |

#### 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 Suppression Entry

**Slug:** `MAIL_CHANNELS_DELETE_SUPPRESSION_ENTRY`

Destructively remove one source, or every source, of suppression protection for a recipient. This permits future matching email delivery to that recipient.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `source` | string ("api" | "unsubscribe_link" | "list_unsubscribe" | "hard_bounce" | "spam_complaint" | "all") | No | Suppression source to remove. Use all to remove every suppression entry for the recipient. |
| `recipient` | string | Yes | Recipient whose suppression protection will be removed. The recipient is URL-encoded as one path segment. |

#### 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 |

### Enroll Webhook

**Slug:** `MAIL_CHANNELS_ENROLL_WEBHOOK`

Enroll the account's single external endpoint for MailChannels event callbacks. This changes the webhook configuration and causes future events to be sent to that endpoint; delete the existing enrollment before replacing it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `endpoint` | string | Yes | URL to enroll for MailChannels event notifications. |

#### 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 Engagement Metrics

**Slug:** `MAIL_CHANNELS_GET_ENGAGEMENT_METRICS`

Retrieve account message open and click metrics, optionally filtered by time range and campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | string | No | Exclusive range end in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to the current time. |
| `interval` | string ("hour" | "day" | "week" | "month") | No | Time-series aggregation interval. |
| `start_time` | string | No | Inclusive range start in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to one month ago. |
| `campaign_id` | string | No | Campaign identifier to filter by; omit for all campaigns. |

#### 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 Performance Metrics

**Slug:** `MAIL_CHANNELS_GET_PERFORMANCE_METRICS`

Retrieve account processed, delivered, hard-bounced, and complaint metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | string | No | Exclusive range end in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to the current time. |
| `interval` | string ("hour" | "day" | "week" | "month") | No | Time-series aggregation interval. |
| `start_time` | string | No | Inclusive range start in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to one month ago. |
| `campaign_id` | string | No | Campaign identifier to filter by; omit for all campaigns. |

#### 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 Behaviour Metrics

**Slug:** `MAIL_CHANNELS_GET_RECIPIENT_BEHAVIOUR_METRICS`

Retrieve account recipient unsubscribe metrics, optionally filtered by time range and campaign.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | string | No | Exclusive range end in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to the current time. |
| `interval` | string ("hour" | "day" | "week" | "month") | No | Time-series aggregation interval. |
| `start_time` | string | No | Inclusive range start in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to one month ago. |
| `campaign_id` | string | No | Campaign identifier to filter by; omit for all campaigns. |

#### 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 Sub-account Limit

**Slug:** `MAIL_CHANNELS_GET_SUB_ACCOUNT_LIMIT`

Return a sub-account's configured monthly send limit; -1 means it inherits the parent account's remaining capacity.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account whose sending limit 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 Sub-account Usage

**Slug:** `MAIL_CHANNELS_GET_SUB_ACCOUNT_USAGE`

Return a sub-account's usage, effective monthly limit, and current billing-period dates.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account whose current billing-period usage 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 Usage

**Slug:** `MAIL_CHANNELS_GET_USAGE`

Return the connected account's usage, effective monthly limit, and current billing-period dates.

#### 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 Volume Metrics

**Slug:** `MAIL_CHANNELS_GET_VOLUME_METRICS`

Retrieve account processed, delivered, and dropped message volume metrics.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `end_time` | string | No | Exclusive range end in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to the current time. |
| `interval` | string ("hour" | "day" | "week" | "month") | No | Time-series aggregation interval. |
| `start_time` | string | No | Inclusive range start in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to one month ago. |
| `campaign_id` | string | No | Campaign identifier to filter by; omit for all campaigns. |

#### 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 Webhook Public Key

**Slug:** `MAIL_CHANNELS_GET_WEBHOOK_PUBLIC_KEY`

Retrieve the MailChannels public key identified by a webhook's Signature-Input header for signature verification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Signing-key ID from the webhook Signature-Input header. |

#### 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 Custom Tracking Domains

**Slug:** `MAIL_CHANNELS_LIST_CUSTOM_TRACKING_DOMAINS`

Return one page of custom domains registered for click tracking, open tracking, or unsubscribe links.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | Filter by custom tracking domain label. |
| `limit` | integer | No | Maximum custom tracking domains in this page (1-1000). |
| `scope` | string ("click" | "open" | "unsubscribe") | No | Filter by the event type handled by the domain. |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `status` | string ("active" | "disabled") | No | Filter by custom tracking domain status. |

#### 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 DKIM Keys

**Slug:** `MAIL_CHANNELS_LIST_DKIM_KEYS`

Return one page of DKIM keys for a domain, optionally filtered by selector or lifecycle status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum keys in this page (1-100). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `domain` | string | Yes | Domain whose MailChannels-managed DKIM keys to list. |
| `status` | string ("active" | "retired" | "revoked" | "rotated") | No | Lifecycle status to match. |
| `selector` | string | No | Exact DKIM selector to match (1-63 characters). |
| `include_dns_record` | boolean | No | Include the suggested DKIM DNS TXT record for each key. |

#### 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 Sender Metrics

**Slug:** `MAIL_CHANNELS_LIST_SENDER_METRICS`

Return one page of campaign or sub-account delivery metrics sorted by message volume.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum senders in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `offset` | integer | No | Number of matching senders to skip on the first page. |
| `end_time` | string | No | Exclusive range end in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to the current time. |
| `sort_order` | string ("asc" | "desc") | No | Sort by total processed plus dropped messages. |
| `start_time` | string | No | Inclusive range start in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format; defaults to one month ago. |
| `sender_type` | string ("campaigns" | "sub-accounts") | Yes | Group metrics by campaigns or sub-accounts. |

#### 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 Sub-account API Keys

**Slug:** `MAIL_CHANNELS_LIST_SUB_ACCOUNT_API_KEYS`

Return one page of API-key metadata for a sub-account. MailChannels redacts the key values. Returned provider-created keys are sub-account credentials, not connection authentication for this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum API keys in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor from a previous call; omit for the first page. |
| `handle` | string | Yes | Handle of the sub-account whose API-key metadata will be listed. |

#### 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 Sub-accounts

**Slug:** `MAIL_CHANNELS_LIST_SUB_ACCOUNTS`

Return one page of sub-accounts owned by the connected parent account, including handle, company name, and enabled state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum sub-accounts in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first 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 Sub-account SMTP Passwords

**Slug:** `MAIL_CHANNELS_LIST_SUB_ACCOUNT_SMTP_PASSWORDS`

List SMTP-password metadata for a sub-account. MailChannels returns only IDs and partially redacted passwords. These provider-created passwords are sub-account credentials, not connection authentication for this action.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account whose SMTP-password metadata will be listed. |

#### 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 Suppression Entries

**Slug:** `MAIL_CHANNELS_LIST_SUPPRESSION_ENTRIES`

Return one page of suppression entries for the connected account, optionally filtered by recipient, source, or creation date range.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum suppression entries in this page (1-1000). |
| `cursor` | string | No | Opaque continuation cursor returned by a previous call; omit for the first page. |
| `source` | string ("api" | "unsubscribe_link" | "list_unsubscribe" | "hard_bounce" | "spam_complaint") | No | Origin of the suppression entry to match. |
| `recipient` | string | No | Exact recipient whose suppression entries should be returned. |
| `created_after` | string | No | Return entries created after this date or UTC timestamp, formatted as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ. |
| `created_before` | string | No | Return entries created before this date or UTC timestamp, formatted as YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ. |

#### 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 Webhook Batches

**Slug:** `MAIL_CHANNELS_LIST_WEBHOOK_BATCHES`

Return one page of webhook delivery batches, optionally filtered by creation time, response category, or endpoint. If no time filters are supplied, MailChannels uses the last three days.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum webhook batches in this page (1-500). |
| `cursor` | string | No | Opaque continuation cursor from a previous call. It retains all filters and the page size; omit it for the first page. |
| `webhook` | string | No | Exact webhook endpoint to which events in each matching batch were posted. |
| `statuses` | array | No | Unique webhook response categories to match. MailChannels receives these as one comma-separated query value. |
| `created_after` | string | No | Inclusive UTC creation-time lower bound in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. The requested range cannot exceed 31 days. |
| `created_before` | string | No | Exclusive UTC creation-time upper bound in YYYY-MM-DD or YYYY-MM-DDTHH:MM:SSZ format. The requested range cannot exceed 31 days. |

#### 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 Webhooks

**Slug:** `MAIL_CHANNELS_LIST_WEBHOOKS`

List all webhook endpoints enrolled for the connected MailChannels 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 |

### Register Custom Tracking Domain

**Slug:** `MAIL_CHANNELS_REGISTER_CUSTOM_TRACKING_DOMAIN`

Register an owner-controlled hostname for click tracking, open tracking, or unsubscribe links. DNS TXT ownership verification and a CNAME to links.mailchannels.net may be required before registration completes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Unique label used to select this domain when sending a message. |
| `scope` | string ("click" | "open" | "unsubscribe") | Yes | Event type this custom tracking domain handles. |
| `hostname` | string | Yes | Hostname to register. It must have a CNAME record pointing to links.mailchannels.net. |

#### 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 |

### Render Email

**Slug:** `MAIL_CHANNELS_RENDER_EMAIL`

Render email content without delivering a message to any recipient. This action always uses MailChannels dry-run mode and has no delivery effect.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | object | Yes | Default sender address and optional display name. |
| `content` | array | Yes | Message bodies, such as text/plain and text/html content. |
| `headers` | object | No | Custom non-reserved message headers; merged headers may total at most 5 KB. |
| `subject` | string | Yes | Default subject; a personalization may override it. |
| `reply_to` | object | No | Default Reply-To address. |
| `attachments` | array | No | Attachments; total message size, including content and headers, must not exceed 30 MB. |
| `campaign_id` | string | No | Campaign identifier included in related webhooks; maximum 48 UTF-8 characters with no spaces. |
| `dkim_domain` | string | No | Default MailChannels-managed DKIM signing domain; requires dkim_selector. Caller-supplied private keys are intentionally unsupported because request bodies are logged. |
| `dkim_selector` | string | No | Default MailChannels-managed DKIM selector; uses the sender address domain when dkim_domain is omitted. |
| `envelope_from` | object | No | Default envelope sender; only its email value is used. |
| `transactional` | boolean | No | Whether messages are transactional. false requires DKIM and exactly one recipient per personalization. |
| `personalizations` | array | Yes | One or more messages, each with recipients and optional per-message overrides. |
| `tracking_settings` | object | No | Open and click tracking settings; tracking requires a supporting subscription. |
| `unsubscribe_settings` | object | No | Optional custom-domain setting for unsubscribe links. |

#### 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 |

### Resend Webhook Batch

**Slug:** `MAIL_CHANNELS_RESEND_WEBHOOK_BATCH`

Synchronously create one new external delivery attempt for an existing webhook batch. This sends events again to the batch's webhook endpoint. A successful action response means MailChannels completed the attempt, not that the endpoint returned a 2xx status; inspect status_code.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `batch_id` | integer | Yes | ID of the existing webhook batch to deliver again. This sends the batch's events to its external webhook endpoint. |

#### 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 |

### Rotate DKIM Key

**Slug:** `MAIL_CHANNELS_ROTATE_DKIM_KEY`

Irreversibly rotate an active DKIM key: mark the existing key as rotated and create a replacement key. Publish the returned replacement DNS record before the old key's signing grace period expires or DKIM validation may fail.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain whose active DKIM key will be rotated. |
| `new_key` | object | Yes | Replacement key configuration. MailChannels generates the key material. |
| `selector` | string | Yes | Selector of the active DKIM key to rotate (1-63 characters). |

#### 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

**Slug:** `MAIL_CHANNELS_SEND_EMAIL`

Deliver email to the specified recipients. This action always performs real, irreversible delivery and consumes recipient quota; use RENDER_EMAIL to preview without delivery.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | object | Yes | Default sender address and optional display name. |
| `content` | array | Yes | Message bodies, such as text/plain and text/html content. |
| `headers` | object | No | Custom non-reserved message headers; merged headers may total at most 5 KB. |
| `subject` | string | Yes | Default subject; a personalization may override it. |
| `reply_to` | object | No | Default Reply-To address. |
| `attachments` | array | No | Attachments; total message size, including content and headers, must not exceed 30 MB. |
| `campaign_id` | string | No | Campaign identifier included in related webhooks; maximum 48 UTF-8 characters with no spaces. |
| `dkim_domain` | string | No | Default MailChannels-managed DKIM signing domain; requires dkim_selector. Caller-supplied private keys are intentionally unsupported because request bodies are logged. |
| `dkim_selector` | string | No | Default MailChannels-managed DKIM selector; uses the sender address domain when dkim_domain is omitted. |
| `envelope_from` | object | No | Default envelope sender; only its email value is used. |
| `transactional` | boolean | No | Whether messages are transactional. false requires DKIM and exactly one recipient per personalization. |
| `personalizations` | array | Yes | One or more messages, each with recipients and optional per-message overrides. |
| `tracking_settings` | object | No | Open and click tracking settings; tracking requires a supporting subscription. |
| `unsubscribe_settings` | object | No | Optional custom-domain setting for unsubscribe links. |

#### 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 Asynchronously

**Slug:** `MAIL_CHANNELS_SEND_EMAIL_ASYNCHRONOUS`

Queue email for real, irreversible external delivery to the specified recipients. A successful response confirms queue acceptance only, not eventual delivery, and the operation consumes recipient quota.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `from` | object | Yes | Default sender address and optional display name. |
| `content` | array | Yes | Message bodies, such as text/plain and text/html content. |
| `headers` | object | No | Custom non-reserved message headers; merged headers may total at most 5 KB. |
| `subject` | string | Yes | Default subject; a personalization may override it. |
| `reply_to` | object | No | Default Reply-To address. |
| `attachments` | array | No | Attachments; total message size, including content and headers, must not exceed 30 MB. |
| `campaign_id` | string | No | Campaign identifier included in related webhooks; maximum 48 UTF-8 characters with no spaces. |
| `dkim_domain` | string | No | Default MailChannels-managed DKIM signing domain; requires dkim_selector. Caller-supplied private keys are intentionally unsupported because request bodies are logged. |
| `dkim_selector` | string | No | Default MailChannels-managed DKIM selector; uses the sender address domain when dkim_domain is omitted. |
| `envelope_from` | object | No | Default envelope sender; only its email value is used. |
| `transactional` | boolean | No | Whether messages are transactional. false requires DKIM and exactly one recipient per personalization. |
| `personalizations` | array | Yes | One or more messages, each with recipients and optional per-message overrides. |
| `tracking_settings` | object | No | Open and click tracking settings; tracking requires a supporting subscription. |
| `unsubscribe_settings` | object | No | Optional custom-domain setting for unsubscribe links. |

#### 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 Sub-account Limit

**Slug:** `MAIL_CHANNELS_SET_SUB_ACCOUNT_LIMIT`

Set a sub-account's monthly send limit; setting zero prevents it from sending.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sends` | integer | Yes | Maximum sends for the billing period. Setting this to 0 prevents the sub-account from sending through its quota. |
| `handle` | string | Yes | Handle of the sub-account whose sending limit to set. |

#### 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 |

### Suspend Sub-account

**Slug:** `MAIL_CHANNELS_SUSPEND_SUB_ACCOUNT`

Suspend a sub-account and immediately prevent it from sending email until it is explicitly reactivated. This is a service-affecting operation.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `handle` | string | Yes | Handle of the sub-account to suspend. Suspension immediately prevents the sub-account from sending email until it is explicitly reactivated. |

#### 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 Custom Tracking Domain

**Slug:** `MAIL_CHANNELS_UPDATE_CUSTOM_TRACKING_DOMAIN`

Change the label or active status of one custom tracking domain identified by its exact hostname and event scope. At least one of name or status is required. Reactivation may require DNS verification.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | No | New label for the custom tracking domain. Provide name, status, or both. |
| `scope` | string ("click" | "open" | "unsubscribe") | Yes | Event type identifying the custom tracking domain to update. |
| `status` | string ("active" | "disabled") | No | New custom tracking domain status. Provide status, name, or both. |
| `hostname` | string | Yes | Exact hostname of the custom tracking domain to update. |

#### 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 DKIM Key Status

**Slug:** `MAIL_CHANNELS_UPDATE_DKIM_KEY_STATUS`

Irreversibly revoke, retire, or begin rotating an existing DKIM key. This changes which key can sign mail and may require coordinated DNS changes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain of the DKIM key to change. |
| `status` | string ("revoked" | "retired" | "rotated") | Yes | New key status. revoked marks compromise; retired stops normal use; rotated starts the documented grace-period transition but does not create a replacement key. |
| `selector` | string | Yes | Selector of the DKIM key to change (1-63 characters). |

#### 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 |

### Validate All Webhooks

**Slug:** `MAIL_CHANNELS_VALIDATE_ALL_WEBHOOKS`

Create and send a test callback to every enrolled webhook endpoint, then report whether each endpoint returned a 2xx response. This has an external side effect: every enrolled endpoint receives a test event.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `request_id` | string | No | Optional identifier to include in each test webhook payload. MailChannels generates one when 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 |
