Smtp2go

smtp2go

SMTP2GO is a reliable email delivery service that ensures your emails reach recipients' inboxes efficiently.

Transactional Email Email Web del proveedor

Acciones

Triggers

Autenticación

—

OAuth gestionado

Información técnica: el detalle de parámetros, schemas y triggers de esta página está pensado para equipos de integración. Si solo necesitas saber si tu herramienta favorita está disponible, basta con ver la lista de acciones.

Acciones disponibles (32)

Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.

Search Email ActivitySMTP2GO_ACTIVITY_SEARCHAcción

Tool to search activity events like sends, opens, clicks, and bounces. use when you need to filter account email activity by date, event, recipient, or message id.

Parámetros de entrada

limitinteger
Number of results to return, defaults to 100, maximum 1000
offsetinteger
Number of records to skip for pagination
searchobject
Filter criteria for searching email activity.

Parámetros de salida

dataobject[]Obligatorio
List of activity records matching search criteria
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of matching records
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Allowed SenderSMTP2GO_ALLOWED_SENDERS_ADDAcción

Tool to add a new allowed sender email address. use when you need to whitelist a sender before sending email. example: add "user@example.com" to allowed senders list.

Parámetros de entrada

email_addressanyObligatorioemail
Email address to add as an allowed sender.

Parámetros de salida

dataobjectObligatorio
Data returned for the added allowed sender.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message returned by SMTP2GO API

Remove Allowed SenderSMTP2GO_ALLOWED_SENDERS_REMOVEAcción

Tool to remove a sender email address from the allowed senders list. use when you need to revoke send permissions for a validated address.

Parámetros de entrada

email_addressanyObligatorioemail
The email address to remove from the allowed senders list

Parámetros de salida

dataobject
Data section of the response.
errorstring
Error if any occurred during the execution of the action
error_codeinteger
Error code if the operation failed
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message if the operation failed or was unsuccessful

Update Allowed SenderSMTP2GO_ALLOWED_SENDERS_UPDATEAcción

Tool to update details of an existing allowed sender. use after confirming the allowed sender id.

Parámetros de entrada

namestring
New display name for the allowed sender
reply_promptboolean
Whether reply prompt is enabled for this sender
email_addressanyemail
New email address for the allowed sender
allowed_sender_idstringObligatorio
The ID of the allowed sender to update

Parámetros de salida

dataobjectObligatorio
Updated allowed sender details
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique ID for this API request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View Allowed SendersSMTP2GO_ALLOWED_SENDERS_VIEWAcción

Tool to view the list of allowed senders configured in your account. use after setting up smtp2go authentication to retrieve your allowed-senders list. example: 'show me all verified allowed senders.'

Parámetros de entrada

limitinteger
Maximum number of results to return (1-1000).
offsetinteger
Number of results to skip for pagination.
verifiedstringenum
Filter by verification status ('verified' or 'unverified').
verifiedunverified
sender_emailstring
Filter by exact sender email address.

Parámetros de salida

dataobject[]Obligatorio
List of allowed sender records matching the query.
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of matched senders.
error_codeintegerObligatorio
Zero if successful; otherwise an error code.
request_idstringObligatorio
Unique ID for this API request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add Sender DomainSMTP2GO_DOMAIN_ADDAcción

Tool to add a new sender domain for spf/dkim verification. use when you need to register a domain and optionally set tracking/return-path subdomains.

Parámetros de entrada

domainstringObligatorio
The domain to add as a sending domain (top-level or subdomain).
auto_verifyboolean
If true, SMTP2GO will attempt to verify SPF/DKIM records automatically.
subaccount_idstring
Unique ID of the subaccount (if you manage multiple subaccounts).
tracking_subdomainstring
Subdomain for click/open tracking and unsubscribe links; defaults to 'link' if omitted.
returnpath_subdomainstring
Subdomain to use as the return-path (bounce) domain.

Parámetros de salida

dataobjectObligatorio
Details of the added domain(s).
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique ID for this API request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search SMTP2GO EmailsSMTP2GO_EMAIL_SEARCHAcción

Tool to search sent emails. use when filtering your smtp2go account's email activity by criteria like date, sender, or recipient. call after authentication.

Parámetros de entrada

eventstring
Filter only events matching this type (e.g., 'bounce', 'spam', etc.).
limitinteger
Number of results to return (default 100, max 500).
offsetinteger
Pagination offset (default 0).
senderanyemail
Return only results for this specific sender email.
statusstring
Return only results with this status (e.g., 'sent', 'dropped').
sort_bystring
Sort returned items by this field.
subjectstring
Return only results with this exact subject line.
date_endanydate
End date (YYYY-MM-DD) for filtering results.
email_idstring
Return only results for this specific email ID.
recipientanyemail
Return only results for this specific recipient email.
date_startanydate
Start date (YYYY-MM-DD) for filtering results.
sort_orderstringenum
Order of returned results.
ascdesc

Parámetros de salida

dataobjectObligatorio
Container for search results; includes 'emails' list.
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
API call status.
successerror
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add IP Allow ListSMTP2GO_IP_ALLOW_LIST_ADDAcción

Tool to add an ip address or cidr range to your account’s ip allow list. use when you need to whitelist specific sending sources by ip or cidr after confirming accuracy.

Parámetros de entrada

ipstringObligatorio
IP address (e.g., '192.168.1.1') or CIDR range (e.g., '192.168.1.0/24') to add to the allow list.
notestring
Optional note for your reference (max 255 characters).

Parámetros de salida

dataobjectObligatorio
Data returned after adding an IP to the allow list.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message returned by SMTP2GO API

Remove IP from Allow ListSMTP2GO_IP_ALLOW_LIST_REMOVEAcción

Tool to remove an ip address from your account's ip allow list. use after identifying the ip you wish to revoke.

Parámetros de entrada

ip_addressanyObligatorioipv4
The IPv4 address to remove from the allow list.

Parámetros de salida

dataobjectObligatorio
Result of the removal operation.
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
Status of the API call.
successerror
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View IP Allow ListSMTP2GO_IP_ALLOW_LIST_VIEWAcción

Tool to view the list of ip addresses in your ip allow list. use after confirming your smtp2go api key is set.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of allowed IP address entries.
errorstring
Error if any occurred during the execution of the action
error_codeinteger
SMTP2GO error code if the request failed.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View Received SMSSMTP2GO_SMS_VIEW_RECEIVEDAcción

Tool to retrieve received sms replies for your smtp2go account. use when you need to fetch incoming sms messages for analysis or display. pagination supported via limit and offset.

Parámetros de entrada

limitinteger
Number of received SMS messages to return (default 100, max 500)
offsetinteger
Number of messages to skip for pagination (default 0)

Parámetros de salida

dataobject[]Obligatorio
List of received SMS messages
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of received SMS messages available
error_codeintegerObligatorio
API error code (0 if no error)
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Get Email Bounces StatsSMTP2GO_STATS_EMAIL_BOUNCESAcción

Tool to retrieve email bounces statistics. use after sending emails to analyze bounce metrics over a time period.

Parámetros de entrada

emailanyemail
Filter results by a specific email address
limitinteger
Number of records to return, defaults to API default
offsetinteger
Record offset for pagination, defaults to API default
date_endanydate
End date (inclusive) in YYYY-MM-DD format to filter bounces
date_startanydate
Start date (inclusive) in YYYY-MM-DD format to filter bounces
sort_fieldstring
Field by which to sort results, e.g., date_bounced
sort_directionstringenum
Sort direction for results, either ASC or DESC
ASCDESC

Parámetros de salida

dataobject[]Obligatorio
Array of bounce record objects
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of bounces matching filters
successbooleanObligatorio
Indicates if the request was successful
error_codestring
Error code if the request failed
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message if the request failed

Email Cycle StatisticsSMTP2GO_STATS_EMAIL_CYCLEAcción

Tool to retrieve email cycle statistics. use when you need to analyze email delivery metrics over a specified date range.

Parámetros de entrada

limitinteger
Maximum number of records to return
offsetinteger
Number of records to skip for pagination
date_toanyObligatoriodate
End date for the report in YYYY-MM-DD format
group_bystringenum
Time granularity to group statistics by
dayweekmonth
groupingstring
Optional secondary grouping key, e.g., 'user'
date_fromanyObligatoriodate
Start date for the report in YYYY-MM-DD format

Parámetros de salida

dataobject[]Obligatorio
List of statistics grouped by cycle
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of records returned
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Email History StatisticsSMTP2GO_STATS_EMAIL_HISTORYAcción

Tool to retrieve email history statistics. use when you need detailed delivery metrics within a date range.

Parámetros de entrada

tagstring
Filter results by message tag.
emailanyemail
Filter results by recipient email address.
limitinteger
Maximum number of records to return (1–1000).
offsetinteger
Number of records to skip for pagination.
senderanyemail
Filter results by sender email address.
date_endanydate
End date for filtering (YYYY-MM-DD).
date_startanydate
Start date for filtering (YYYY-MM-DD).

Parámetros de salida

dataobject[]Obligatorio
List of email history records returned.
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of emails matching the query.
request_idstringObligatorio
Unique ID for this API request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Email Spam StatisticsSMTP2GO_STATS_EMAIL_SPAMAcción

Tool to retrieve email spam report statistics. use when analyzing spam trends for sent emails.

Parámetros de entrada

limitinteger
Number of records to return (default 100, max 1000).
offsetinteger
Pagination offset (default 0).
senderanyemail
Filter results by sender email address.
date_endanyObligatoriodate
End date (YYYY-MM-DD) for filtering spam statistics.
recipientanyemail
Filter results by recipient email address.
date_startanyObligatoriodate
Start date (YYYY-MM-DD) for filtering spam statistics.
transaction_idstring
Filter results by transaction ID.

Parámetros de salida

dataobject[]Obligatorio
List of spam report statistics.
errorstring
Error if any occurred during the execution of the action
error_codeinteger
Error code if the request failed.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message if the request failed.

Email Unsubscription StatsSMTP2GO_STATS_EMAIL_UNSUBSAcción

Tool to retrieve email unsubscribe statistics. use when you need unsubscribe data for your account over a date range.

Parámetros de entrada

date_endanydate
Ending date (YYYY-MM-DD) for the unsubscribe report.
date_startanydate
Starting date (YYYY-MM-DD) for the unsubscribe report.
result_limitinteger
Maximum number of records to return (1-1000).
email_addressanyemail
Restrict results to this email address.
result_offsetinteger
Number of records to skip for pagination.

Parámetros de salida

dataobject[]Obligatorio
List of unsubscription records.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
API error code (0 indicates success).
request_idstringObligatorio
Unique identifier for this API request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message if the request failed.

Search SubaccountsSMTP2GO_SUBACCOUNTS_SEARCHAcción

Tool to search subaccounts. use after authenticating to filter and paginate your subaccounts by name, email, or status.

Parámetros de entrada

namestring
Filter results to subaccounts with this name.
emailstringemail
Filter results to subaccounts with this email address.
limitinteger
Number of records to return (default 100, max 1000).
activeboolean
Filter results by active status (true or false).
offsetinteger
Number of records to skip for pagination (default 0).

Parámetros de salida

dataobject[]Obligatorio
List of subaccount records matching the search criteria.
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of matching subaccounts.
error_codeinteger
Zero if successful; non-zero if an error occurred.
request_idstring
Unique ID for the API request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Subaccounts UsageSMTP2GO_SUBACCOUNTS_USAGEAcción

Tool to retrieve usage statistics for subaccounts. use when you need to monitor per-subaccount email usage.

Parámetros de entrada

subaccount_idstring
ID of the subaccount for which to retrieve usage statistics. If omitted, statistics for all subaccounts are returned.

Parámetros de salida

dataobjectObligatorio
Usage statistics data
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique ID for this API request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add to Suppression ListSMTP2GO_SUPPRESSION_ADDAcción

Tool to add email addresses or domains to the suppression list. use when you need to block sending emails to specific recipients or entire domains after unsubscribes or bounces.

Parámetros de entrada

typestringenum
Type of suppression: EMAIL to suppress addresses, DOMAIN to suppress domains, ALL for both.
EMAILDOMAINALL
descriptionstring
Optional note about the suppression reason.
email_addressstringObligatorio
A single email address or list of addresses to add to suppression list. Use domain format (e.g., '@example.com') to suppress entire domain.

Parámetros de salida

dataobjectObligatorio
Result data returned by SMTP2GO API.
errorstring
Error if any occurred during the execution of the action
failedstring[]
List of addresses or domains that could not be added
succeededbooleanObligatorio
Indicates if the suppression add was successful.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Remove suppression entrySMTP2GO_SUPPRESSION_REMOVEAcción

Tool to remove an email address or domain from the suppression list. use when you want to resume sending to the address or domain.

Parámetros de entrada

emailanyemail
Email address to remove from suppression list.
domainanyhostname
Domain to remove from suppression list.
subaccount_idstring
Subaccount ID from which to remove suppression entry.

Parámetros de salida

dataobjectObligatorio
Result details of suppression removal.
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique identifier for the removal request.
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View Suppression ListSMTP2GO_SUPPRESSION_VIEWAcción

Tool to view the suppression list. use when you need to inspect suppressed email addresses in your account.

Parámetros de entrada

limitinteger
Maximum number of results to return (default 100)
offsetinteger
Number of results to skip for pagination
end_dateanydate
Only list suppressions added on or before this date (YYYY-MM-DD)
start_dateanydate
Only list suppressions added on or after this date (YYYY-MM-DD)
email_addressanyemail
Filter by specific email address
suppression_typestringenum
Type of suppression to filter
bouncesunsubscribesspam complaints

Parámetros de salida

dataobject[]Obligatorio
List of suppressed email entries
errorstring
Error if any occurred during the execution of the action
totalintegerObligatorio
Total number of matched suppressed addresses
statusstringObligatorioenum
API response status
successerror
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit Email TemplateSMTP2GO_TEMPLATE_EDITAcción

Tool to edit details of an existing email template. use when you need to update template properties after confirming its id.

Parámetros de entrada

namestring
New name for the template
subjectstring
New subject line for the template
html_bodystring
New HTML content for the template
text_bodystring
New plain text content for the template
editor_codestring
New code view content for drag-and-drop editor templates
is_archivedboolean
Whether to archive (true) or unarchive (false) the template
template_idstringObligatorio
ID of the template to edit

Parámetros de salida

dataobjectObligatorio
Data object containing edited template ID
errorstring
Error if any occurred during the execution of the action
error_codestring
Error code if the request failed
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Search Email TemplatesSMTP2GO_TEMPLATE_SEARCHAcción

Tool to search your collection of email templates by id or name. use when you need to find templates matching specific criteria after authentication.

Parámetros de entrada

namestring
Filter by the template name.
limitinteger
Number of results per page (1-1000).
offsetinteger
Number of results to skip for pagination.
template_idstring
Filter by the unique template identifier.

Parámetros de salida

dataobjectObligatorio
Search results data.
errorstring
Error if any occurred during the execution of the action
statusstringObligatorioenum
API call status.
successerror
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View Email TemplateSMTP2GO_TEMPLATE_VIEWAcción

Tool to view details of a specific email template. use after you have the template id to inspect.

Parámetros de entrada

template_idstringObligatorio
ID of the email template to view

Parámetros de salida

dataobjectObligatorio
Details of the email template
errorstring
Error if any occurred during the execution of the action
error_codestring
Error code if the request failed
request_idstringObligatorio
Unique ID for the request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add SMTP UserSMTP2GO_USERS_SMTP_ADDAcción

Tool to add a new smtp user. use when you need to provision a fresh smtp credential after collecting username and password.

Parámetros de entrada

user_dataobjectObligatorio
The SMTP user details to add

Parámetros de salida

dataobjectObligatorio
Details of the newly added SMTP user(s)
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique ID for this API request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Edit SMTP UserSMTP2GO_USERS_SMTP_EDITAcción

Tool to edit details of an existing smtp user. use when you need to update username, password, sender restrictions, or enable/disable a user after confirming the target username.

Parámetros de entrada

disabledboolean
If true, disables this SMTP user entirely.
passwordstring
New password for the SMTP user (minimum 8 characters).
usernamestringObligatorio
The existing SMTP username to edit.
allowed_ipsstring[]
List of IP addresses permitted for this SMTP user. Omit or pass an empty list to allow any IP.
reset_statsboolean
If true, resets all usage statistics for this SMTP user.
new_usernamestring
New SMTP username if you wish to change it.
allow_sendersstring[]
List of specific email addresses this SMTP user is allowed to send from. Omit or pass an empty list to allow any sender.
sender_domainstring
Restrict sending to this domain only (e.g., 'example.com').
disable_sendersboolean
If true, disables all senders for this SMTP user.

Parámetros de salida

dataobjectObligatorio
Details of the edited SMTP user.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API (0 if successful).
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message returned by SMTP2GO API, if any.

Remove SMTP UserSMTP2GO_USERS_SMTP_REMOVEAcción

Tool to remove an smtp user from your account. use when you need to revoke smtp access for a user.

Parámetros de entrada

usernamestringObligatorio
SMTP username to remove, typically an email address or SMTP user ID.

Parámetros de salida

dataobjectObligatorio
Details of the removed SMTP user(s)
errorstring
Error if any occurred during the execution of the action
request_idstringObligatorio
Unique ID for this API request
successfulbooleanObligatorio
Whether or not the action execution was successful or not

View SMTP UsersSMTP2GO_USERS_SMTP_VIEWAcción

Tool to list all smtp users configured on your account. use when you need to retrieve smtp user configurations.

Parámetros de entrada

Sin parámetros.

Parámetros de salida

dataobject[]Obligatorio
List of SMTP user configurations
errorstring
Error if any occurred during the execution of the action
error_codeinteger
SMTP2GO error code if the request failed
successfulbooleanObligatorio
Whether or not the action execution was successful or not

Add WebhookSMTP2GO_WEBHOOK_ADDAcción

Tool to create a new webhook. use when you need real-time notifications of email or sms events.

Parámetros de entrada

namestring
Optional human-readable name for the webhook.
eventsstring[]Obligatorio
List of event types to trigger this webhook.
webhook_urlanyObligatoriouri
The destination URL where SMTP2GO will send event notifications.

Parámetros de salida

dataobjectObligatorio
Details of the created webhook.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API, 0 means success.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message if API call failed.

Edit WebhookSMTP2GO_WEBHOOK_EDITAcción

Tool to edit an existing webhook’s settings. use when you need to update a webhook's configuration after creation.

Parámetros de entrada

urlanyuri
Destination URL where SMTP2GO will POST webhook events
usersstring[]
List of SMTP2GO user IDs for which this webhook should fire
sms_eventsstring[]
List of SMS events that will trigger this webhook
webhook_idstringObligatorio
Unique identifier of the webhook to be edited
output_typestringenum
Format of the webhook payload
jsonform
email_eventsstring[]
List of email events that will trigger this webhook
email_headersstring[]
Custom email headers to include in the webhook payload
authorization_headerstring
Custom authorization header to include with each webhook request

Parámetros de salida

dataobjectObligatorio
Data returned after editing a webhook.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message returned by SMTP2GO API

Remove webhookSMTP2GO_WEBHOOK_REMOVEAcción

Tool to remove a webhook. use when you want to delete a webhook by its id from your smtp2go account.

Parámetros de entrada

webhook_idstringObligatorio
Unique identifier of the webhook to remove

Parámetros de salida

dataobjectObligatorio
Result details of the webhook removal operation
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code: 0 if successful, non-zero if error
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestringObligatorio
Error message if the request failed

View WebhooksSMTP2GO_WEBHOOK_VIEWAcción

Tool to view all webhooks configured in your account. use when you need to inspect existing webhook configurations after setup.

Parámetros de entrada

subaccount_idstring
ID of the subaccount to retrieve webhooks for. If omitted, retrieves webhooks for the main account.

Parámetros de salida

dataobject[]Obligatorio
List of configured webhooks.
errorstring
Error if any occurred during the execution of the action
error_codeintegerObligatorio
Error code returned by SMTP2GO API. 0 indicates success.
successfulbooleanObligatorio
Whether or not the action execution was successful or not
error_messagestring
Error message returned by SMTP2GO API if the call failed.