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

# Elastic Email

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

![Elastic Email logo](https://mintcdn.com/composio-preview/r7CO9m4_UWMVFnU7/images/toolkits/elastic_email.svg?fit=max\&auto=format\&n=r7CO9m4_UWMVFnU7\&q=85\&s=02f8a142d49e93b21610cc0b9dc1c469)

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

## Tools

> [accordion] Add Contact List Members
>
> **Slug:** `ELASTIC_EMAIL_ADD_CONTACT_LIST_MEMBERS`
>
> Add selected existing contacts to a named Elastic Email contact list.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the contact list to update.
>
> **members** `object` *required*
>
> Existing contacts selected by either one rule or a list of email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Contacts
>
> **Slug:** `ELASTIC_EMAIL_ADD_CONTACTS`
>
> Add up to 1000 Elastic Email contacts and optionally assign them to existing lists.
>
> #### Input Parameters
>
> **contacts** `array` *required*
>
> Contacts to add. Each contact requires Email; a request may contain at most 1000 contacts.
>
> **list\_names** `array`
>
> Existing contact list names to which all added contacts should be assigned.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **emails** `array` *required*
>
> Email addresses to suppress; Elastic Email limits each request to 1000 addresses.
>
> **reason** `string ("bounce" | "complaint" | "unsubscribe")` *required*
>
> Suppression reason to record for every provided email address.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string` *required*
>
> Login email address of the managed subaccount.
>
> **adjustment** `object` *required*
>
> Credit amount to add or remove and an optional history note.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **domain** `string` *required*
>
> Domain name to check for provider or policy restrictions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create 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
>
> **campaign** `object` *required*
>
> Campaign definition. Name and Recipients are required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Contact List
>
> **Slug:** `ELASTIC_EMAIL_CREATE_CONTACT_LIST`
>
> Create a contact list with existing contacts selected by email. If the email list is left empty, all contacts are included.
>
> #### Input Parameters
>
> **list** `object` *required*
>
> Contact list name, unsubscribe setting, and optional initial members.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Domain
>
> **Slug:** `ELASTIC_EMAIL_CREATE_DOMAIN`
>
> Create a sending or tracking domain in the connected Elastic Email account, optionally setting it as the default domain.
>
> #### Input Parameters
>
> **domain** `object` *required*
>
> Domain name and optional default-domain setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Inbound Route
>
> **Slug:** `ELASTIC_EMAIL_CREATE_INBOUND_ROUTE`
>
> Create a new inbound email route.
>
> #### Input Parameters
>
> **route** `object` *required*
>
> Complete definition for the new inbound route.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Segment
>
> **Slug:** `ELASTIC_EMAIL_CREATE_SEGMENT`
>
> Create a dynamic contact segment from a name and SQL-like rule.
>
> #### Input Parameters
>
> **segment** `object` *required*
>
> Complete segment definition containing the required Name and Rule.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create 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
>
> **subaccount** `object` *required*
>
> New subaccount credentials, activation behavior, and initial settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template
>
> **Slug:** `ELASTIC_EMAIL_CREATE_TEMPLATE`
>
> Create a new email template with its name, content, and scope.
>
> #### Input Parameters
>
> **template** `object` *required*
>
> Complete template definition. Name is required.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Webhook
>
> **Slug:** `ELASTIC_EMAIL_CREATE_WEBHOOK`
>
> Create a webhook subscription for selected email events.
>
> #### Input Parameters
>
> **webhook** `object` *required*
>
> Webhook name, callback URL, and email event notification settings.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Campaign
>
> **Slug:** `ELASTIC_EMAIL_DELETE_CAMPAIGN`
>
> Delete one campaign by exact name. This does not cancel email already in progress.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact campaign name to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Contact
>
> **Slug:** `ELASTIC_EMAIL_DELETE_CONTACT`
>
> Delete one contact by exact email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Exact contact email address to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete 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
>
> **name** `string` *required*
>
> Exact name of the contact list to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete 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
>
> **emails** `array` *required*
>
> Exact email addresses of contacts to permanently delete. Pass 1-10 unique addresses. Each address is deleted with a separate targeted request.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Domain
>
> **Slug:** `ELASTIC_EMAIL_DELETE_DOMAIN`
>
> Delete one configured domain from the connected Elastic Email account.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Exact configured domain to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Email Verification
>
> **Slug:** `ELASTIC_EMAIL_DELETE_EMAIL_VERIFICATION`
>
> Delete one saved email verification result by exact email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address whose saved verification result to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete File
>
> **Slug:** `ELASTIC_EMAIL_DELETE_FILE`
>
> Permanently delete one stored file by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact stored file name, including its extension, to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Inbound Route
>
> **Slug:** `ELASTIC_EMAIL_DELETE_INBOUND_ROUTE`
>
> Permanently delete one inbound email route by its public ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Public ID of the inbound route to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Segment
>
> **Slug:** `ELASTIC_EMAIL_DELETE_SEGMENT`
>
> Delete one Elastic Email dynamic contact segment by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the dynamic segment to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete 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
>
> **email** `string` *required*
>
> Exact suppressed email address to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Template
>
> **Slug:** `ELASTIC_EMAIL_DELETE_TEMPLATE`
>
> Delete one Elastic Email template by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the template to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Verification File
>
> **Slug:** `ELASTIC_EMAIL_DELETE_VERIFICATION_FILE`
>
> Delete one uploaded verification file job by its VerificationID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> VerificationID of the uploaded verification file job to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Webhook
>
> **Slug:** `ELASTIC_EMAIL_DELETE_WEBHOOK`
>
> Delete one webhook subscription by its public WebhookID.
>
> #### Input Parameters
>
> **public\_id** `string` *required*
>
> WebhookID of the webhook subscription to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download File
>
> **Slug:** `ELASTIC_EMAIL_DOWNLOAD_FILE`
>
> Download a stored Elastic Email file by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact stored file name, including its extension.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Verification File Results
>
> **Slug:** `ELASTIC_EMAIL_DOWNLOAD_VERIFICATION_FILE_RESULTS`
>
> Download the ZIP result archive for a completed verification file job.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Identifier of the completed verification file job.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Campaign
>
> **Slug:** `ELASTIC_EMAIL_GET_CAMPAIGN`
>
> Return one Elastic Email campaign by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the campaign to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact
>
> **Slug:** `ELASTIC_EMAIL_GET_CONTACT`
>
> Return one Elastic Email contact by email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address of the contact to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact Export Status
>
> **Slug:** `ELASTIC_EMAIL_GET_CONTACT_EXPORT_STATUS`
>
> Get the current status of an asynchronous contact export job.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Public export ID returned by Start Contact Export.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Contact List
>
> **Slug:** `ELASTIC_EMAIL_GET_CONTACT_LIST`
>
> Return one Elastic Email contact list by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the contact list to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get 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
>
> **name** `string` *required*
>
> Exact name of the API key or SMTP credential.
>
> **subaccount** `string`
>
> Subaccount email whose credential should be returned. Omit for the main account.
>
> **credential\_type** `string ("api_key" | "smtp")` *required*
>
> Credential family to inspect: `api_key` or `smtp`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Domain
>
> **Slug:** `ELASTIC_EMAIL_GET_DOMAIN`
>
> Return detailed DNS and certificate state for one Elastic Email domain.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Exact domain name to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Job Status
>
> **Slug:** `ELASTIC_EMAIL_GET_EMAIL_JOB_STATUS`
>
> Return delivery status and optional recipient-level details for an Elastic Email transaction.
>
> #### Input Parameters
>
> **show\_sent** `boolean`
>
> Include sent recipients.
>
> **show\_abuse** `boolean`
>
> Include abuse reports.
>
> **show\_errors** `boolean`
>
> Include error details for failed recipients.
>
> **show\_failed** `boolean`
>
> Include failed recipient details.
>
> **show\_opened** `boolean`
>
> Include opened recipients.
>
> **show\_clicked** `boolean`
>
> Include clicked recipients.
>
> **show\_pending** `boolean`
>
> Include pending recipients.
>
> **show\_delivered** `boolean`
>
> Include delivered recipients.
>
> **transaction\_id** `string` *required*
>
> Transaction ID returned by an email send.
>
> **show\_message\_ids** `boolean`
>
> Include message IDs.
>
> **show\_unsubscribed** `boolean`
>
> Include unsubscribed recipients.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Preview
>
> **Slug:** `ELASTIC_EMAIL_GET_EMAIL_PREVIEW`
>
> Return the rendered preview, attachment metadata, and delivery status for an Elastic Email message ID.
>
> #### Input Parameters
>
> **message\_id** `string` *required*
>
> Message ID returned by an email send or delivery report.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Email Verification
>
> **Slug:** `ELASTIC_EMAIL_GET_EMAIL_VERIFICATION`
>
> Return the saved Elastic Email verification result for one email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address whose saved verification result to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Event 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
>
> **id** `string` *required*
>
> 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")` *required*
>
> Export collection that created the ID: `global` for an export started without a channel, or `channel` for an export started for one channel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get File Info
>
> **Slug:** `ELASTIC_EMAIL_GET_FILE_INFO`
>
> Return metadata for a stored Elastic Email file without downloading it.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact stored file name, including its extension.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Inbound Route
>
> **Slug:** `ELASTIC_EMAIL_GET_INBOUND_ROUTE`
>
> Return one Elastic Email inbound route by its public ID.
>
> #### Input Parameters
>
> **id** `string` *required*
>
> Public ID of the inbound route to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Segment
>
> **Slug:** `ELASTIC_EMAIL_GET_SEGMENT`
>
> Return one Elastic Email dynamic contact segment by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the segment to return. Use 'All Contacts' to return the built-in all-contacts segment.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Account Statistics
>
> **Slug:** `ELASTIC_EMAIL_GET_STATISTICS`
>
> Return aggregate Elastic Email delivery statistics for a time interval.
>
> #### Input Parameters
>
> **to** `string`
>
> Optional RFC 3339 interval end.
>
> **from** `string` *required*
>
> Required RFC 3339 UTC interval start.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Statistics Breakdown
>
> **Slug:** `ELASTIC_EMAIL_GET_STATISTICS_BREAKDOWN`
>
> Return one Elastic Email campaign or channel delivery summary by exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact campaign or channel name.
>
> **breakdown** `string ("campaign" | "channel")` *required*
>
> Statistics dimension containing the named item: `campaign` or `channel`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Subaccount
>
> **Slug:** `ELASTIC_EMAIL_GET_SUBACCOUNT`
>
> Return one managed Elastic Email subaccount by its login email. Requires an Elastic Email PRO plan.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Login email address of the managed subaccount to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Suppression
>
> **Slug:** `ELASTIC_EMAIL_GET_SUPPRESSION`
>
> Return suppression details for one Elastic Email address.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Suppressed email address to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Template
>
> **Slug:** `ELASTIC_EMAIL_GET_TEMPLATE`
>
> Return one Elastic Email template by its exact name.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Exact name of the template to return.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Verification File Results
>
> **Slug:** `ELASTIC_EMAIL_GET_VERIFICATION_FILE_RESULTS`
>
> Return one page of detailed results and metadata for a verification file.
>
> #### Input Parameters
>
> **id** `string`
>
> Identifier of the verification file job.
>
> **limit** `integer`
>
> Maximum result rows to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior Get Verification File Results call. Omit it for the first page.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Webhook
>
> **Slug:** `ELASTIC_EMAIL_GET_WEBHOOK`
>
> Return one Elastic Email webhook subscription by its public ID.
>
> #### Input Parameters
>
> **public\_id** `string` *required*
>
> Public webhook ID returned by Create Webhook or List Webhooks.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **file\_url** `string`
>
> Publicly accessible URL of a CSV file for Elastic Email to import. Provide exactly one of file\_url or csv\_content.
>
> **filename** `string`
>
> Filename for inline CSV content. Defaults to contacts.csv.
>
> **list\_name** `string`
>
> Name of an existing contact list to receive the imported contacts.
>
> **csv\_content** `string`
>
> 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`
>
> Character encoding of the CSV file.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Suppressions
>
> **Slug:** `ELASTIC_EMAIL_IMPORT_SUPPRESSIONS`
>
> Upload CSV content containing bounced, complained, or unsubscribed email addresses for asynchronous suppression import.
>
> #### Input Parameters
>
> **reason** `string ("bounce" | "complaint" | "unsubscribe")` *required*
>
> Suppression reason represented by the uploaded email addresses.
>
> **filename** `string`
>
> Filename for the CSV content. Defaults to suppressions.csv.
>
> **csv\_content** `string` *required*
>
> UTF-8 CSV content containing the email addresses to suppress.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Campaigns
>
> **Slug:** `ELASTIC_EMAIL_LIST_CAMPAIGNS`
>
> Find campaigns by optional name fragment and return one page. Results are limited to 1,000 campaigns.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum campaigns in this page; Elastic Email returns at most 1000 campaigns total.
>
> **search** `string`
>
> Campaign-name fragment matched with contains semantics.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Campaigns call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum contacts in this page.
>
> **list\_name** `string`
>
> Exact contact list name.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Contact List Members call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contact Lists
>
> **Slug:** `ELASTIC_EMAIL_LIST_CONTACT_LISTS`
>
> Return one page of contact lists from the connected Elastic Email account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum contact lists in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Contact Lists call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Contacts
>
> **Slug:** `ELASTIC_EMAIL_LIST_CONTACTS`
>
> Return one page of contacts from the connected Elastic Email account.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum contacts in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Contacts call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Credential Metadata
>
> **Slug:** `ELASTIC_EMAIL_LIST_CREDENTIAL_METADATA`
>
> List API-key or SMTP credential metadata without returning secret tokens.
>
> #### Input Parameters
>
> **subaccount** `string`
>
> Optional subaccount email whose credentials to list.
>
> **credential\_type** `string ("api_key" | "smtp")` *required*
>
> Credential family to list. Choose `api_key` or `smtp`.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Domains
>
> **Slug:** `ELASTIC_EMAIL_LIST_DOMAINS`
>
> Return all sending and tracking domains configured for the account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Email Verifications
>
> **Slug:** `ELASTIC_EMAIL_LIST_EMAIL_VERIFICATIONS`
>
> Return one page of individual email verification results.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum verification results in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Email Verifications call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Files
>
> **Slug:** `ELASTIC_EMAIL_LIST_FILES`
>
> Return one page of stored files and metadata.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum files to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Files call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Inbound Routes
>
> **Slug:** `ELASTIC_EMAIL_LIST_INBOUND_ROUTES`
>
> Return all inbound email routing rules in their current order.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Segments
>
> **Slug:** `ELASTIC_EMAIL_LIST_SEGMENTS`
>
> Return one page of dynamic contact segments.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum segments in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Segments call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Statistics Breakdowns
>
> **Slug:** `ELASTIC_EMAIL_LIST_STATISTICS_BREAKDOWNS`
>
> Return one page of campaign or channel delivery summaries.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum summaries in this page.
>
> **breakdown** `string ("campaign" | "channel")`
>
> Dimension to summarize: campaign or channel.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Statistics Breakdowns call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum subaccounts in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Subaccounts call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **limit** `integer`
>
> Maximum suppressions in this page.
>
> **reason** `string ("all" | "bounce" | "complaint" | "unsubscribe")`
>
> Suppression collection to list: `all` for every suppression, or `bounce`, `complaint`, or `unsubscribe` for one reason.
>
> **search** `string`
>
> Email address fragment to search for. Valid only when reason is `bounce`, `complaint`, or `unsubscribe`; omit it when reason is `all`.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Suppressions call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Templates
>
> **Slug:** `ELASTIC_EMAIL_LIST_TEMPLATES`
>
> Return one page of templates for the required visibility scopes.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum templates to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Templates call.
>
> **scope\_types** `array`
>
> One or more template scopes. This field is required by Elastic Email; Personal and Global are accepted.
>
> **template\_types** `array`
>
> Template types to include; omit to include every type in the selected scopes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Verification Files
>
> **Slug:** `ELASTIC_EMAIL_LIST_VERIFICATION_FILES`
>
> Return all uploaded verification file jobs and their current statuses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Webhooks
>
> **Slug:** `ELASTIC_EMAIL_LIST_WEBHOOKS`
>
> Return one page of webhook subscriptions.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum webhooks to return in this page.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior List Webhooks call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Exact name of the active campaign to pause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove 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
>
> **name** `string` *required*
>
> Exact name of the contact list to update.
>
> **members** `object` *required*
>
> Contacts selected by either one rule or a list of email addresses.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Reorder Inbound Routes
>
> **Slug:** `ELASTIC_EMAIL_REORDER_INBOUND_ROUTES`
>
> Set the processing order of Elastic Email inbound routing rules.
>
> #### Input Parameters
>
> **order** `array` *required*
>
> Route order entries, each containing a public inbound route ID and its desired position.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **to** `string`
>
> Inclusive RFC 3339 end time.
>
> **from** `string`
>
> Inclusive RFC 3339 start time.
>
> **limit** `integer`
>
> Maximum events in this page (1-1000).
>
> **scope** `string ("all" | "transaction" | "channel")`
>
> Event collection to search: all events, one transaction, or one channel.
>
> **order\_by** `string ("DateDescending" | "DateAscending")`
>
> Sort events by date ascending or descending.
>
> **event\_types** `array`
>
> Event types to include. Supported by all-event and channel searches.
>
> **next\_cursor** `string`
>
> Opaque continuation cursor returned by a prior Search Delivery Events call.
>
> **scope\_value** `string`
>
> Transaction ID or channel name; required for transaction and channel searches.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **message** `object` *required*
>
> Email message to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **message** `object` *required*
>
> Merge-file email to submit. Its CSV rows determine the recipients, and submission causes external delivery that cannot be recalled.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **message** `object` *required*
>
> Transactional email to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Set Default Sender Domain
>
> **Slug:** `ELASTIC_EMAIL_SET_DEFAULT_SENDER_DOMAIN`
>
> Set a verified email address as the account's default sender.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Verified sender email whose domain should become the account default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **rule** `string`
>
> Elastic Email contact filter rule. Do not provide this together with emails; omit both to export all contacts.
>
> **emails** `array`
>
> Contact email addresses to export. Do not provide this together with rule; a list or comma-separated string is accepted.
>
> **file\_name** `string`
>
> Requested export file name, including its extension.
>
> **file\_format** `string ("Csv" | "Xml" | "Json")`
>
> Export file format. Elastic Email defaults to Csv when omitted.
>
> **compression\_format** `string ("None" | "Zip")`
>
> Archive compression format. Elastic Email defaults to None when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start Event Export
>
> **Slug:** `ELASTIC_EMAIL_START_EVENT_EXPORT`
>
> Start an asynchronous export for all events or one channel.
>
> #### Input Parameters
>
> **to** `string`
>
> Inclusive end time in RFC 3339 format.
>
> **from** `string`
>
> Inclusive start time in RFC 3339 format.
>
> **file\_name** `string`
>
> Requested export file name, including its extension.
>
> **event\_types** `array`
>
> Event types to include; a list or comma-separated string is accepted.
>
> **file\_format** `string ("Csv" | "Xml" | "Json")`
>
> Export file format. Elastic Email defaults to Csv when omitted.
>
> **channel\_name** `string`
>
> Channel to export; omit to export events across all channels.
>
> **compression\_format** `string ("None" | "Zip")`
>
> Archive compression format. Elastic Email defaults to None when omitted.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **id** `string` *required*
>
> Verification ID returned by Upload Verification File.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Exact name of the automation campaign to trigger.
>
> **contact\_email** `string` *required*
>
> Email address of the contact that will enter the automation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **campaign** `object` *required*
>
> Complete replacement campaign definition. Name and Recipients are required.
>
> **current\_name** `string` *required*
>
> Exact name of the existing active or paused campaign to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Contact
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_CONTACT`
>
> Update the first name, last name, or custom fields for one Elastic Email contact.
>
> #### Input Parameters
>
> **email** `string` *required*
>
> Email address of the contact to update.
>
> **updates** `object` *required*
>
> Contact changes. Provide at least one of FirstName, LastName, or CustomFields; omitted fields remain unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **name** `string` *required*
>
> Current exact name of the contact list to update.
>
> **updates** `object` *required*
>
> Contact-list changes. Provide at least one of NewListName or AllowUnsubscribe; omitted fields remain unchanged.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Domain
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_DOMAIN`
>
> Update certificate, VERP, or custom bounce settings for an Elastic Email domain.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Exact domain name to update.
>
> **updates** `object` *required*
>
> Domain changes. Provide at least one of CertificateStatus, VERP, CustomBouncesDomain, or IsCustomBouncesDomainDefault; omitted fields are not sent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Inbound Route
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_INBOUND_ROUTE`
>
> Replace an existing inbound route definition by public ID.
>
> #### Input Parameters
>
> **route** `object` *required*
>
> Complete replacement definition for the inbound route.
>
> **current\_id** `string` *required*
>
> Public ID of the existing inbound route to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Segment
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_SEGMENT`
>
> Replace an existing dynamic contact segment's name and rule.
>
> #### Input Parameters
>
> **segment** `object` *required*
>
> Complete replacement segment definition containing Name and Rule.
>
> **current\_name** `string` *required*
>
> Exact name of the existing segment to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string` *required*
>
> Login email address of the managed subaccount.
>
> **settings** `object` *required*
>
> Email-setting changes. Provide at least one nested email credit, sending limit, contact limit, IP pool, or sender-domain setting.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Template
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_TEMPLATE`
>
> Replace an existing email template's name, content, and scope.
>
> #### Input Parameters
>
> **template** `object` *required*
>
> Complete replacement template definition. Name is required.
>
> **current\_name** `string` *required*
>
> Exact name of the existing template to replace.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Webhook
>
> **Slug:** `ELASTIC_EMAIL_UPDATE_WEBHOOK`
>
> Update a webhook URL, event notification flags, name, or enabled state.
>
> #### Input Parameters
>
> **updates** `object` *required*
>
> 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` *required*
>
> Public WebhookID returned by a create, get, or list webhook call.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File
>
> **Slug:** `ELASTIC_EMAIL_UPLOAD_FILE`
>
> Store a base64-encoded file in the connected Elastic Email account.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> Base64-encoded file content and optional file metadata.
>
> **expires\_after\_days** `integer`
>
> Number of days to retain the stored file; omit to use the provider default.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **filename** `string`
>
> Filename for the CSV content. Defaults to verification.csv.
>
> **csv\_content** `string` *required*
>
> UTF-8 CSV content to upload. It must contain a column named email.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Verify Domain
>
> **Slug:** `ELASTIC_EMAIL_VERIFY_DOMAIN`
>
> Ask Elastic Email to re-check a domain's DNS configuration.
>
> #### Input Parameters
>
> **domain** `string` *required*
>
> Configured domain to verify.
>
> **tracking\_type** `string ("None" | "Delete" | "Http" | "ExternalHttps" | "InternalCertHttps" | "LetsEncryptCert")` *required*
>
> Tracking protocol and certificate mode to validate for the domain.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] 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
>
> **email** `string` *required*
>
> Email address to verify.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
