Skip to main content
Elastic Email logo
  • Category: email
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 91
  • Triggers: 0
  • Slug: ELASTIC_EMAIL
  • Version: 20261101_00

Tools

Slug: ELASTIC_EMAIL_ADD_CONTACT_LIST_MEMBERSAdd selected existing contacts to a named Elastic Email contact list.

Input Parameters

string
required
Exact name of the contact list to update.
object
required
Existing contacts selected by either one rule or a list of email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_ADD_CONTACTSAdd up to 1000 Elastic Email contacts and optionally assign them to existing lists.

Input Parameters

array
required
Contacts to add. Each contact requires Email; a request may contain at most 1000 contacts.
array
Existing contact list names to which all added contacts should be assigned.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_ADD_SUPPRESSIONSAdd up to 1000 email addresses to Elastic Email’s bounce, complaint, or unsubscribe suppression records.

Input Parameters

array
required
Email addresses to suppress; Elastic Email limits each request to 1000 addresses.
string ("bounce" | "complaint" | "unsubscribe")
required
Suppression reason to record for every provided email address.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_ADJUST_SUBACCOUNT_CREDITSAdd 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

string
required
Login email address of the managed subaccount.
object
required
Credit amount to add or remove and an optional history note.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CHECK_DOMAIN_RESTRICTEDCheck whether Elastic Email restricts a domain or identifies it as a free-provider domain.

Input Parameters

string
required
Domain name to check for provider or policy restrictions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_CAMPAIGNCreate a campaign. An active or scheduled campaign may initiate email delivery, and sent messages cannot be recalled.

Input Parameters

object
required
Campaign definition. Name and Recipients are required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_CONTACT_LISTCreate a contact list with existing contacts selected by email. If the email list is left empty, all contacts are included.

Input Parameters

object
required
Contact list name, unsubscribe setting, and optional initial members.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_DOMAINCreate a sending or tracking domain in the connected Elastic Email account, optionally setting it as the default domain.

Input Parameters

object
required
Domain name and optional default-domain setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_INBOUND_ROUTECreate a new inbound email route.

Input Parameters

object
required
Complete definition for the new inbound route.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_SEGMENTCreate a dynamic contact segment from a name and SQL-like rule.

Input Parameters

object
required
Complete segment definition containing the required Name and Rule.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_SUBACCOUNTCreate 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

object
required
New subaccount credentials, activation behavior, and initial settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_TEMPLATECreate a new email template with its name, content, and scope.

Input Parameters

object
required
Complete template definition. Name is required.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_CREATE_WEBHOOKCreate a webhook subscription for selected email events.

Input Parameters

object
required
Webhook name, callback URL, and email event notification settings.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_CAMPAIGNDelete one campaign by exact name. This does not cancel email already in progress.

Input Parameters

string
required
Exact campaign name to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_CONTACTDelete one contact by exact email address.

Input Parameters

string
required
Exact contact email address to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_CONTACT_LISTDelete one contact list by exact name. Contacts that belonged to the list are removed from it but are not deleted.

Input Parameters

string
required
Exact name of the contact list to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_CONTACTSPermanently 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_DOMAINDelete one configured domain from the connected Elastic Email account.

Input Parameters

string
required
Exact configured domain to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_EMAIL_VERIFICATIONDelete one saved email verification result by exact email address.

Input Parameters

string
required
Email address whose saved verification result to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_FILEPermanently delete one stored file by its exact name.

Input Parameters

string
required
Exact stored file name, including its extension, to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_INBOUND_ROUTEPermanently delete one inbound email route by its public ID.

Input Parameters

string
required
Public ID of the inbound route to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_SEGMENTDelete one Elastic Email dynamic contact segment by its exact name.

Input Parameters

string
required
Exact name of the dynamic segment to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_SUPPRESSIONRemove one email address from Elastic Email suppression records. This can allow sending to resume, so use only with documented recipient consent.

Input Parameters

string
required
Exact suppressed email address to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_TEMPLATEDelete one Elastic Email template by its exact name.

Input Parameters

string
required
Exact name of the template to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_VERIFICATION_FILEDelete one uploaded verification file job by its VerificationID.

Input Parameters

string
required
VerificationID of the uploaded verification file job to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DELETE_WEBHOOKDelete one webhook subscription by its public WebhookID.

Input Parameters

string
required
WebhookID of the webhook subscription to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DOWNLOAD_FILEDownload a stored Elastic Email file by its exact name.

Input Parameters

string
required
Exact stored file name, including its extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_DOWNLOAD_VERIFICATION_FILE_RESULTSDownload the ZIP result archive for a completed verification file job.

Input Parameters

string
required
Identifier of the completed verification file job.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_CAMPAIGNReturn one Elastic Email campaign by its exact name.

Input Parameters

string
required
Exact name of the campaign to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_CONTACTReturn one Elastic Email contact by email address.

Input Parameters

string
required
Email address of the contact to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_CONTACT_EXPORT_STATUSGet the current status of an asynchronous contact export job.

Input Parameters

string
required
Public export ID returned by Start Contact Export.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_CONTACT_LISTReturn one Elastic Email contact list by its exact name.

Input Parameters

string
required
Exact name of the contact list to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_CREDENTIAL_METADATAGet one Elastic Email API-key or SMTP credential’s audit metadata without returning its secret token.

Input Parameters

string
required
Exact name of the API key or SMTP credential.
string
Subaccount email whose credential should be returned. Omit for the main account.
string ("api_key" | "smtp")
required
Credential family to inspect: api_key or smtp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_DOMAINReturn detailed DNS and certificate state for one Elastic Email domain.

Input Parameters

string
required
Exact domain name to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_EMAIL_JOB_STATUSReturn delivery status and optional recipient-level details for an Elastic Email transaction.

Input Parameters

boolean
Include sent recipients.
boolean
Include abuse reports.
boolean
Include error details for failed recipients.
boolean
Include failed recipient details.
boolean
Include opened recipients.
boolean
Include clicked recipients.
boolean
Include pending recipients.
boolean
Include delivered recipients.
string
required
Transaction ID returned by an email send.
boolean
Include message IDs.
boolean
Include unsubscribed recipients.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_EMAIL_PREVIEWReturn the rendered preview, attachment metadata, and delivery status for an Elastic Email message ID.

Input Parameters

string
required
Message ID returned by an email send or delivery report.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_EMAIL_VERIFICATIONReturn the saved Elastic Email verification result for one email address.

Input Parameters

string
required
Email address whose saved verification result to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_EVENT_EXPORT_STATUSGet 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

string
required
Public export ID returned by Start Event Export. Set export_scope to match whether that export was global or channel-specific.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_FILE_INFOReturn metadata for a stored Elastic Email file without downloading it.

Input Parameters

string
required
Exact stored file name, including its extension.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_INBOUND_ROUTEReturn one Elastic Email inbound route by its public ID.

Input Parameters

string
required
Public ID of the inbound route to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_SEGMENTReturn one Elastic Email dynamic contact segment by its exact name.

Input Parameters

string
required
Exact name of the segment to return. Use ‘All Contacts’ to return the built-in all-contacts segment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_STATISTICSReturn aggregate Elastic Email delivery statistics for a time interval.

Input Parameters

string
Optional RFC 3339 interval end.
string
required
Required RFC 3339 UTC interval start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_STATISTICS_BREAKDOWNReturn one Elastic Email campaign or channel delivery summary by exact name.

Input Parameters

string
required
Exact campaign or channel name.
string ("campaign" | "channel")
required
Statistics dimension containing the named item: campaign or channel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_SUBACCOUNTReturn one managed Elastic Email subaccount by its login email. Requires an Elastic Email PRO plan.

Input Parameters

string
required
Login email address of the managed subaccount to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_SUPPRESSIONReturn suppression details for one Elastic Email address.

Input Parameters

string
required
Suppressed email address to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_TEMPLATEReturn one Elastic Email template by its exact name.

Input Parameters

string
required
Exact name of the template to return.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_VERIFICATION_FILE_RESULTSReturn one page of detailed results and metadata for a verification file.

Input Parameters

string
Identifier of the verification file job.
integer
Maximum result rows to return in this page.
string
Opaque continuation cursor returned by a prior Get Verification File Results call. Omit it for the first page.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_GET_WEBHOOKReturn one Elastic Email webhook subscription by its public ID.

Input Parameters

string
required
Public webhook ID returned by Create Webhook or List Webhooks.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_IMPORT_CONTACTSStart an asynchronous contact import using exactly one source: an uploaded CSV file or a provider-accessible CSV URL.

Input Parameters

string
Publicly accessible URL of a CSV file for Elastic Email to import. Provide exactly one of file_url or csv_content.
string
Filename for inline CSV content. Defaults to contacts.csv.
string
Name of an existing contact list to receive the imported contacts.
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.
string
Character encoding of the CSV file.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_IMPORT_SUPPRESSIONSUpload CSV content containing bounced, complained, or unsubscribed email addresses for asynchronous suppression import.

Input Parameters

string ("bounce" | "complaint" | "unsubscribe")
required
Suppression reason represented by the uploaded email addresses.
string
Filename for the CSV content. Defaults to suppressions.csv.
string
required
UTF-8 CSV content containing the email addresses to suppress.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_CAMPAIGNSFind campaigns by optional name fragment and return one page. Results are limited to 1,000 campaigns.

Input Parameters

integer
Maximum campaigns in this page; Elastic Email returns at most 1000 campaigns total.
Campaign-name fragment matched with contains semantics.
string
Opaque continuation cursor returned by a prior List Campaigns call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_CONTACT_LIST_MEMBERSReturn one page of contacts in a named Elastic Email contact list.

Input Parameters

integer
Maximum contacts in this page.
string
Exact contact list name.
string
Opaque continuation cursor returned by a prior List Contact List Members call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_CONTACT_LISTSReturn one page of contact lists from the connected Elastic Email account.

Input Parameters

integer
Maximum contact lists in this page.
string
Opaque continuation cursor returned by a prior List Contact Lists call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_CONTACTSReturn one page of contacts from the connected Elastic Email account.

Input Parameters

integer
Maximum contacts in this page.
string
Opaque continuation cursor returned by a prior List Contacts call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_CREDENTIAL_METADATAList API-key or SMTP credential metadata without returning secret tokens.

Input Parameters

string
Optional subaccount email whose credentials to list.
string ("api_key" | "smtp")
required
Credential family to list. Choose api_key or smtp.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_DOMAINSReturn all sending and tracking domains configured for the account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_EMAIL_VERIFICATIONSReturn one page of individual email verification results.

Input Parameters

integer
Maximum verification results in this page.
string
Opaque continuation cursor returned by a prior List Email Verifications call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_FILESReturn one page of stored files and metadata.

Input Parameters

integer
Maximum files to return in this page.
string
Opaque continuation cursor returned by a prior List Files call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_INBOUND_ROUTESReturn all inbound email routing rules in their current order.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_SEGMENTSReturn one page of dynamic contact segments.

Input Parameters

integer
Maximum segments in this page.
string
Opaque continuation cursor returned by a prior List Segments call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_STATISTICS_BREAKDOWNSReturn one page of campaign or channel delivery summaries.

Input Parameters

integer
Maximum summaries in this page.
string ("campaign" | "channel")
Dimension to summarize: campaign or channel.
string
Opaque continuation cursor returned by a prior List Statistics Breakdowns call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_SUBACCOUNTSReturn one page of managed subaccounts without credentials or passwords. Requires an Elastic Email PRO plan.

Input Parameters

integer
Maximum subaccounts in this page.
string
Opaque continuation cursor returned by a prior List Subaccounts call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_SUPPRESSIONSReturn one page of all suppressed addresses or only addresses suppressed for bounce, complaint, or unsubscribe reasons.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_TEMPLATESReturn one page of templates for the required visibility scopes.

Input Parameters

integer
Maximum templates to return in this page.
string
Opaque continuation cursor returned by a prior List Templates call.
array
One or more template scopes. This field is required by Elastic Email; Personal and Global are accepted.
array
Template types to include; omit to include every type in the selected scopes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_VERIFICATION_FILESReturn all uploaded verification file jobs and their current statuses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_LIST_WEBHOOKSReturn one page of webhook subscriptions.

Input Parameters

integer
Maximum webhooks to return in this page.
string
Opaque continuation cursor returned by a prior List Webhooks call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_PAUSE_CAMPAIGNPause an active Elastic Email campaign by exact name, cancelling messages that are still waiting to be sent.

Input Parameters

string
required
Exact name of the active campaign to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_REMOVE_CONTACT_LIST_MEMBERSRemove selected contacts from a named Elastic Email contact list without deleting the contacts.

Input Parameters

string
required
Exact name of the contact list to update.
object
required
Contacts selected by either one rule or a list of email addresses.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_REORDER_INBOUND_ROUTESSet the processing order of Elastic Email inbound routing rules.

Input Parameters

array
required
Route order entries, each containing a public inbound route ID and its desired position.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_SEARCH_EVENTSSearch all delivery events, one transaction’s events, or one channel’s events and return one page.

Input Parameters

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_SEND_EMAILSend an email to one or more recipients using inline content or a saved template. Submission causes external delivery and cannot be recalled.

Input Parameters

object
required
Email message to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_SEND_MERGE_FILE_EMAILSend personalized email to recipients listed in a CSV merge-data file. Submission causes external delivery and cannot be recalled.

Input Parameters

object
required
Merge-file email to submit. Its CSV rows determine the recipients, and submission causes external delivery that cannot be recalled.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_SEND_TRANSACTIONAL_EMAILSend one transactional message with To, CC, and BCC recipient groups. Submission causes external delivery and cannot be recalled.

Input Parameters

object
required
Transactional email to submit. The complete message, including attachments, must not exceed 20 MB. Sending is irreversible.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_SET_DEFAULT_SENDER_DOMAINSet a verified email address as the account’s default sender.

Input Parameters

string
required
Verified sender email whose domain should become the account default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_START_CONTACT_EXPORTStart an asynchronous export of all contacts or contacts selected by one filter rule or a list of email addresses.

Input Parameters

string
Elastic Email contact filter rule. Do not provide this together with emails; omit both to export all contacts.
array
Contact email addresses to export. Do not provide this together with rule; a list or comma-separated string is accepted.
string
Requested export file name, including its extension.
string ("Csv" | "Xml" | "Json")
Export file format. Elastic Email defaults to Csv when omitted.
string ("None" | "Zip")
Archive compression format. Elastic Email defaults to None when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_START_EVENT_EXPORTStart an asynchronous export for all events or one channel.

Input Parameters

string
Inclusive end time in RFC 3339 format.
string
Inclusive start time in RFC 3339 format.
string
Requested export file name, including its extension.
array
Event types to include; a list or comma-separated string is accepted.
string ("Csv" | "Xml" | "Json")
Export file format. Elastic Email defaults to Csv when omitted.
string
Channel to export; omit to export events across all channels.
string ("None" | "Zip")
Archive compression format. Elastic Email defaults to None when omitted.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_START_VERIFICATION_FILEStart 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

string
required
Verification ID returned by Upload Verification File.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_TRIGGER_AUTOMATIONEnter one contact email into an irreversible automation that may send email or execute later steps and cannot be undone.

Input Parameters

string
required
Exact name of the automation campaign to trigger.
string
required
Email address of the contact that will enter the automation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_CAMPAIGNUpdate an existing active or paused campaign. Changes may initiate email delivery, and sent messages cannot be recalled.

Input Parameters

object
required
Complete replacement campaign definition. Name and Recipients are required.
string
required
Exact name of the existing active or paused campaign to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_CONTACTUpdate the first name, last name, or custom fields for one Elastic Email contact.

Input Parameters

string
required
Email address of the contact to update.
object
required
Contact changes. Provide at least one of FirstName, LastName, or CustomFields; omitted fields remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_CONTACT_LISTUpdate 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

string
required
Current exact name of the contact list to update.
object
required
Contact-list changes. Provide at least one of NewListName or AllowUnsubscribe; omitted fields remain unchanged.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_DOMAINUpdate certificate, VERP, or custom bounce settings for an Elastic Email domain.

Input Parameters

string
required
Exact domain name to update.
object
required
Domain changes. Provide at least one of CertificateStatus, VERP, CustomBouncesDomain, or IsCustomBouncesDomainDefault; omitted fields are not sent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_INBOUND_ROUTEReplace an existing inbound route definition by public ID.

Input Parameters

object
required
Complete replacement definition for the inbound route.
string
required
Public ID of the existing inbound route to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_SEGMENTReplace an existing dynamic contact segment’s name and rule.

Input Parameters

object
required
Complete replacement segment definition containing Name and Rule.
string
required
Exact name of the existing segment to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_SUBACCOUNT_EMAIL_SETTINGSReplace email limits and sender settings for a managed subaccount. Requires an Elastic Email PRO plan.

Input Parameters

string
required
Login email address of the managed subaccount.
object
required
Email-setting changes. Provide at least one nested email credit, sending limit, contact limit, IP pool, or sender-domain setting.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_TEMPLATEReplace an existing email template’s name, content, and scope.

Input Parameters

object
required
Complete replacement template definition. Name is required.
string
required
Exact name of the existing template to replace.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPDATE_WEBHOOKUpdate a webhook URL, event notification flags, name, or enabled state.

Input Parameters

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.
string
required
Public WebhookID returned by a create, get, or list webhook call.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPLOAD_FILEStore a base64-encoded file in the connected Elastic Email account.

Input Parameters

object
required
Base64-encoded file content and optional file metadata.
integer
Number of days to retain the stored file; omit to use the provider default.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_UPLOAD_VERIFICATION_FILEUpload 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

string
Filename for the CSV content. Defaults to verification.csv.
string
required
UTF-8 CSV content to upload. It must contain a column named email.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_VERIFY_DOMAINAsk Elastic Email to re-check a domain’s DNS configuration.

Input Parameters

string
required
Configured domain to verify.
string ("None" | "Delete" | "Http" | "ExternalHttps" | "InternalCertHttps" | "LetsEncryptCert")
required
Tracking protocol and certificate mode to validate for the domain.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ELASTIC_EMAIL_VERIFY_EMAILRun 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

string
required
Email address to verify.

Output

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