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

# Elastic Email

Elastic Email provides transactional email delivery, email marketing, contact and campaign management, reporting, verification, and account administration APIs.

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

## Tools

### Add Contact List Members

**Slug:** `ELASTIC_EMAIL_ADD_CONTACT_LIST_MEMBERS`

Add selected existing contacts to a named Elastic Email contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the contact list to update. |
| `members` | object | Yes | Existing contacts selected by either one rule or a list of email addresses. |

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

**Slug:** `ELASTIC_EMAIL_ADD_CONTACTS`

Add up to 1000 Elastic Email contacts and optionally assign them to existing lists.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `contacts` | array | Yes | Contacts to add. Each contact requires Email; a request may contain at most 1000 contacts. |
| `list_names` | array | No | Existing contact list names to which all added contacts should be assigned. |

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

**Slug:** `ELASTIC_EMAIL_ADD_SUPPRESSIONS`

Add up to 1000 email addresses to Elastic Email's bounce, complaint, or unsubscribe suppression records.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Email addresses to suppress; Elastic Email limits each request to 1000 addresses. |
| `reason` | string ("bounce" | "complaint" | "unsubscribe") | Yes | Suppression reason to record for every provided email address. |

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

### Adjust Subaccount Credits

**Slug:** `ELASTIC_EMAIL_ADJUST_SUBACCOUNT_CREDITS`

Add or remove email credits from a managed Elastic Email subaccount. Requires an Elastic Email PRO plan. The signed adjustment is not idempotent; a retry can apply the adjustment twice.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Login email address of the managed subaccount. |
| `adjustment` | object | Yes | Credit amount to add or remove and an optional history note. |

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

**Slug:** `ELASTIC_EMAIL_CHECK_DOMAIN_RESTRICTED`

Check whether Elastic Email restricts a domain or identifies it as a free-provider domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Domain name to check for provider or policy restrictions. |

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

**Slug:** `ELASTIC_EMAIL_CREATE_CAMPAIGN`

Create a campaign. An active or scheduled campaign may initiate email delivery, and sent messages cannot be recalled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign` | object | Yes | Campaign definition. Name and Recipients are 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 Contact List

**Slug:** `ELASTIC_EMAIL_CREATE_CONTACT_LIST`

Create a contact list, optionally with initial email members.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `list` | object | Yes | Contact list name, unsubscribe setting, and optional initial members. |

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

**Slug:** `ELASTIC_EMAIL_CREATE_DOMAIN`

Create a sending or tracking domain in the connected Elastic Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | object | Yes | Domain name and optional default-domain 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 |

### Create Inbound Route

**Slug:** `ELASTIC_EMAIL_CREATE_INBOUND_ROUTE`

Create a new inbound email route.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route` | object | Yes | Complete definition for the new inbound route. |

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

**Slug:** `ELASTIC_EMAIL_CREATE_SEGMENT`

Create a dynamic contact segment from a name and SQL-like rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment` | object | Yes | Complete segment definition containing the required Name and Rule. |

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

**Slug:** `ELASTIC_EMAIL_CREATE_SUBACCOUNT`

Create a managed subaccount with optional initial email settings. An activation email can be sent; when activation email delivery is disabled, the subaccount is activated immediately. Requires an Elastic Email PRO plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount` | object | Yes | New subaccount credentials, activation behavior, and initial settings. |

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

**Slug:** `ELASTIC_EMAIL_CREATE_TEMPLATE`

Create a new email template with its name, content, and scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | Complete template definition. Name 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 Webhook

**Slug:** `ELASTIC_EMAIL_CREATE_WEBHOOK`

Create a webhook subscription for selected email events.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `webhook` | object | Yes | Webhook name, callback URL, and email event notification settings. |

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

**Slug:** `ELASTIC_EMAIL_DELETE_CAMPAIGN`

Delete one campaign by exact name. This does not cancel email already in progress.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact campaign name 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 Contact

**Slug:** `ELASTIC_EMAIL_DELETE_CONTACT`

Delete one contact by exact email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Exact contact email address 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 Contact List

**Slug:** `ELASTIC_EMAIL_DELETE_CONTACT_LIST`

Delete one contact list by exact name. Contacts that belonged to the list are removed from it but are not deleted.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the contact list 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 Contacts

**Slug:** `ELASTIC_EMAIL_DELETE_CONTACTS`

Permanently delete 1-10 contacts by exact email address. This destructive action sends one targeted deletion per address and reports partial failures; it does not use rule-based bulk deletion.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `emails` | array | Yes | Exact email addresses of contacts to permanently delete. Pass 1-10 unique addresses. Each address is deleted with a separate targeted request. |

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

**Slug:** `ELASTIC_EMAIL_DELETE_DOMAIN`

Delete one configured domain from the connected Elastic Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact configured domain 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 Email Verification

**Slug:** `ELASTIC_EMAIL_DELETE_EMAIL_VERIFICATION`

Delete one saved email verification result by exact email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address whose saved verification result 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 File

**Slug:** `ELASTIC_EMAIL_DELETE_FILE`

Permanently delete one stored file by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact stored file name, including its extension, 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 Inbound Route

**Slug:** `ELASTIC_EMAIL_DELETE_INBOUND_ROUTE`

Permanently delete one inbound email route by its public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public ID of the inbound route 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 Segment

**Slug:** `ELASTIC_EMAIL_DELETE_SEGMENT`

Delete one Elastic Email dynamic contact segment by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the dynamic segment 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 Suppression

**Slug:** `ELASTIC_EMAIL_DELETE_SUPPRESSION`

Remove one email address from Elastic Email suppression records. This can allow sending to resume, so use only with documented recipient consent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Exact suppressed email address to remove. |

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

**Slug:** `ELASTIC_EMAIL_DELETE_TEMPLATE`

Delete one Elastic Email template by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the template 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 Verification File

**Slug:** `ELASTIC_EMAIL_DELETE_VERIFICATION_FILE`

Delete one uploaded verification file job by its VerificationID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | VerificationID of the uploaded verification file job 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 Webhook

**Slug:** `ELASTIC_EMAIL_DELETE_WEBHOOK`

Delete one webhook subscription by its public WebhookID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `public_id` | string | Yes | WebhookID of the webhook subscription 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 |

### Download File

**Slug:** `ELASTIC_EMAIL_DOWNLOAD_FILE`

Download a stored Elastic Email file by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact stored file name, including its extension. |

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

### Download Verification File Results

**Slug:** `ELASTIC_EMAIL_DOWNLOAD_VERIFICATION_FILE_RESULTS`

Download the ZIP result archive for a completed verification file job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Identifier of the completed verification file job. |

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

**Slug:** `ELASTIC_EMAIL_GET_CAMPAIGN`

Return one Elastic Email campaign by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the campaign 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 Contact

**Slug:** `ELASTIC_EMAIL_GET_CONTACT`

Return one Elastic Email contact by email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the contact 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 Contact Export Status

**Slug:** `ELASTIC_EMAIL_GET_CONTACT_EXPORT_STATUS`

Get the current status of an asynchronous contact export job.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public export ID returned by Start Contact Export. |

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

**Slug:** `ELASTIC_EMAIL_GET_CONTACT_LIST`

Return one Elastic Email contact list by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the contact list 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 Credential Metadata

**Slug:** `ELASTIC_EMAIL_GET_CREDENTIAL_METADATA`

Get one Elastic Email API-key or SMTP credential's audit metadata without returning its secret token.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the API key or SMTP credential. |
| `subaccount` | string | No | Subaccount email whose credential should be returned. Omit for the main account. |
| `credential_type` | string ("api_key" | "smtp") | Yes | Credential family to inspect: `api_key` or `smtp`. |

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

**Slug:** `ELASTIC_EMAIL_GET_DOMAIN`

Return detailed DNS and certificate state for one Elastic Email domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact domain name 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 Email Job Status

**Slug:** `ELASTIC_EMAIL_GET_EMAIL_JOB_STATUS`

Return delivery status and optional recipient-level details for an Elastic Email transaction.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `show_sent` | boolean | No | Include sent recipients. |
| `show_abuse` | boolean | No | Include abuse reports. |
| `show_errors` | boolean | No | Include error details for failed recipients. |
| `show_failed` | boolean | No | Include failed recipient details. |
| `show_opened` | boolean | No | Include opened recipients. |
| `show_clicked` | boolean | No | Include clicked recipients. |
| `show_pending` | boolean | No | Include pending recipients. |
| `show_delivered` | boolean | No | Include delivered recipients. |
| `transaction_id` | string | Yes | Transaction ID returned by an email send. |
| `show_message_ids` | boolean | No | Include message IDs. |
| `show_unsubscribed` | boolean | No | Include unsubscribed recipients. |

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

**Slug:** `ELASTIC_EMAIL_GET_EMAIL_PREVIEW`

Return the rendered preview, attachment metadata, and delivery status for an Elastic Email message ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message_id` | string | Yes | Message ID returned by an email send or delivery report. |

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

**Slug:** `ELASTIC_EMAIL_GET_EMAIL_VERIFICATION`

Return the saved Elastic Email verification result for one email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address whose saved verification result 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 Event Export Status

**Slug:** `ELASTIC_EMAIL_GET_EVENT_EXPORT_STATUS`

Get the current status of an asynchronous global or channel event export. Use export_scope='global' when Start Event Export had no channel, and export_scope='channel' when it targeted a channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public export ID returned by Start Event Export. Set export_scope to match whether that export was global or channel-specific. |
| `export_scope` | string ("global" | "channel") | Yes | Export collection that created the ID: `global` for an export started without a channel, or `channel` for an export started for one channel. |

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

**Slug:** `ELASTIC_EMAIL_GET_FILE_INFO`

Return metadata for a stored Elastic Email file without downloading it.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact stored file name, including its extension. |

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

**Slug:** `ELASTIC_EMAIL_GET_INBOUND_ROUTE`

Return one Elastic Email inbound route by its public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Public ID of the inbound route 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 Segment

**Slug:** `ELASTIC_EMAIL_GET_SEGMENT`

Return one Elastic Email dynamic contact segment by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the segment to return. Use 'All Contacts' to return the built-in all-contacts 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 |

### Get Account Statistics

**Slug:** `ELASTIC_EMAIL_GET_STATISTICS`

Return aggregate Elastic Email delivery statistics for a time interval.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Optional RFC 3339 interval end. |
| `from` | string | Yes | Required RFC 3339 UTC interval start. |

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

**Slug:** `ELASTIC_EMAIL_GET_STATISTICS_BREAKDOWN`

Return one Elastic Email campaign or channel delivery summary by exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact campaign or channel name. |
| `breakdown` | string ("campaign" | "channel") | Yes | Statistics dimension containing the named item: `campaign` or `channel`. |

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

**Slug:** `ELASTIC_EMAIL_GET_SUBACCOUNT`

Return one managed Elastic Email subaccount by its login email. Requires an Elastic Email PRO plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Login email address of the managed subaccount 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 Suppression

**Slug:** `ELASTIC_EMAIL_GET_SUPPRESSION`

Return suppression details for one Elastic Email address.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Suppressed email address 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 Template

**Slug:** `ELASTIC_EMAIL_GET_TEMPLATE`

Return one Elastic Email template by its exact name.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the template 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 Verification File Results

**Slug:** `ELASTIC_EMAIL_GET_VERIFICATION_FILE_RESULTS`

Return one page of detailed results and metadata for a verification file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | No | Identifier of the verification file job. |
| `limit` | integer | No | Maximum result rows to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior Get Verification File Results call. Omit it 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 |

### Get Webhook

**Slug:** `ELASTIC_EMAIL_GET_WEBHOOK`

Return one Elastic Email webhook subscription by its public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `public_id` | string | Yes | Public webhook ID returned by Create Webhook or List Webhooks. |

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

**Slug:** `ELASTIC_EMAIL_IMPORT_CONTACTS`

Start an asynchronous contact import using exactly one source: an uploaded CSV file or a provider-accessible CSV URL.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file_url` | string | No | Publicly accessible URL of a CSV file for Elastic Email to import. Provide exactly one of file_url or csv_content. |
| `filename` | string | No | Filename for inline CSV content. Defaults to contacts.csv. |
| `list_name` | string | No | Name of an existing contact list to receive the imported contacts. |
| `csv_content` | string | No | Inline UTF-8 CSV content to upload. The Email column is required; supported contact columns include AllowUnsubscribe, Status, ConsentDate, ConsentIP, and ConsentTracking. Provide exactly one of csv_content or file_url. |
| `encoding_name` | string | No | Character encoding of the CSV file. |

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

**Slug:** `ELASTIC_EMAIL_IMPORT_SUPPRESSIONS`

Upload CSV content containing bounced, complained, or unsubscribed email addresses for asynchronous suppression import.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `reason` | string ("bounce" | "complaint" | "unsubscribe") | Yes | Suppression reason represented by the uploaded email addresses. |
| `filename` | string | No | Filename for the CSV content. Defaults to suppressions.csv. |
| `csv_content` | string | Yes | UTF-8 CSV content containing the email addresses to suppress. |

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

**Slug:** `ELASTIC_EMAIL_LIST_CAMPAIGNS`

Find campaigns by optional name fragment and return one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum campaigns in this page; Elastic Email returns at most 1000 campaigns total. |
| `search` | string | No | Campaign-name fragment matched with contains semantics. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Campaigns call. |

#### 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 Contact List Members

**Slug:** `ELASTIC_EMAIL_LIST_CONTACT_LIST_MEMBERS`

Return one page of contacts in a named Elastic Email contact list.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contacts in this page. |
| `list_name` | string | No | Exact contact list name. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Contact List Members call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_CONTACT_LISTS`

Return one page of contact lists from the connected Elastic Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contact lists in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Contact Lists call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_CONTACTS`

Return one page of contacts from the connected Elastic Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum contacts in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Contacts call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_CREDENTIAL_METADATA`

List API-key or SMTP credential metadata without returning secret tokens.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `subaccount` | string | No | Optional subaccount email whose credentials to list. |
| `credential_type` | string ("api_key" | "smtp") | Yes | Credential family to list. Choose `api_key` or `smtp`. |

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

**Slug:** `ELASTIC_EMAIL_LIST_DOMAINS`

Return all sending and tracking domains configured for the 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 Email Verifications

**Slug:** `ELASTIC_EMAIL_LIST_EMAIL_VERIFICATIONS`

Return one page of individual email verification results.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum verification results in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Email Verifications call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_FILES`

Return one page of stored files and metadata.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum files to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Files call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_INBOUND_ROUTES`

Return all inbound email routing rules in their current order.

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

**Slug:** `ELASTIC_EMAIL_LIST_SEGMENTS`

Return one page of dynamic contact segments.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum segments in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Segments call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_STATISTICS_BREAKDOWNS`

Return one page of campaign or channel delivery summaries.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum summaries in this page. |
| `breakdown` | string ("campaign" | "channel") | No | Dimension to summarize: campaign or channel. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Statistics Breakdowns call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_SUBACCOUNTS`

Return one page of managed subaccounts without credentials or passwords. Requires an Elastic Email PRO plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum subaccounts in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Subaccounts call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_SUPPRESSIONS`

Return one page of all suppressed addresses or only addresses suppressed for bounce, complaint, or unsubscribe reasons.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum suppressions in this page. |
| `reason` | string ("all" | "bounce" | "complaint" | "unsubscribe") | No | Suppression collection to list: `all` for every suppression, or `bounce`, `complaint`, or `unsubscribe` for one reason. |
| `search` | string | No | Email address fragment to search for. Valid only when reason is `bounce`, `complaint`, or `unsubscribe`; omit it when reason is `all`. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Suppressions call. |

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

**Slug:** `ELASTIC_EMAIL_LIST_TEMPLATES`

Return one page of templates for the required visibility scopes.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum templates to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Templates call. |
| `scope_types` | array | No | One or more template scopes. This field is required by Elastic Email; Personal and Global are accepted. |
| `template_types` | array | No | Template types to include; omit to include every type in the selected scopes. |

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

**Slug:** `ELASTIC_EMAIL_LIST_VERIFICATION_FILES`

Return all uploaded verification file jobs and their current statuses.

#### 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:** `ELASTIC_EMAIL_LIST_WEBHOOKS`

Return one page of webhook subscriptions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `limit` | integer | No | Maximum webhooks to return in this page. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior List Webhooks call. |

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

### Pause Campaign

**Slug:** `ELASTIC_EMAIL_PAUSE_CAMPAIGN`

Pause an active Elastic Email campaign by exact name, cancelling messages that are still waiting to be sent.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the active campaign to pause. |

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

### Remove Contact List Members

**Slug:** `ELASTIC_EMAIL_REMOVE_CONTACT_LIST_MEMBERS`

Remove selected contacts from a named Elastic Email contact list without deleting the contacts.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the contact list to update. |
| `members` | object | Yes | Contacts selected by either one rule or a list of email addresses. |

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

### Reorder Inbound Routes

**Slug:** `ELASTIC_EMAIL_REORDER_INBOUND_ROUTES`

Set the processing order of Elastic Email inbound routing rules.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `order` | array | Yes | Route order entries, each containing a public inbound route ID and its desired position. |

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

### Search Delivery Events

**Slug:** `ELASTIC_EMAIL_SEARCH_EVENTS`

Search all delivery events, one transaction's events, or one channel's events and return one page.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Inclusive RFC 3339 end time. |
| `from` | string | No | Inclusive RFC 3339 start time. |
| `limit` | integer | No | Maximum events in this page (1-1000). |
| `scope` | string ("all" | "transaction" | "channel") | No | Event collection to search: all events, one transaction, or one channel. |
| `order_by` | string ("DateDescending" | "DateAscending") | No | Sort events by date ascending or descending. |
| `event_types` | array | No | Event types to include. Supported by all-event and channel searches. |
| `next_cursor` | string | No | Opaque continuation cursor returned by a prior Search Delivery Events call. |
| `scope_value` | string | No | Transaction ID or channel name; required for transaction and channel searches. |

#### 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:** `ELASTIC_EMAIL_SEND_EMAIL`

Send an email to one or more recipients using inline content or a saved template. Submission causes external delivery and cannot be recalled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | Email message to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible. |

#### 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 Merge File Email

**Slug:** `ELASTIC_EMAIL_SEND_MERGE_FILE_EMAIL`

Send personalized email to recipients listed in a CSV merge-data file. Submission causes external delivery and cannot be recalled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | Merge-file email to submit. Its CSV rows determine the recipients, and submission causes external delivery that cannot be recalled. |

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

**Slug:** `ELASTIC_EMAIL_SEND_TRANSACTIONAL_EMAIL`

Send one transactional message with To, CC, and BCC recipient groups. Submission causes external delivery and cannot be recalled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `message` | object | Yes | Transactional email to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible. |

#### 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 Default Sender Domain

**Slug:** `ELASTIC_EMAIL_SET_DEFAULT_SENDER_DOMAIN`

Set the domain of a verified sender email as the account default.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Verified sender email whose domain should become the account 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 |

### Start Contact Export

**Slug:** `ELASTIC_EMAIL_START_CONTACT_EXPORT`

Start an asynchronous export of all contacts or contacts selected by one filter rule or a list of email addresses.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `rule` | string | No | Elastic Email contact filter rule. Do not provide this together with emails; omit both to export all contacts. |
| `emails` | array | No | Contact email addresses to export. Do not provide this together with rule; a list or comma-separated string is accepted. |
| `file_name` | string | No | Requested export file name, including its extension. |
| `file_format` | string ("Csv" | "Xml" | "Json") | No | Export file format. Elastic Email defaults to Csv when omitted. |
| `compression_format` | string ("None" | "Zip") | No | Archive compression format. Elastic Email defaults to None 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 |

### Start Event Export

**Slug:** `ELASTIC_EMAIL_START_EVENT_EXPORT`

Start an asynchronous export for all events or one channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `to` | string | No | Inclusive end time in RFC 3339 format. |
| `from` | string | No | Inclusive start time in RFC 3339 format. |
| `file_name` | string | No | Requested export file name, including its extension. |
| `event_types` | array | No | Event types to include; a list or comma-separated string is accepted. |
| `file_format` | string ("Csv" | "Xml" | "Json") | No | Export file format. Elastic Email defaults to Csv when omitted. |
| `channel_name` | string | No | Channel to export; omit to export events across all channels. |
| `compression_format` | string ("None" | "Zip") | No | Archive compression format. Elastic Email defaults to None 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 |

### Start Verification File

**Slug:** `ELASTIC_EMAIL_START_VERIFICATION_FILE`

Start bulk verification for a previously uploaded CSV file. File verification is unavailable on free plans and with subaccount API keys. Usage consumes the monthly plan allowance, which resets monthly and cannot be restored.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `id` | string | Yes | Verification ID returned by Upload Verification File. |

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

### Trigger Campaign Automation

**Slug:** `ELASTIC_EMAIL_TRIGGER_AUTOMATION`

Enter one contact email into an irreversible automation that may send email or execute later steps and cannot be undone.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Exact name of the automation campaign to trigger. |
| `contact_email` | string | Yes | Email address of the contact that will enter the automation. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_CAMPAIGN`

Update an existing active or paused campaign. Changes may initiate email delivery, and sent messages cannot be recalled.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `campaign` | object | Yes | Complete replacement campaign definition. Name and Recipients are required. |
| `current_name` | string | Yes | Exact name of the existing active or paused campaign 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 Contact

**Slug:** `ELASTIC_EMAIL_UPDATE_CONTACT`

Update the first name, last name, or custom fields for one Elastic Email contact.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address of the contact to update. |
| `updates` | object | Yes | Contact changes. Provide at least one of FirstName, LastName, or CustomFields; omitted fields remain unchanged. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_CONTACT_LIST`

Update an Elastic Email contact list by providing at least one change: rename it with NewListName or change whether contacts may unsubscribe with AllowUnsubscribe.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `name` | string | Yes | Current exact name of the contact list to update. |
| `updates` | object | Yes | Contact-list changes. Provide at least one of NewListName or AllowUnsubscribe; omitted fields remain unchanged. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_DOMAIN`

Update certificate, VERP, or custom bounce settings for an Elastic Email domain.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Exact domain name to update. |
| `updates` | object | Yes | Domain changes. Provide at least one of CertificateStatus, VERP, CustomBouncesDomain, or IsCustomBouncesDomainDefault; omitted fields are not sent. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_INBOUND_ROUTE`

Replace an existing inbound route definition by public ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `route` | object | Yes | Complete replacement definition for the inbound route. |
| `current_id` | string | Yes | Public ID of the existing inbound route to replace. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_SEGMENT`

Replace an existing dynamic contact segment's name and rule.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `segment` | object | Yes | Complete replacement segment definition containing Name and Rule. |
| `current_name` | string | Yes | Exact name of the existing segment to replace. |

#### 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 Subaccount Email Settings

**Slug:** `ELASTIC_EMAIL_UPDATE_SUBACCOUNT_EMAIL_SETTINGS`

Replace email limits and sender settings for a managed subaccount. Requires an Elastic Email PRO plan.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Login email address of the managed subaccount. |
| `settings` | object | Yes | Email-setting changes. Provide at least one nested email credit, sending limit, contact limit, IP pool, or sender-domain 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 Template

**Slug:** `ELASTIC_EMAIL_UPDATE_TEMPLATE`

Replace an existing email template's name, content, and scope.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `template` | object | Yes | Complete replacement template definition. Name is required. |
| `current_name` | string | Yes | Exact name of the existing template to replace. |

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

**Slug:** `ELASTIC_EMAIL_UPDATE_WEBHOOK`

Update a webhook URL, event notification flags, name, or enabled state.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `updates` | object | Yes | Webhook changes. Provide at least one nested property, such as Name, URL, an event-notification flag, or IsEnabled; omitted properties are not sent. |
| `public_id` | string | Yes | Public WebhookID returned by a create, get, or list webhook call. |

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

### Upload File

**Slug:** `ELASTIC_EMAIL_UPLOAD_FILE`

Store a base64-encoded file in the connected Elastic Email account.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `file` | object | Yes | Base64-encoded file content and optional file metadata. |
| `expires_after_days` | integer | No | Number of days to retain the stored file; omit to use the provider 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 |

### Upload Verification File

**Slug:** `ELASTIC_EMAIL_UPLOAD_VERIFICATION_FILE`

Upload a CSV containing an email column for a later bulk verification job. This action uploads the file but does not start verification. File verification jobs are unavailable on free plans and with subaccount API keys.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `filename` | string | No | Filename for the CSV content. Defaults to verification.csv. |
| `csv_content` | string | Yes | UTF-8 CSV content to upload. It must contain a column named email. |

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

### Verify Domain

**Slug:** `ELASTIC_EMAIL_VERIFY_DOMAIN`

Ask Elastic Email to re-check a domain's DNS configuration.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `domain` | string | Yes | Configured domain to verify. |
| `tracking_type` | string ("None" | "Delete" | "Http" | "ExternalHttps" | "InternalCertHttps" | "LetsEncryptCert") | Yes | Tracking protocol and certificate mode to validate for the 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 |

### Verify Email

**Slug:** `ELASTIC_EMAIL_VERIFY_EMAIL`

Run verification for one email address and return its deliverability assessment. Verification is unavailable with subaccount API keys. Free plans support only this single-address verification, not file jobs. Usage consumes the monthly plan allowance, which resets monthly and cannot be restored.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `email` | string | Yes | Email address to verify. |

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