SMTP2GO connector

1. Install the SDK

   Node.js

   npm install @scalekit-sdk/node

   Python

   pip install scalekit

   Full SDK reference: Node.js | Python

2. Set your credentials

   Add your Scalekit credentials to your .env file. Find values in app.scalekit.com > Developers > API Credentials.

   .env

   SCALEKIT_ENVIRONMENT_URL=<your-environment-url>
   SCALEKIT_CLIENT_ID=<your-client-id>
   SCALEKIT_CLIENT_SECRET=<your-client-secret>

3. Make your first call

   Node.js

   quickstart.ts

   import { ScalekitClient } from '@scalekit-sdk/node'
   import 'dotenv/config'
   
   const scalekit = new ScalekitClient(
     process.env.SCALEKIT_ENV_URL,
     process.env.SCALEKIT_CLIENT_ID,
     process.env.SCALEKIT_CLIENT_SECRET,
   )
   const actions = scalekit.actions
   
   const connector = 'smtp2go'
   const identifier = 'user_123'
   
   // Make your first call
   const result = await actions.executeTool({
     connector,
     identifier,
     toolName: 'smtp2go_view_ip_allow_list',
     toolInput: {},
   })
   console.log(result)

   Python

   quickstart.py

   import os
   from scalekit.client import ScalekitClient
   from dotenv import load_dotenv
   load_dotenv()
   
   scalekit_client = ScalekitClient(
       env_url=os.getenv("SCALEKIT_ENV_URL"),
       client_id=os.getenv("SCALEKIT_CLIENT_ID"),
       client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),
   )
   actions = scalekit_client.actions
   
   connection_name = "smtp2go"
   identifier = "user_123"
   
   # Make your first call
   result = actions.execute_tool(
       tool_input={},
       tool_name="smtp2go_view_ip_allow_list",
       connection_name=connection_name,
       identifier=identifier,
   )
   print(result)

What you can do

Connect this agent connector to let your agent:

• List view ip allow, remove ip allow, enable ip allow — Retrieve the IP addresses on your SMTP2GO account’s IP allow list, along with whether the list is currently enabled
• Webhook view, remove, edit — Retrieve the configuration of the webhook currently set up on the SMTP2GO account
• Details view template — Retrieve the full details of a single email template on the SMTP2GO account, identified by its case-sensitive template ID, including its name, subject, HTML body, text body, template variables, tags, and last-updated timestamp
• Suppressions view — Search and list entries on the SMTP2GO suppression (block) list, with rich filtering by email address, recipient(s), reason(s), suppression type(s), a wildcard string, and a date range, plus fuzzy matching and pagination via continue_token
• Users view smtp — Retrieve SMTP users on your SMTP2GO account
• Emails view single sender, view sent, remove scheduled — List the Single Sender email addresses verified on this SMTP2GO account

Tool list

Use the exact tool names from the Tool list below when you call execute_tool. If you’re not sure which name to use, list the tools available for the current user first.

smtp2go_add_allowed_recipients#Add email addresses and/or domain names to this SMTP2GO account's Allowed Recipients list — an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally control whether the list is currently enforced when sending, and optionally act on behalf of a subaccount.3 params▾

Add email addresses and/or domain names to this SMTP2GO account's Allowed Recipients list — an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally control whether the list is currently enforced when sending, and optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_recipientsarrayrequiredArray of email addresses and/or domain names to add to the Allowed Recipients list. Example: ["user@example.com", "example.com"].

enabledbooleanoptionalWhether the Allowed Recipients list is taken into account when sending mail. If omitted, the account's current setting is left unchanged.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_add_allowed_senders#Add email addresses and/or domain names to this SMTP2GO account's Allowed Senders list — an account-level security allowlist that governs WHO may relay mail through this account. This is distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM. Optionally act on behalf of a subaccount.2 params▾

Add email addresses and/or domain names to this SMTP2GO account's Allowed Senders list — an account-level security allowlist that governs WHO may relay mail through this account. This is distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM. Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_sendersarrayrequiredArray of email addresses and/or domain names to add to the Allowed Senders list. Example: ["user@example.com", "example.com"].

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_add_api_key#Create a new API key on your SMTP2GO account. Configure an optional description, custom send rate limiting, a dedicated IP pool, open/click tracking, an unsubscribe feedback footer, message archiving, an audit BCC address, bounce notification handling, the key's initial status, and which API endpoints it is permitted to call. The new key's secret value is returned in the response — SMTP2GO does not let you choose or view it afterwards.16 params▾

Create a new API key on your SMTP2GO account. Configure an optional description, custom send rate limiting, a dedicated IP pool, open/click tracking, an unsubscribe feedback footer, message archiving, an audit BCC address, bounce notification handling, the key's initial status, and which API endpoints it is permitted to call. The new key's secret value is returned in the response — SMTP2GO does not let you choose or view it afterwards.

NameTypeRequiredDescription

archive_enabledbooleanoptionalWhether to enable message archiving for emails sent with this API key. Archiving is available on paid plans.

audit_emailstringoptionalAn email address to BCC on every message sent using this API key.

bounce_notificationsstringoptionalHow bounce notifications are handled for this API key. Must be one of 'from' (notify the From address), 'drop' (discard bounce notifications), or a specific email address to notify instead.

click_tracking_enabledbooleanoptionalWhether to enable click tracking for emails sent with this API key.

custom_ratelimitbooleanoptionalWhether to enable a custom send rate limit for this API key instead of the account default.

custom_ratelimit_periodstringoptionalThe period the custom rate limit applies to, in the format '<n> [hour(s)|day(s)|week(s)|month(s)] [hh:mm:ss]'. Examples: '0:30:00', '1 hour', '2 days'. Only used when custom_ratelimit is true.

custom_ratelimit_valueintegeroptionalThe number of emails this API key can send within the period defined by custom_ratelimit_period. Only used when custom_ratelimit is true.

descriptionstringoptionalA comment or description to help identify this API key's purpose.

endpointsarrayoptionalArray of API endpoint paths this key is permitted to call. Supports wildcard patterns, e.g. '/email/*'. Defaults to ['/email/send'] if omitted.

feedback_enabledbooleanoptionalWhether to enable a custom unsubscribe feedback footer for emails sent with this API key.

feedback_htmlstringoptionalHTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Only used when feedback_enabled is true.

feedback_textstringoptionalPlain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Only used when feedback_enabled is true.

ip_poolintegeroptionalThe ID of a dedicated IP pool. Emails sent using this API key will be routed through the dedicated IPs in this pool.

open_tracking_enabledbooleanoptionalWhether to enable open tracking for emails sent with this API key.

statusstringoptionalThe initial status of the new API key: 'allowed' (fully active), 'blocked' (cannot send), or 'sandbox' (test mode, no real delivery).

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_add_email_template#Create a new reusable email template on the SMTP2GO account. Requires a caller-assigned unique template ID (5-24 case-sensitive characters), a template name, a subject line, and both an HTML body and a plain text body. Optionally attach template_variables (default pass-through values referenced in the template) and tags for organizing templates.7 params▾

Create a new reusable email template on the SMTP2GO account. Requires a caller-assigned unique template ID (5-24 case-sensitive characters), a template name, a subject line, and both an HTML body and a plain text body. Optionally attach template_variables (default pass-through values referenced in the template) and tags for organizing templates.

NameTypeRequiredDescription

html_bodystringrequiredThe HTML body content of the email template.

idstringrequiredCaller-assigned unique, case-sensitive identifier for the new template. Minimum length 5 characters, maximum length 24 characters. This is not generated by SMTP2GO — you must choose it yourself and it must not collide with an existing template ID.

subjectstringrequiredThe subject line of the email template.

template_namestringrequiredThe display name of the email template. Minimum length 1 character, maximum length 64 characters.

text_bodystringrequiredThe plain text body content of the email template.

tagsarrayoptionalList of tags to associate with this template, for organizing and filtering templates later.

template_variablesobjectoptionalDefault pass-through values for variables used within this template, as a JSON object. Example: {"first_name":"there","company_name":"Acme"}.

smtp2go_add_ip_allow_list#Add an IP address to your SMTP2GO account's IP allow list, permitting it to send (SMTP) or make API calls (API) once the list is enabled via Enable IP Allow List.3 params▾

Add an IP address to your SMTP2GO account's IP allow list, permitting it to send (SMTP) or make API calls (API) once the list is enabled via Enable IP Allow List.

NameTypeRequiredDescription

ip_addressstringrequiredThe IP address to add to the allow list.

descriptionstringoptionalA comment or description for this allow list entry, for your own reference.

typestringoptionalWhich IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.

smtp2go_add_sender_domain#Add a new sender domain to SMTP2GO for DNS-based sending setup (DKIM signing, return-path, and click/open tracking). Returns the DNS records (DKIM, return-path, tracking CNAME) you must publish to complete verification. Distinct from a single sender email — this sets up an entire domain rather than one verified From address.7 params▾

Add a new sender domain to SMTP2GO for DNS-based sending setup (DKIM signing, return-path, and click/open tracking). Returns the DNS records (DKIM, return-path, tracking CNAME) you must publish to complete verification. Distinct from a single sender email — this sets up an entire domain rather than one verified From address.

NameTypeRequiredDescription

domainstringrequiredThe domain name to add as a sender domain, e.g. 'example.com'. You will need to add the returned DKIM, return-path, and tracking DNS records to this domain's DNS.

auto_verifybooleanoptionalIf true, attempt to verify the domain immediately as part of this call, removing the need to separately call the verify-sender-domain endpoint. Defaults to true.

requisition_sslbooleanoptionalIf true, requisition an SSL certificate for the tracking domain once verification completes. Defaults to true.

returnpath_subdomainstringoptionalAn optional subdomain to use as the return-path (bounce handling) subdomain, e.g. 'returns' for returns.example.com.

subaccount_accessobjectoptionalObject controlling which subaccounts may send using this verified sender domain from the master account. Shape: {"subaccounts": ["<subaccount_id>", ...], "future_subaccounts": <bool>}. Use future_subaccounts=true to auto-grant access to subaccounts created later.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

tracking_subdomainstringoptionalAn optional subdomain used for click/open tracking links and unsubscribe links, e.g. 'track' for track.example.com.

smtp2go_add_single_sender_email#Add a single verified sender email address to SMTP2GO. This is the lightweight verification path for sending from one individual From address (an ownership-confirmation email is sent to it) — unlike adding a sender domain, it requires no DNS/DKIM setup and only authorizes that one exact address.3 params▾

Add a single verified sender email address to SMTP2GO. This is the lightweight verification path for sending from one individual From address (an ownership-confirmation email is sent to it) — unlike adding a sender domain, it requires no DNS/DKIM setup and only authorizes that one exact address.

NameTypeRequiredDescription

email_addressstringrequiredThe email address you want to send emails from. A verification email will be sent to this address to confirm ownership.

messagestringoptionalOptional plain-text-only message to include in the verification email sent to the address.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_add_smtp_user#Create a new SMTP user (an SMTP relay login credential) on your SMTP2GO account. Requires a username (5-100 characters). An optional password can be supplied (minimum 64-bit entropy); if omitted, SMTP2GO auto-generates one. Supports configuring a custom sending rate limit, a dedicated IP pool, an unsubscribe/feedback footer, open and click tracking, archiving, an audit BCC address, bounce-notification handling, and the initial account status (allowed, blocked, or sandbox). Optionally scoped to a subaccount.18 params▾

Create a new SMTP user (an SMTP relay login credential) on your SMTP2GO account. Requires a username (5-100 characters). An optional password can be supplied (minimum 64-bit entropy); if omitted, SMTP2GO auto-generates one. Supports configuring a custom sending rate limit, a dedicated IP pool, an unsubscribe/feedback footer, open and click tracking, archiving, an audit BCC address, bounce-notification handling, and the initial account status (allowed, blocked, or sandbox). Optionally scoped to a subaccount.

NameTypeRequiredDescription

usernamestringrequiredSMTP access username for the new SMTP user. Must be 5-100 characters and unique on the account.

archive_enabledbooleanoptionalEnable email archiving for this user (available on paid plans only). Defaults to false.

audit_emailstringoptionalEmail address that should be BCC'd on every outbound message sent by this user.

bounce_notificationsstringoptionalHow bounce notifications are handled: 'from' (send to the message's From address), 'drop' (discard bounce notifications), or a specific email address to receive them. Defaults to 'from'.

click_tracking_enabledbooleanoptionalEnable click tracking for links in emails sent by this user. Defaults to false.

custom_ratelimitbooleanoptionalEnable a custom sending rate limit for this user instead of the account default. Defaults to false.

custom_ratelimit_periodstringoptionalPeriod for the custom rate limit, formatted as '<n> [hour|day|week|month][s] [hh:mm:ss]', e.g. '1 day'. Only applies when custom_ratelimit is true.

custom_ratelimit_valueintegeroptionalMaximum number of emails this user can send within the rate limit period. Only applies when custom_ratelimit is true.

descriptionstringoptionalFree-text comment describing what this SMTP user is used for.

email_passwordstringoptionalSMTP password for this user. Must have at least 64-bit entropy (ideally 12+ characters mixing upper/lowercase, digits, and symbols). If omitted, SMTP2GO generates a secure password automatically.

feedback_domainstringoptionalDomain used for the unsubscribe/feedback footer links. Use the literal value 'default' to let SMTP2GO serve it from its own domain, or supply your own verified domain.

feedback_enabledbooleanoptionalEnable a custom unsubscribe/feedback footer on emails sent by this user. Defaults to false.

feedback_htmlstringoptionalHTML content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.

feedback_textstringoptionalPlain-text content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.

ip_poolintegeroptionalNumeric ID of a dedicated IP pool this user should send through. Find pool IDs via the dedicated IPs view endpoint.

open_tracking_enabledbooleanoptionalEnable open tracking for emails sent by this user. Defaults to false.

statusstringoptionalInitial account status for this SMTP user. One of 'allowed' (can send normally), 'blocked' (sending disabled), or 'sandbox' (test mode, mail is not actually delivered). Defaults to 'allowed'.

subaccount_idstringoptionalID of a subaccount to create this SMTP user on behalf of. Omit to act on the main account.

smtp2go_add_subaccount#Create a new subaccount under your SMTP2GO account. Requires a full name for the subaccount. Supports an initial team-member email, a monthly/billing-cycle sending limit chosen from SMTP2GO's plan-size tiers, auto-assigning a dedicated IP (requires a limit above 100,000), enabling archiving, enforcing two-factor authentication for the subaccount's team members, and enabling SMS with a monthly SMS limit. Rate limited to 50 calls per hour.8 params▾

Create a new subaccount under your SMTP2GO account. Requires a full name for the subaccount. Supports an initial team-member email, a monthly/billing-cycle sending limit chosen from SMTP2GO's plan-size tiers, auto-assigning a dedicated IP (requires a limit above 100,000), enabling archiving, enforcing two-factor authentication for the subaccount's team members, and enabling SMS with a monthly SMS limit. Rate limited to 50 calls per hour.

NameTypeRequiredDescription

fullnamestringrequiredFull name used to identify the new subaccount.

archivingbooleanoptionalAllow this subaccount to enable email archiving. Defaults to false.

dedicated_ipbooleanoptionalAutomatically assign a dedicated sending IP to this subaccount. Requires limit to be greater than 100,000. Defaults to false.

enable_smsbooleanoptionalEnable SMS messaging for this subaccount. Defaults to false.

enforce_2fabooleanoptionalRequire this subaccount's team members to use two-factor authentication. Defaults to false.

limitintegeroptionalMaximum number of emails this subaccount can send per billing cycle. Must be one of SMTP2GO's plan-size tiers. Defaults to 10000. Live-tested: SMTP2GO rejects any tier here that exceeds the parent account's own remaining cycle capacity (see smtp2go_email_cycle_report's cycle_max/cycle_remaining) - on a small/trial parent account, every tier including the smallest (2000) can be rejected with "the passed limit is invalid" (SMTP2GO's own error message omits the actual valid range).

sms_limitintegeroptionalMaximum number of SMS messages this subaccount can send per month. Defaults to 1000.

subaccount_emailstringoptionalEmail address for the first team member of this subaccount.

smtp2go_add_suppression#Add an email address or entire domain to the SMTP2GO suppression (block) list, preventing future deliveries to it. Optionally record a description explaining why it was suppressed, and optionally act on behalf of a subaccount.3 params▾

Add an email address or entire domain to the SMTP2GO suppression (block) list, preventing future deliveries to it. Optionally record a description explaining why it was suppressed, and optionally act on behalf of a subaccount.

NameTypeRequiredDescription

email_addressstringrequiredThe email address or domain to add to the suppression list. Deliveries to this address (or any address at this domain) will be blocked.

block_descriptionstringoptionalA description explaining why this email or domain is being suppressed. Stored alongside the suppression entry.

subaccount_idstringoptionalIf provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.

smtp2go_add_webhook#Register a new webhook on the SMTP2GO account that will POST event data to a target URL. Subscribe to email events (delivered, unsubscribe, spam, bounce, processed, reject, click, open) and/or SMS events (delivered, failed, rejected, sending, submitted). Optionally restrict to specific sending usernames, include custom headers, choose the payload format, and add authentication to the outgoing webhook request.9 params▾

Register a new webhook on the SMTP2GO account that will POST event data to a target URL. Subscribe to email events (delivered, unsubscribe, spam, bounce, processed, reject, click, open) and/or SMS events (delivered, failed, rejected, sending, submitted). Optionally restrict to specific sending usernames, include custom headers, choose the payload format, and add authentication to the outgoing webhook request.

NameTypeRequiredDescription

urlstringrequiredThe callback URL that SMTP2GO will POST event data to.

auth_header_typestringoptionalType of Authorization header SMTP2GO should send with the webhook request: bearer or basic. Leave blank for no authentication header.

auth_header_valuestringoptionalThe value to send in the Authorization header. For basic auth, this should be a base64-encoded 'user:pass' string; for bearer auth, this is the token value.

eventsarrayoptionalList of email events this webhook should receive. Valid values: delivered, unsubscribe, spam, bounce, processed, reject, click, open.

headersarrayoptionalCustom email header names whose values should be included in the webhook event data. These headers must already exist in the emails being sent; the Subject and Message-id headers are always included by default.

output_formatstringoptionalThe payload format SMTP2GO will use when POSTing event data to the webhook URL: form or json.

sms_eventsarrayoptionalList of SMS events this webhook should receive. Valid values: delivered, failed, rejected, sending, submitted.

subaccount_idstringoptionalIf provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.

usernamesarrayoptionalSMTP2GO sending usernames to restrict this webhook to. If omitted, events from all usernames are included.

smtp2go_close_subaccount#Close an existing subaccount by its subaccount ID, suspending its ability to send. This is reversible — use smtp2go_reopen_subaccount to reopen a closed subaccount later.2 params▾

Close an existing subaccount by its subaccount ID, suspending its ability to send. This is reversible — use smtp2go_reopen_subaccount to reopen a closed subaccount later.

NameTypeRequiredDescription

idstringrequiredUnique ID of the subaccount to close.

emailstringoptionalEmail address associated with the subaccount to close.

smtp2go_edit_api_key#Edit an existing SMTP2GO API key by its ID. Only the fields you provide are changed; any field left blank keeps its current configured value on the key. Use this to update the description, custom rate limiting, dedicated IP pool, tracking/feedback settings, archiving, audit BCC address, bounce notification handling, status, or permitted endpoints.17 params▾

Edit an existing SMTP2GO API key by its ID. Only the fields you provide are changed; any field left blank keeps its current configured value on the key. Use this to update the description, custom rate limiting, dedicated IP pool, tracking/feedback settings, archiving, audit BCC address, bounce notification handling, status, or permitted endpoints.

NameTypeRequiredDescription

idstringrequiredThe ID of the existing API key to edit.

archive_enabledbooleanoptionalWhether to enable message archiving for emails sent with this API key. Archiving is available on paid plans. Leave blank to keep the current setting.

audit_emailstringoptionalAn email address to BCC on every message sent using this API key. Leave blank to keep the current value.

bounce_notificationsstringoptionalHow bounce notifications are handled for this API key. Must be one of 'from' (notify the From address), 'drop' (discard bounce notifications), or a specific email address to notify instead. Leave blank to keep the current setting.

click_tracking_enabledbooleanoptionalWhether to enable click tracking for emails sent with this API key. Leave blank to keep the current setting.

custom_ratelimitbooleanoptionalWhether to enable a custom send rate limit for this API key instead of the account default. Leave blank to keep the current setting.

custom_ratelimit_periodstringoptionalThe period the custom rate limit applies to, in the format '<n> [hour(s)|day(s)|week(s)|month(s)] [hh:mm:ss]'. Examples: '0:30:00', '1 hour', '2 days'. Only used when custom_ratelimit is true. Leave blank to keep the current value.

custom_ratelimit_valueintegeroptionalThe number of emails this API key can send within the period defined by custom_ratelimit_period. Only used when custom_ratelimit is true. Leave blank to keep the current value.

descriptionstringoptionalA comment or description to help identify this API key's purpose. Leave blank to keep the current description.

endpointsarrayoptionalArray of API endpoint paths this key is permitted to call. Supports wildcard patterns, e.g. '/email/*'. Documented as optional (leave blank to keep the current list), but live-tested behavior shows the API currently rejects the request with "At least one permission must be selected" when this is omitted entirely - pass the key's current endpoint list explicitly to avoid that error.

feedback_enabledbooleanoptionalWhether to enable a custom unsubscribe feedback footer for emails sent with this API key. Leave blank to keep the current setting.

feedback_htmlstringoptionalHTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Leave blank to keep the current value.

feedback_textstringoptionalPlain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Leave blank to keep the current value.

ip_poolintegeroptionalThe ID of a dedicated IP pool. Emails sent using this API key will be routed through the dedicated IPs in this pool. Leave blank to keep the current value.

open_tracking_enabledbooleanoptionalWhether to enable open tracking for emails sent with this API key. Leave blank to keep the current setting.

statusstringoptionalThe status of the API key: 'allowed' (fully active), 'blocked' (cannot send), or 'sandbox' (test mode, no real delivery). Leave blank to keep the current status.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_edit_ip_allow_list#Edit an existing entry on your SMTP2GO account's IP allow list, identified by its current IP address. Use new_ip_address to change the allowed IP, or description to update its note.4 params▾

Edit an existing entry on your SMTP2GO account's IP allow list, identified by its current IP address. Use new_ip_address to change the allowed IP, or description to update its note.

NameTypeRequiredDescription

ip_addressstringrequiredThe current IP address of the existing allow list entry to edit.

descriptionstringoptionalA comment or description for this allow list entry, for your own reference.

new_ip_addressstringoptionalA new IP address to replace the existing entry with.

typestringoptionalWhich IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.

smtp2go_edit_return_path_domain#Change the return-path (bounce handling) subdomain used by an already-added sender domain in SMTP2GO. Provide the sender domain, its current return-path subdomain, and the new return-path subdomain you want to switch to; you will then need to update the CNAME DNS record to match the new subdomain before it verifies.4 params▾

Change the return-path (bounce handling) subdomain used by an already-added sender domain in SMTP2GO. Provide the sender domain, its current return-path subdomain, and the new return-path subdomain you want to switch to; you will then need to update the CNAME DNS record to match the new subdomain before it verifies.

NameTypeRequiredDescription

domainstringrequiredThe sender domain whose return-path subdomain you want to change, e.g. 'example.com'. Must already be added as a sender domain.

new_subdomainstringrequiredThe new return-path subdomain to switch to, e.g. 'return'. You'll need to add a matching CNAME DNS record for it to verify.

old_subdomainstringrequiredThe domain's current return-path subdomain, e.g. 'returns'.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_edit_smtp_user#Update an existing SMTP user's settings on your SMTP2GO account by username. Boolean and status fields left unset are reset to their SMTP2GO defaults (this is a full update, not a partial patch — use smtp2go_patch_smtp_user if you only want to change a subset of fields and leave everything else untouched). Supports changing the password, description, custom rate limit, dedicated IP pool, feedback footer, tracking, archiving, audit BCC address, bounce-notification handling, and account status. Optionally scoped to a subaccount.18 params▾

Update an existing SMTP user's settings on your SMTP2GO account by username. Boolean and status fields left unset are reset to their SMTP2GO defaults (this is a full update, not a partial patch — use smtp2go_patch_smtp_user if you only want to change a subset of fields and leave everything else untouched). Supports changing the password, description, custom rate limit, dedicated IP pool, feedback footer, tracking, archiving, audit BCC address, bounce-notification handling, and account status. Optionally scoped to a subaccount.

NameTypeRequiredDescription

usernamestringrequiredUsername of the existing SMTP user to edit.

archive_enabledbooleanoptionalEnable email archiving for this user (available on paid plans only). Defaults to false.

audit_emailstringoptionalEmail address that should be BCC'd on every outbound message sent by this user.

bounce_notificationsstringoptionalHow bounce notifications are handled: 'from' (send to the message's From address), 'drop' (discard bounce notifications), or a specific email address to receive them. Defaults to 'from'.

click_tracking_enabledbooleanoptionalEnable click tracking for links in emails sent by this user. Defaults to false.

custom_ratelimitbooleanoptionalEnable a custom sending rate limit for this user instead of the account default. Defaults to false.

custom_ratelimit_periodstringoptionalPeriod for the custom rate limit, formatted as '<n> [hour|day|week|month][s] [hh:mm:ss]', e.g. '1 day'. Only applies when custom_ratelimit is true.

custom_ratelimit_valueintegeroptionalMaximum number of emails this user can send within the rate limit period. Only applies when custom_ratelimit is true.

descriptionstringoptionalFree-text comment describing what this SMTP user is used for.

email_passwordstringoptionalNew SMTP password for this user. Must have at least 64-bit entropy (ideally 12+ characters mixing upper/lowercase, digits, and symbols). If omitted, SMTP2GO generates a secure password automatically.

feedback_domainstringoptionalDomain used for the unsubscribe/feedback footer links. Use the literal value 'default' to let SMTP2GO serve it from its own domain, or supply your own verified domain.

feedback_enabledbooleanoptionalEnable a custom unsubscribe/feedback footer on emails sent by this user. Defaults to false.

feedback_htmlstringoptionalHTML content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.

feedback_textstringoptionalPlain-text content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.

ip_poolintegeroptionalNumeric ID of a dedicated IP pool this user should send through. Find pool IDs via the dedicated IPs view endpoint.

open_tracking_enabledbooleanoptionalEnable open tracking for emails sent by this user. Defaults to false.

statusstringoptionalAccount status for this SMTP user. One of 'allowed' (can send normally), 'blocked' (sending disabled), or 'sandbox' (test mode, mail is not actually delivered).

subaccount_idstringoptionalID of a subaccount this SMTP user belongs to, to make this edit on behalf of that subaccount. Omit to act on the main account.

smtp2go_edit_subaccount_access#Set which subaccounts are allowed to send using a verified sender domain owned by the master account. Replaces the current access list for the given domain with the provided list of subaccount IDs, and optionally auto-grants access to any subaccounts created in the future. Find subaccount IDs via the subaccount search endpoint.3 params▾

Set which subaccounts are allowed to send using a verified sender domain owned by the master account. Replaces the current access list for the given domain with the provided list of subaccount IDs, and optionally auto-grants access to any subaccounts created in the future. Find subaccount IDs via the subaccount search endpoint.

NameTypeRequiredDescription

domainstringrequiredThe sender domain to edit subaccount access for, e.g. 'example.com'. Must already be a verified sender domain on the master account.

subaccountsarrayrequiredList of subaccount IDs to grant access to this sender domain. This replaces the existing access list. Find subaccount IDs via the /subaccounts/search endpoint.

future_subaccountsbooleanoptionalIf true, any subaccounts created in the future will automatically be granted access to this sender domain. Defaults to false.

smtp2go_edit_tracking_domain#Change the click/open tracking subdomain used by an already-added sender domain in SMTP2GO. Provide the sender domain, its current tracking subdomain, and the new tracking subdomain you want to switch to; you will then need to update the CNAME DNS record to match the new subdomain before it verifies.4 params▾

Change the click/open tracking subdomain used by an already-added sender domain in SMTP2GO. Provide the sender domain, its current tracking subdomain, and the new tracking subdomain you want to switch to; you will then need to update the CNAME DNS record to match the new subdomain before it verifies.

NameTypeRequiredDescription

domainstringrequiredThe sender domain whose tracking subdomain you want to change, e.g. 'example.com'. Must already be added as a sender domain.

new_subdomainstringrequiredThe new tracking subdomain to switch to, e.g. 'link'. You'll need to add a matching CNAME DNS record for it to verify.

old_subdomainstringrequiredThe domain's current tracking subdomain, e.g. 'track'.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_edit_webhook#Edit an existing SMTP2GO webhook by its ID. Only the fields you provide are changed; any field left blank keeps its current configured value on the webhook. Use this to update the target URL, the subscribed email/SMS events, custom headers, usernames, output format, or authentication header settings.10 params▾

Edit an existing SMTP2GO webhook by its ID. Only the fields you provide are changed; any field left blank keeps its current configured value on the webhook. Use this to update the target URL, the subscribed email/SMS events, custom headers, usernames, output format, or authentication header settings.

NameTypeRequiredDescription

idintegerrequiredThe numeric ID of the existing webhook to edit. Find this from the webhook's details in your SMTP2GO dashboard or a prior webhook list/view call.

auth_header_typestringoptionalType of authentication header to send with each webhook call: 'bearer' or 'basic'. Leave blank to keep the current setting.

auth_header_valuestringoptionalValue of the authentication header to send with each webhook call (e.g. the bearer token or basic auth credentials). Leave blank to keep the current value.

eventsarrayoptionalList of email events this webhook should receive. Valid values: delivered, unsubscribe, spam, bounce, processed, reject, click, open. Leave blank to keep the current event list.

headersarrayoptionalCustom headers you would like sent along with the webhook event data. Leave blank to keep the current header list.

output_formatstringoptionalFormat the webhook payload should be sent in: 'form' (application/x-www-form-urlencoded) or 'json'. Leave blank to keep the current format.

sms_eventsarrayoptionalList of SMS events this webhook should receive. Valid values: delivered, failed, rejected, sending, submitted. Leave blank to keep the current event list.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

urlstringoptionalNew URL the webhook should send event data to. Documented as optional (leave blank to keep the current URL), but live-tested behavior shows the API currently rejects the request with a field_validation_error ("url was expecting a value but was empty or missing") when this is omitted - pass the webhook's current URL explicitly to avoid that error.

usernamesarrayoptionalList of SMTP2GO usernames whose activity should trigger this webhook. Leave blank to keep the current list.

smtp2go_email_bounces_report#Retrieve email bounce statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, hard bounce count, soft bounce count, reject count, and the overall bounce percentage.1 param▾

Retrieve email bounce statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, hard bounce count, soft bounce count, reject count, and the overall bounce percentage.

NameTypeRequiredDescription

usernamestringoptionalRestrict the bounce statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.

smtp2go_email_cycle_report#Retrieve the current email billing/usage cycle for the SMTP2GO account, including the cycle start and end dates and how many emails have been used, remain, and are allotted for the current cycle. Takes no input parameters.0 params▾

Retrieve the current email billing/usage cycle for the SMTP2GO account, including the cycle start and end dates and how many emails have been used, remain, and are allotted for the current cycle. Takes no input parameters.

smtp2go_email_history_report#Retrieve a time-series history of email sending activity from SMTP2GO, grouped by email address, username, domain, or subaccount. Returns aggregate percentages (bounce, open, reject, spam, unsubscribe) plus a per-period history array covering volume sent, bounces, clicks, opens, rejects, spam, and unsubscribes. Defaults to the trailing 30 days when no date range is given.4 params▾

Retrieve a time-series history of email sending activity from SMTP2GO, grouped by email address, username, domain, or subaccount. Returns aggregate percentages (bounce, open, reject, spam, unsubscribe) plus a per-period history array covering volume sent, bounces, clicks, opens, rejects, spam, and unsubscribes. Defaults to the trailing 30 days when no date range is given.

NameTypeRequiredDescription

end_datestringoptionalEnd of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.

group_bystringoptionalControls how the returned history is grouped. One of email_address, username, domain, or subaccount. Defaults to email_address.

start_datestringoptionalStart of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 30 days before the current time.

subaccountsarrayoptionalList of subaccount IDs to restrict the report to. Omit to include activity from all subaccounts.

smtp2go_email_spam_report#Retrieve spam complaint statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, reject count, spam complaint count, and the overall spam percentage.1 param▾

Retrieve spam complaint statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, reject count, spam complaint count, and the overall spam percentage.

NameTypeRequiredDescription

usernamestringoptionalRestrict the spam statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.

smtp2go_email_summary_report#Retrieve an overall sending summary for the SMTP2GO account, or for a single user on the account, for the current billing cycle. Includes cycle start/end dates, emails used/remaining/max for the cycle, total emails sent, bounce/spam/unsubscribe counts and percentages, and open/click counts.1 param▾

Retrieve an overall sending summary for the SMTP2GO account, or for a single user on the account, for the current billing cycle. Includes cycle start/end dates, emails used/remaining/max for the cycle, total emails sent, bounce/spam/unsubscribe counts and percentages, and open/click counts.

NameTypeRequiredDescription

usernamestringoptionalRestrict the summary statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.

smtp2go_email_unsubscribes_report#Retrieve unsubscribe statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, unsubscribe count, reject count, and the overall unsubscribe percentage.1 param▾

Retrieve unsubscribe statistics for the SMTP2GO account, or for a single user on the account, including total emails sent, unsubscribe count, reject count, and the overall unsubscribe percentage.

NameTypeRequiredDescription

usernamestringoptionalRestrict the unsubscribe statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.

smtp2go_enable_ip_allow_list#Enable or disable the IP allow list on your SMTP2GO account. When enabled, only IP addresses added via Add IP Allow List are permitted to send (SMTP) or make API calls (API), depending on the selected list type. Disabling turns off enforcement without removing the configured entries.2 params▾

Enable or disable the IP allow list on your SMTP2GO account. When enabled, only IP addresses added via Add IP Allow List are permitted to send (SMTP) or make API calls (API), depending on the selected list type. Disabling turns off enforcement without removing the configured entries.

NameTypeRequiredDescription

enabledbooleanrequiredWhether the IP allow list should be enabled (true) or disabled (false).

typestringoptionalWhich IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.

smtp2go_patch_api_key#Partially update an existing SMTP2GO API key by its ID, ignoring any properties you don't include. Unlike Edit API Key, this uses an HTTP PATCH so only the fields you explicitly set are changed — every other field on the key is left exactly as it was. Use this for small, targeted changes such as flipping a single tracking flag or updating the status.17 params▾

Partially update an existing SMTP2GO API key by its ID, ignoring any properties you don't include. Unlike Edit API Key, this uses an HTTP PATCH so only the fields you explicitly set are changed — every other field on the key is left exactly as it was. Use this for small, targeted changes such as flipping a single tracking flag or updating the status.

NameTypeRequiredDescription

idstringrequiredThe ID of the existing API key to patch.

archive_enabledbooleanoptionalWhether to enable message archiving for emails sent with this API key. Archiving is available on paid plans. Omit to leave the current setting untouched.

audit_emailstringoptionalAn email address to BCC on every message sent using this API key. Omit to leave the current value untouched.

bounce_notificationsstringoptionalHow bounce notifications are handled for this API key. Must be one of 'from' (notify the From address), 'drop' (discard bounce notifications), or a specific email address to notify instead. Omit to leave the current setting untouched.

click_tracking_enabledbooleanoptionalWhether to enable click tracking for emails sent with this API key. Omit to leave the current setting untouched.

custom_ratelimitbooleanoptionalWhether to enable a custom send rate limit for this API key instead of the account default. Omit to leave the current setting untouched.

custom_ratelimit_periodstringoptionalThe period the custom rate limit applies to, in the format '<n> [hour(s)|day(s)|week(s)|month(s)] [hh:mm:ss]'. Examples: '0:30:00', '1 hour', '2 days'. Only used when custom_ratelimit is true. Omit to leave the current value untouched.

custom_ratelimit_valueintegeroptionalThe number of emails this API key can send within the period defined by custom_ratelimit_period. Only used when custom_ratelimit is true. Omit to leave the current value untouched.

descriptionstringoptionalA comment or description to help identify this API key's purpose. Omit to leave the current description untouched.

endpointsarrayoptionalArray of API endpoint paths this key is permitted to call. Supports wildcard patterns, e.g. '/email/*'. Omit to leave the current list untouched.

feedback_enabledbooleanoptionalWhether to enable a custom unsubscribe feedback footer for emails sent with this API key. Omit to leave the current setting untouched.

feedback_htmlstringoptionalHTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Omit to leave the current value untouched.

feedback_textstringoptionalPlain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Omit to leave the current value untouched.

ip_poolintegeroptionalThe ID of a dedicated IP pool. Emails sent using this API key will be routed through the dedicated IPs in this pool. Omit to leave the current value untouched.

open_tracking_enabledbooleanoptionalWhether to enable open tracking for emails sent with this API key. Omit to leave the current setting untouched.

statusstringoptionalThe status of the API key: 'allowed' (fully active), 'blocked' (cannot send), or 'sandbox' (test mode, no real delivery). Omit to leave the current status untouched.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_patch_ip_auth#Partially update an existing IP-based authentication (IP Auth) entry in SMTP2GO, identified by its IP address. Only the fields you provide are changed; omitted fields keep their current server-side values. Use this to adjust rate limits, tracking/archiving toggles, feedback footer content, bounce notification routing, or the allowed/blocked/sandbox status of the IP Auth entry.16 params▾

Partially update an existing IP-based authentication (IP Auth) entry in SMTP2GO, identified by its IP address. Only the fields you provide are changed; omitted fields keep their current server-side values. Use this to adjust rate limits, tracking/archiving toggles, feedback footer content, bounce notification routing, or the allowed/blocked/sandbox status of the IP Auth entry.

NameTypeRequiredDescription

ip_addressstringrequiredThe IP address of the existing IP Auth entry to edit. Must match an IP Auth entry already configured on the account.

archive_enabledbooleanoptionalWhether sent-email archiving is enabled for this IP Auth entry.

audit_emailstringoptionalAn email address that will be BCC'd on every email sent through this IP Auth entry.

bounce_notificationsstringoptionalWhere bounce notifications for this IP Auth entry are sent. Must be one of 'from' (send back to the From address), 'drop' (discard bounce notifications), or a valid email address to receive them.

click_tracking_enabledbooleanoptionalWhether click tracking is enabled for emails sent through this IP Auth entry.

custom_ratelimitbooleanoptionalWhether a custom rate limit is enabled for this IP Auth entry. When true, custom_ratelimit_value and custom_ratelimit_period define the limit.

custom_ratelimit_periodstringoptionalThe period over which custom_ratelimit_value applies. Format: '<n> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]', e.g. '1 day 00:00:00'.

custom_ratelimit_valueintegeroptionalThe number of emails this IP Auth entry may send within the period defined by custom_ratelimit_period. Only applied when custom_ratelimit is true.

descriptionstringoptionalA comment or description for this IP Auth entry, for your own reference.

feedback_enabledbooleanoptionalWhether custom feedback (unsubscribe footer) content is enabled for emails sent through this IP Auth entry.

feedback_htmlstringoptionalHTML content inserted into the custom feedback/unsubscribe footer of the email body. Only used when feedback_enabled is true.

feedback_textstringoptionalPlain text content inserted into the custom feedback/unsubscribe footer of the email body. Only used when feedback_enabled is true.

ip_poolintegeroptionalID of the IP Pool. Emails sent using this IP Auth entry will use the dedicated IPs in this pool.

open_tracking_enabledbooleanoptionalWhether open tracking is enabled for emails sent through this IP Auth entry.

statusstringoptionalAccess status for this IP Auth entry. One of: allowed, blocked, sandbox.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_patch_smtp_user#Partially update an existing SMTP user on your SMTP2GO account by username. Unlike smtp2go_edit_smtp_user, any field you leave unset here is left completely unchanged on the SMTP user — only the fields you explicitly provide are modified. Supports changing the password, description, custom rate limit, dedicated IP pool, feedback footer text/HTML, tracking, archiving, audit BCC address, bounce-notification handling, and account status. Optionally scoped to a subaccount.17 params▾

Partially update an existing SMTP user on your SMTP2GO account by username. Unlike smtp2go_edit_smtp_user, any field you leave unset here is left completely unchanged on the SMTP user — only the fields you explicitly provide are modified. Supports changing the password, description, custom rate limit, dedicated IP pool, feedback footer text/HTML, tracking, archiving, audit BCC address, bounce-notification handling, and account status. Optionally scoped to a subaccount.

NameTypeRequiredDescription

usernamestringrequiredUsername of the existing SMTP user to partially update.

archive_enabledbooleanoptionalEnable or disable email archiving for this user (paid plans only). Leave unset to keep the current setting.

audit_emailstringoptionalEmail address that should be BCC'd on every outbound message sent by this user. Leave unset to keep the current value.

bounce_notificationsstringoptionalHow bounce notifications are handled: 'from', 'drop', or a specific email address. Leave unset to keep the current value.

click_tracking_enabledbooleanoptionalEnable or disable click tracking for links in emails sent by this user. Leave unset to keep the current setting.

custom_ratelimitbooleanoptionalEnable or disable a custom sending rate limit for this user. Leave unset to keep the current setting.

custom_ratelimit_periodstringoptionalPeriod for the custom rate limit, formatted as '<n> [hour|day|week|month][s] [hh:mm:ss]', e.g. '1 day'. Leave unset to keep the current value.

custom_ratelimit_valueintegeroptionalMaximum number of emails this user can send within the rate limit period. Leave unset to keep the current value.

descriptionstringoptionalFree-text comment describing what this SMTP user is used for. Leave unset to keep the current value.

email_passwordstringoptionalNew SMTP password for this user. Must have at least 64-bit entropy. Leave unset to keep the current password unchanged.

feedback_enabledbooleanoptionalEnable or disable the custom unsubscribe/feedback footer. Leave unset to keep the current setting.

feedback_htmlstringoptionalHTML content for the feedback/unsubscribe footer. Supports %%UNSUBSCRIBE%% and %%EMAIL%%. Leave unset to keep the current value.

feedback_textstringoptionalPlain-text content for the feedback/unsubscribe footer. Supports %%UNSUBSCRIBE%% and %%EMAIL%%. Leave unset to keep the current value.

ip_poolintegeroptionalNumeric ID of a dedicated IP pool this user should send through. Leave unset to keep the current value.

open_tracking_enabledbooleanoptionalEnable or disable open tracking for emails sent by this user. Leave unset to keep the current setting.

statusstringoptionalAccount status for this SMTP user. One of 'allowed', 'blocked', or 'sandbox'. Leave unset to keep the current status.

subaccount_idstringoptionalID of a subaccount this SMTP user belongs to, to make this update on behalf of that subaccount. Omit to act on the main account.

smtp2go_remove_allowed_recipients#Remove specific email addresses and/or domain names from this SMTP2GO account's Allowed Recipients list. No error is raised if an address or domain does not currently exist in the list. Optionally control whether the list is currently enforced when sending, and optionally act on behalf of a subaccount.3 params▾

Remove specific email addresses and/or domain names from this SMTP2GO account's Allowed Recipients list. No error is raised if an address or domain does not currently exist in the list. Optionally control whether the list is currently enforced when sending, and optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_recipientsarrayrequiredArray of email addresses and/or domain names to remove from the Allowed Recipients list. Example: ["user@example.com", "example.com"]. No error occurs if an entry is not present in the list.

enabledbooleanoptionalWhether the Allowed Recipients list is taken into account when sending mail. If omitted, the account's current setting is left unchanged.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_remove_allowed_senders#Remove specific email addresses and/or domain names from this SMTP2GO account's Allowed Senders list. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Optionally act on behalf of a subaccount.2 params▾

Remove specific email addresses and/or domain names from this SMTP2GO account's Allowed Senders list. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_sendersarrayrequiredArray of email addresses and/or domain names to remove from the Allowed Senders list. Example: ["user@example.com", "example.com"].

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_remove_api_key#Permanently remove an existing API key from your SMTP2GO account by its ID. Any integration still using this key will immediately lose access. This action cannot be undone.2 params▾

Permanently remove an existing API key from your SMTP2GO account by its ID. Any integration still using this key will immediately lose access. This action cannot be undone.

NameTypeRequiredDescription

idstringrequiredThe ID of the existing API key to remove.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_remove_email_template#Permanently delete an email template from the SMTP2GO account, identified by its case-sensitive template ID. This action cannot be undone.1 param▾

Permanently delete an email template from the SMTP2GO account, identified by its case-sensitive template ID. This action cannot be undone.

NameTypeRequiredDescription

idstringrequiredThe case-sensitive ID of the email template to remove.

smtp2go_remove_ip_allow_list#Permanently remove an IP address from your SMTP2GO account's IP allow list. This action cannot be undone.2 params▾

Permanently remove an IP address from your SMTP2GO account's IP allow list. This action cannot be undone.

NameTypeRequiredDescription

ip_addressstringrequiredThe IP address to remove from the allow list.

typestringoptionalWhich IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.

smtp2go_remove_ip_auth#Permanently remove an existing IP-based authentication (IP Auth) entry from SMTP2GO, identified by its IP address. This deletes the allowlist/blocklist entry and any custom settings (rate limits, tracking, feedback footer) attached to it. This action cannot be undone.2 params▾

Permanently remove an existing IP-based authentication (IP Auth) entry from SMTP2GO, identified by its IP address. This deletes the allowlist/blocklist entry and any custom settings (rate limits, tracking, feedback footer) attached to it. This action cannot be undone.

NameTypeRequiredDescription

ip_addressstringrequiredThe IP address of the existing IP Auth entry to remove. Must match an IP Auth entry already configured on the account.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_remove_scheduled_emails#Cancel a previously scheduled email so it will not be sent. Requires the schedule_id returned when the email was scheduled via the Send Email, Send MIME Email, or Search Scheduled Emails tools. This permanently removes the pending send — once the email has already gone out, there is nothing left to cancel.1 param▾

Cancel a previously scheduled email so it will not be sent. Requires the schedule_id returned when the email was scheduled via the Send Email, Send MIME Email, or Search Scheduled Emails tools. This permanently removes the pending send — once the email has already gone out, there is nothing left to cancel.

NameTypeRequiredDescription

schedule_idstringrequiredThe schedule_id of the scheduled email to cancel, as returned by the Send Email, Send MIME Email, or Search Scheduled Emails tools.

smtp2go_remove_sender_domain#Permanently delete a sender domain from SMTP2GO, along with its DKIM/return-path configuration and any tracking domain (CNAME) setup. Email can no longer be sent from this domain through SMTP2GO once removed. This action cannot be undone.2 params▾

Permanently delete a sender domain from SMTP2GO, along with its DKIM/return-path configuration and any tracking domain (CNAME) setup. Email can no longer be sent from this domain through SMTP2GO once removed. This action cannot be undone.

NameTypeRequiredDescription

domainstringrequiredThe sender domain to delete, e.g. 'example.com'. Must already be added as a sender domain.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_remove_single_sender_email#Remove a verified Single Sender email address from this SMTP2GO account, so it can no longer be used as a verified FROM address. This is distinct from the account-level Allowed Senders relay allowlist. Optionally act on behalf of a subaccount.2 params▾

Remove a verified Single Sender email address from this SMTP2GO account, so it can no longer be used as a verified FROM address. This is distinct from the account-level Allowed Senders relay allowlist. Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

email_addressstringrequiredThe exact email address to remove from the account's verified Single Sender Emails.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_remove_smtp_user#Permanently remove an existing SMTP user (SMTP relay credential) from your SMTP2GO account by username. Any application or service still using this username/password to send mail will immediately stop being able to authenticate. This action cannot be undone — a new SMTP user with the same username can be created afterward, but it will be a different credential.2 params▾

Permanently remove an existing SMTP user (SMTP relay credential) from your SMTP2GO account by username. Any application or service still using this username/password to send mail will immediately stop being able to authenticate. This action cannot be undone — a new SMTP user with the same username can be created afterward, but it will be a different credential.

NameTypeRequiredDescription

usernamestringrequiredUsername of the existing SMTP user to remove.

subaccount_idstringoptionalID of a subaccount this SMTP user belongs to, to make this removal on behalf of that subaccount. Omit to act on the main account.

smtp2go_remove_suppression#Remove an email address or domain from the SMTP2GO suppression (block) list for one or more specific block types (reasons), re-enabling delivery for those block types. Other block types on the same address/domain not listed in reasons remain suppressed.3 params▾

Remove an email address or domain from the SMTP2GO suppression (block) list for one or more specific block types (reasons), re-enabling delivery for those block types. Other block types on the same address/domain not listed in reasons remain suppressed.

NameTypeRequiredDescription

email_addressstringrequiredThe email address or domain to remove from the suppression list.

reasonsarrayrequiredThe block types (reasons) to remove for the given email address or domain. Valid values: manual, spam, unsubscribe, bounce, compliance.

subaccount_idstringoptionalIf provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.

smtp2go_remove_webhook#Permanently remove an existing webhook from your SMTP2GO account by its ID. This stops event notifications from being sent to the webhook's URL. This action cannot be undone.2 params▾

Permanently remove an existing webhook from your SMTP2GO account by its ID. This stops event notifications from being sent to the webhook's URL. This action cannot be undone.

NameTypeRequiredDescription

idintegerrequiredThe numeric ID of the existing webhook to remove. Find this from the webhook's details in your SMTP2GO dashboard or a prior webhook list/view call.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_reopen_subaccount#Reopen a previously closed subaccount by its subaccount ID, restoring its ability to send.2 params▾

Reopen a previously closed subaccount by its subaccount ID, restoring its ability to send.

NameTypeRequiredDescription

idstringrequiredUnique ID of the closed subaccount to reopen.

emailstringoptionalEmail address associated with the subaccount to reopen.

smtp2go_search_activity#Search delivery activity events (processed, delivered, bounced, opened, clicked, etc.) for emails sent through SMTP2GO within a date range. Filter by free-form search text, email_id, subject, sender, recipient, sending usernames, subaccounts, or specific event_types, and paginate via continue_token. By default only_latest and only_latest_by_sent are off, so every matching event is returned rather than just the most recent one per email.17 params▾

Search delivery activity events (processed, delivered, bounced, opened, clicked, etc.) for emails sent through SMTP2GO within a date range. Filter by free-form search text, email_id, subject, sender, recipient, sending usernames, subaccounts, or specific event_types, and paginate via continue_token. By default only_latest and only_latest_by_sent are off, so every matching event is returned rather than just the most recent one per email.

NameTypeRequiredDescription

continue_tokenstringoptionalPagination token returned by a previous search when more results were available than the limit allowed. Pass it back to continue from where the previous page left off.

custom_headersarrayoptionalArray of custom header names to extract from each email's raw headers and include in the response, e.g. X-MyCustomID.

end_datestringoptionalISO-8601 formatted datetime (UTC), exclusive upper bound of the search range. Defaults to now if omitted.

event_typesarrayoptionalArray of event types to restrict results to. Valid values: processed, soft-bounced, hard-bounced, rejected, spam, delivered, unsubscribed, resubscribed, opened, clicked.

include_headersbooleanoptionalWhen true, includes the full email headers in each returned event. Defaults to false.

limitintegeroptionalMaximum number of activity events to return, up to 1000. Defaults to 100.

only_latestbooleanoptionalWhen true, returns only the most recent event per email instead of every matching event. Defaults to false.

only_latest_by_sentbooleanoptionalWhen true, returns only the most recent event per email ordered by the email's sent date, overriding only_latest if both are set. Defaults to false.

regionstringoptionalForces this search to a specific regional datacenter (us, eu, or au), independent of the connection's API Region setting.

searchstringoptionalReturns all events for emails containing this string in any of the searchable fields (subject, sender, recipient, etc.). Separate multiple text values with '|' to match any of them.

search_email_idstringoptionalRestrict results to events for this specific email_id.

search_recipientstringoptionalRestrict results to events for emails addressed to this recipient.

search_senderstringoptionalRestrict results to events for emails sent from this sender address.

search_subjectstringoptionalRestrict results to events for emails whose subject matches this text.

search_usernamesarrayoptionalArray of SMTP2GO usernames to restrict results to emails sent by any of these users.

start_datestringoptionalISO-8601 formatted datetime (UTC), inclusive lower bound of the search range (e.g. 2026-08-01 or 2026-08-01T00:00:00Z). Defaults to midnight of the current date if omitted.

subaccountsarrayoptionalArray of subaccount IDs to restrict results to activity belonging to any of these subaccounts.

smtp2go_search_archived_emails#Search up to 5,000 archived emails (requires Email Archiving to be enabled on the SMTP2GO account) within a date range, filtered by username, recipient, sender, envelope_from, subject, or a substring match against headers. Supports pagination via continue_token. Use the Search Archived Emails to find an email_id, then pass it to the View Archived Email tool to fetch the full archived content.10 params▾

Search up to 5,000 archived emails (requires Email Archiving to be enabled on the SMTP2GO account) within a date range, filtered by username, recipient, sender, envelope_from, subject, or a substring match against headers. Supports pagination via continue_token. Use the Search Archived Emails to find an email_id, then pass it to the View Archived Email tool to fetch the full archived content.

NameTypeRequiredDescription

continue_tokenstringoptionalPagination token returned by a previous search when more results were available than the limit allowed. Pass it back to continue from where the previous page left off.

end_datestringoptionalISO-8601 formatted datetime (UTC), inclusive upper bound of the search range. Defaults to the current time if omitted.

envelope_fromstringoptionalRestrict results to archived emails with this SMTP envelope-from address (may differ from the visible From/sender header).

headersstringoptionalRestrict results to archived emails containing this substring anywhere in their headers.

limitintegeroptionalMaximum number of archived emails to return. Defaults to 5000.

recipientstringoptionalRestrict results to archived emails addressed to this recipient.

senderstringoptionalRestrict results to archived emails sent from this sender address.

start_datestringoptionalISO-8601 formatted datetime (UTC), inclusive lower bound of the search range. Defaults to midnight of the current date if omitted.

subjectstringoptionalRestrict results to archived emails whose subject matches this text.

usernamestringoptionalRestrict results to archived emails sent by this SMTP2GO username.

smtp2go_search_email_templates#Search email templates on the SMTP2GO account by keyword and/or tags, with pagination. All parameters are optional — calling with no filters returns all templates, one page at a time.6 params▾

Search email templates on the SMTP2GO account by keyword and/or tags, with pagination. All parameters are optional — calling with no filters returns all templates, one page at a time.

NameTypeRequiredDescription

continue_tokenstringoptionalPagination token from a previous search response's continue_token field, used to fetch the next page of results.

fuzzy_searchbooleanoptionalWhether search_terms should be matched using wildcard/fuzzy matching instead of exact matching.

page_sizeintegeroptionalMaximum number of templates to return in this page of results.

search_termsarrayoptionalReturn templates whose name, tag, id, or subject fields contain any of these strings.

sort_directionstringoptionalSort direction for the returned templates: asc or desc.

tagsarrayoptionalReturn templates containing any of these tags.

smtp2go_search_scheduled_emails#Search emails that have been scheduled for future delivery via the Send Email or Send MIME Email tools but have not yet been sent. Filter by schedule_id, subject, sender, or recipient, with pagination via limit and page.6 params▾

Search emails that have been scheduled for future delivery via the Send Email or Send MIME Email tools but have not yet been sent. Filter by schedule_id, subject, sender, or recipient, with pagination via limit and page.

NameTypeRequiredDescription

limitintegeroptionalMaximum number of scheduled emails to return. Defaults to 1000.

pageintegeroptional1-based page number of results to return, for paginating beyond the limit.

schedule_idstringoptionalThe schedule_id returned from the Send Email or Send MIME Email tools when a schedule timestamp was provided. When set, restricts the search to that single scheduled email.

search_recipientstringoptionalRestrict results to scheduled emails addressed to this recipient.

search_senderstringoptionalRestrict results to scheduled emails sent from this sender address.

search_subjectstringoptionalRestrict results to scheduled emails whose subject matches or contains this text.

smtp2go_search_subaccounts#Search and list subaccounts on your SMTP2GO account, with optional fuzzy or exact text matching, filtering by state (active, closed, suspended, or all), sort direction by name, and cursor-based pagination via page_size and continue_token.6 params▾

Search and list subaccounts on your SMTP2GO account, with optional fuzzy or exact text matching, filtering by state (active, closed, suspended, or all), sort direction by name, and cursor-based pagination via page_size and continue_token.

NameTypeRequiredDescription

continue_tokenstringoptionalPagination token returned from a previous call, used to fetch the next page of results. Omit to fetch the first page.

fuzzy_searchbooleanoptionalWhether search_terms match partial, case-insensitive substrings (true) or complete, case-sensitive field values (false). Defaults to true.

page_sizeintegeroptionalNumber of subaccounts to return per page. Defaults to 100.

search_termsarrayoptionalOne or more strings to match against subaccount fields (e.g. name or email). Subaccounts matching any term are returned. Omit to return all subaccounts.

sort_directionstringoptionalSort results by subaccount name. One of 'asc' (ascending) or 'desc' (descending). Defaults to 'asc'.

statesstringoptionalFilter results by subaccount state. One of 'all', 'active', 'closed', or 'suspended'. Defaults to 'all'.

smtp2go_send_email#Send a single transactional email through SMTP2GO. Requires a sender address and one or more recipients. You must provide at least one of html_body, text_body, or template_id — SMTP2GO rejects the request at runtime if all three are omitted. Supports CC/BCC, custom headers, file attachments, inline images, template-based sending with substitution data, scheduled delivery up to 3 days in the future, and fast-accept mode for background processing.14 params▾

Send a single transactional email through SMTP2GO. Requires a sender address and one or more recipients. You must provide at least one of html_body, text_body, or template_id — SMTP2GO rejects the request at runtime if all three are omitted. Supports CC/BCC, custom headers, file attachments, inline images, template-based sending with substitution data, scheduled delivery up to 3 days in the future, and fast-accept mode for background processing.

NameTypeRequiredDescription

senderstringrequiredThe name and email address to send from, in the format 'Name <name@example.com>'. Must be a verified sender domain or address on the SMTP2GO account.

toarrayrequiredArray of recipient names and email addresses, up to 100 entries. Each entry is formatted as 'Name <email@example.com>' (the name is optional; a bare email address is also accepted).

attachmentsarrayoptionalArray of file attachments. Each item needs a filename plus either fileblob (base64-encoded file content) or url (a publicly reachable URL to fetch the file from) — exactly one of fileblob or url should be set. mimetype is optional and inferred from the filename if omitted.

bccarrayoptionalArray of BCC recipient names and email addresses, up to 100 entries, same format as 'to'.

ccarrayoptionalArray of CC recipient names and email addresses, up to 100 entries, same format as 'to'.

custom_headersarrayoptionalArray of custom email headers to include. Each item is an object with 'header' and 'value' string keys, e.g. [{"header":"X-Custom-Header","value":"some-value"}].

fastacceptbooleanoptionalWhen true, SMTP2GO accepts the email immediately and processes recipient validation in the background, returning a faster response without per-recipient success/failure counts. Defaults to false.

html_bodystringoptionalHTML-encoded body content of the email. Required if neither text_body nor template_id is provided.

inlinesarrayoptionalArray of inline images to embed in the HTML body, referenced via '<img src="cid:filename" />'. Same object shape as attachments: filename plus either fileblob (base64) or url.

schedulestringoptionalFuture timestamp to schedule this email's delivery, up to 3 days ahead. Returns a schedule_id in the response for tracking or cancellation via the Remove Scheduled Email tool.

subjectstringoptionalSubject line of the email. Ignored if template_id is provided and the template defines its own subject.

template_datastringoptionalKey-value substitution variables used to populate the selected template, passed as a JSON-encoded string, e.g. {"first_name":"Jane","order_id":"1234"}. Only used when template_id is set.

template_idstringoptionalIdentifier of an SMTP2GO template to render for this email. When set, template_data supplies substitution variables and subject/html_body/text_body may be omitted.

text_bodystringoptionalPlain text body content of the email. Required if neither html_body nor template_id is provided.

smtp2go_send_email_batch#Send up to 1,000 emails in a single SMTP2GO request, each with its own sender, recipients, subject, and body. Each email in the batch must include at least one of html_body, text_body, or template_id — SMTP2GO rejects any entry missing all three at runtime. Each email may also be scheduled for future delivery independently.1 param▾

Send up to 1,000 emails in a single SMTP2GO request, each with its own sender, recipients, subject, and body. Each email in the batch must include at least one of html_body, text_body, or template_id — SMTP2GO rejects any entry missing all three at runtime. Each email may also be scheduled for future delivery independently.

NameTypeRequiredDescription

emailsarrayrequiredArray of email objects to send, up to 1,000 per batch. Each object requires sender, to, and subject, plus at least one of html_body, text_body, or template_id. Optional per-email fields: cc, bcc, template_id, template_data, custom_headers, attachments, inlines, schedule.

smtp2go_send_mime_email#Send a raw MIME-encoded email through SMTP2GO. Use this when you already have a fully-formed MIME message (headers, body, and any attachments assembled as MIME parts) rather than separate sender/recipient/body fields. The MIME message must be Base64-encoded before submitting. Supports scheduled delivery up to 3 days in the future and fast-accept mode for background processing.3 params▾

Send a raw MIME-encoded email through SMTP2GO. Use this when you already have a fully-formed MIME message (headers, body, and any attachments assembled as MIME parts) rather than separate sender/recipient/body fields. The MIME message must be Base64-encoded before submitting. Supports scheduled delivery up to 3 days in the future and fast-accept mode for background processing.

NameTypeRequiredDescription

mime_emailstringrequiredA valid MIME-encoded email message (headers, body, and attachments as MIME parts) that has been Base64-encoded. This is the entire raw message SMTP2GO will parse and deliver.

fastacceptbooleanoptionalWhen true, SMTP2GO accepts the email immediately and processes it in the background, returning a faster response without per-recipient success/failure counts. Defaults to false.

schedulestringoptionalFuture timestamp to schedule this email's delivery, up to 3 days ahead. Returns a schedule_id in the response for tracking or cancellation via the Remove Scheduled Email tool.

smtp2go_send_sms#Send an SMS text message through SMTP2GO to one or more destination phone numbers. Supports up to 100 destination numbers per request. Messages longer than 160 characters are automatically split into multiple billed units by SMTP2GO.3 params▾

Send an SMS text message through SMTP2GO to one or more destination phone numbers. Supports up to 100 destination numbers per request. Messages longer than 160 characters are automatically split into multiple billed units by SMTP2GO.

NameTypeRequiredDescription

contentstringrequiredThe text content of the SMS message. If the content exceeds 160 characters, SMTP2GO automatically splits it into multiple billed message units.

destinationarrayrequiredArray of destination phone numbers to send the SMS to, in E.164-style format (digits only, optionally prefixed with '+'). Maximum of 100 numbers per request. Example: ["+12025550123"].

senderstringoptionalOptional sender number or ID, in E.164 format, to send the SMS from. If omitted, SMTP2GO uses your account's default sender number; when sending internationally, a shared local number in the recipient's country may be used automatically.

smtp2go_sms_summary#Retrieve a summary of SMS usage on your SMTP2GO account for a given date range, including total messages sent, total billed units consumed, and total cost. Defaults to today (midnight UTC through now) when no date range is given.3 params▾

Retrieve a summary of SMS usage on your SMTP2GO account for a given date range, including total messages sent, total billed units consumed, and total cost. Defaults to today (midnight UTC through now) when no date range is given.

NameTypeRequiredDescription

end_datestringoptionalEnd of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.

start_datestringoptionalStart of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current date at midnight UTC.

subaccount_idstringoptionalSubaccount ID to fetch the SMS summary on behalf of a specific subaccount.

smtp2go_update_allowed_recipients#Replace the full Allowed Recipients list and set whether it is enforced when sending, for this SMTP2GO account. Allowed Recipients is an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally act on behalf of a subaccount.3 params▾

Replace the full Allowed Recipients list and set whether it is enforced when sending, for this SMTP2GO account. Allowed Recipients is an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_recipientsarrayrequiredArray of email addresses and/or domain names that replaces the entire current Allowed Recipients list. Example: ["user@example.com", "example.com"].

enabledbooleanrequiredWhether the Allowed Recipients list should be taken into account when sending mail.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_update_allowed_senders#Replace the full Allowed Senders list and set its mode for this SMTP2GO account. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Note: changing mode to 'whitelist' or 'blacklist' disables the account's Sender Domains feature. Optionally act on behalf of a subaccount.3 params▾

Replace the full Allowed Senders list and set its mode for this SMTP2GO account. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Note: changing mode to 'whitelist' or 'blacklist' disables the account's Sender Domains feature. Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

allowed_sendersarrayrequiredArray of email addresses and/or domain names that replaces the entire current Allowed Senders list. Example: ["user@example.com", "example.com"].

modestringrequiredHow the Allowed Senders list is interpreted: 'whitelist' (only listed senders may relay), 'blacklist' (listed senders are blocked), or 'disabled' (the list is not enforced). Switching to 'whitelist' or 'blacklist' disables the account's Sender Domains feature.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_update_email_template#Update an existing email template on the SMTP2GO account, identified by its current template ID. All fields besides id are optional — only the fields you provide are changed; omitted fields keep their existing value. Can rename the template ID itself via new_id.8 params▾

Update an existing email template on the SMTP2GO account, identified by its current template ID. All fields besides id are optional — only the fields you provide are changed; omitted fields keep their existing value. Can rename the template ID itself via new_id.

NameTypeRequiredDescription

idstringrequiredThe case-sensitive ID of the existing email template to update.

html_bodystringoptionalIf provided, updates the HTML body content of the template.

new_idstringoptionalIf provided, renames the template's ID to this new case-sensitive value.

subjectstringoptionalIf provided, updates the subject line of the template.

tagsarrayoptionalIf provided, replaces the list of tags associated with this template.

template_namestringoptionalIf provided, updates the display name of the template.

template_variablesobjectoptionalIf provided, replaces the default pass-through values for variables used within this template, as a JSON object. Example: {"first_name":"there"}.

text_bodystringoptionalIf provided, updates the plain text body content of the template.

smtp2go_update_subaccount#Update settings on an existing subaccount by its subaccount ID. Supports changing the full name, sending limit, dedicated IP, archiving permission, 2FA enforcement, and SMS settings.8 params▾

Update settings on an existing subaccount by its subaccount ID. Supports changing the full name, sending limit, dedicated IP, archiving permission, 2FA enforcement, and SMS settings.

NameTypeRequiredDescription

idstringrequiredUnique ID of the existing subaccount to update.

archivingbooleanoptionalWhether this subaccount is allowed to enable email archiving. Defaults to false.

dedicated_ipbooleanoptionalWhether this subaccount should have a dedicated sending IP. Defaults to false.

enable_smsbooleanoptionalWhether SMS messaging is enabled for this subaccount. Defaults to false.

enforce_2fabooleanoptionalWhether this subaccount's team members are required to use two-factor authentication. Defaults to false.

fullnamestringoptionalNew full name for the subaccount.

limitintegeroptionalNew maximum number of emails this subaccount can send per billing cycle.

sms_limitintegeroptionalNew maximum number of SMS messages this subaccount can send per month. Defaults to 1000.

smtp2go_verify_sender_domain#Trigger a DNS verification check for a sender domain already added to SMTP2GO. Checks the domain's DKIM and return-path DNS records and updates their verification status. Call this after publishing the required DNS records for a domain that was added with auto_verify disabled.3 params▾

Trigger a DNS verification check for a sender domain already added to SMTP2GO. Checks the domain's DKIM and return-path DNS records and updates their verification status. Call this after publishing the required DNS records for a domain that was added with auto_verify disabled.

NameTypeRequiredDescription

domainstringrequiredThe sender domain to attempt verification for, e.g. 'example.com'. Must already be added as a sender domain.

requisition_sslbooleanoptionalIf true, requisition an SSL certificate for the tracking domain once verification completes. Defaults to true.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_view_allowed_recipients#View the current Allowed Recipients list and whether it is enforced when sending, for this SMTP2GO account. Allowed Recipients is an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally act on behalf of a subaccount.1 param▾

View the current Allowed Recipients list and whether it is enforced when sending, for this SMTP2GO account. Allowed Recipients is an account-level allowlist governing which recipient addresses/domains mail may be sent to. Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_view_allowed_senders#View the current Allowed Senders list and its mode for this SMTP2GO account. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Optionally act on behalf of a subaccount.1 param▾

View the current Allowed Senders list and its mode for this SMTP2GO account. Allowed Senders is an account-level security allowlist governing WHO may relay mail through this account (distinct from Single Sender Emails / Sender Domains, which verify addresses you send FROM). Optionally act on behalf of a subaccount.

NameTypeRequiredDescription

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_view_api_key_permissions#Retrieve the list of API endpoint paths that the API key used to authenticate this request is permitted to call (e.g. '/email/send'). Takes no input parameters — it always reports on the calling key's own permissions.0 params▾

Retrieve the list of API endpoint paths that the API key used to authenticate this request is permitted to call (e.g. '/email/send'). Takes no input parameters — it always reports on the calling key's own permissions.

smtp2go_view_api_keys#Retrieve information about API keys on your SMTP2GO account. Optionally look up a single key by its full value, or search by keyword to narrow the results. Returns each key's masked value, short username, description, rate limits, tracking/feedback settings, status, and permitted endpoints. Omit all fields to list every API key on the account.3 params▾

Retrieve information about API keys on your SMTP2GO account. Optionally look up a single key by its full value, or search by keyword to narrow the results. Returns each key's masked value, short username, description, rate limits, tracking/feedback settings, status, and permitted endpoints. Omit all fields to list every API key on the account.

NameTypeRequiredDescription

idstringoptionalThe full value of a specific API key to retrieve information for. Leave blank to return all API keys (optionally filtered by 'search').

searchstringoptionalA search keyword used to filter results, matched against fields like the key's description or username.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_view_archived_email#Fetch the full details of a single archived email (requires Email Archiving to be enabled on the SMTP2GO account) by its email_id, including headers, sender/recipient, sent timestamp, byte count, and attachment metadata. Find the email_id using the Search Archived Emails tool.1 param▾

Fetch the full details of a single archived email (requires Email Archiving to be enabled on the SMTP2GO account) by its email_id, including headers, sender/recipient, sent timestamp, byte count, and attachment metadata. Find the email_id using the Search Archived Emails tool.

NameTypeRequiredDescription

email_idstringrequiredThe unique email_id of the archived email to retrieve. Obtain this from the Search Archived Emails tool's results.

smtp2go_view_dedicated_ips#Retrieve all dedicated IP pools on your SMTP2GO account, including each pool's ID, name, and the list of dedicated IP addresses assigned to it. Takes no input parameters.0 params▾

Retrieve all dedicated IP pools on your SMTP2GO account, including each pool's ID, name, and the list of dedicated IP addresses assigned to it. Takes no input parameters.

smtp2go_view_ip_allow_list#Retrieve the IP addresses on your SMTP2GO account's IP allow list, along with whether the list is currently enabled.1 param▾

Retrieve the IP addresses on your SMTP2GO account's IP allow list, along with whether the list is currently enabled.

NameTypeRequiredDescription

typestringoptionalWhich IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.

smtp2go_view_ip_auth#Retrieve IP-based authentication (allowlisting) entries for your SMTP2GO account or API access — this controls which source IP addresses are trusted to send, separate from email-level allowed senders/recipients lists. Optionally look up a single entry by its IP address; omit it to return every configured IP Auth entry along with the account's default rate limit settings.2 params▾

Retrieve IP-based authentication (allowlisting) entries for your SMTP2GO account or API access — this controls which source IP addresses are trusted to send, separate from email-level allowed senders/recipients lists. Optionally look up a single entry by its IP address; omit it to return every configured IP Auth entry along with the account's default rate limit settings.

NameTypeRequiredDescription

ip_addressstringoptionalA specific IP address of an existing IP Auth entry to view. Leave blank to return all configured IP Auth entries.

subaccount_idstringoptionalIf you wish to make this API call on behalf of a subaccount, include its unique ID here.

smtp2go_view_received_sms#Retrieve SMS messages received (inbound) on your SMTP2GO account within a date range, including the source and destination numbers, message content, message ID, username, and timestamp. Defaults to the trailing 7 days when no date range is given.6 params▾

Retrieve SMS messages received (inbound) on your SMTP2GO account within a date range, including the source and destination numbers, message content, message ID, username, and timestamp. Defaults to the trailing 7 days when no date range is given.

NameTypeRequiredDescription

end_datestringoptionalEnd of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.

start_datestringoptionalStart of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 7 days ago at midnight UTC.

subaccount_idstringoptionalSubaccount ID to fetch received SMS on behalf of a specific subaccount.

unix_endintegeroptionalLegacy Unix timestamp (seconds since epoch) marking the end of the search window. Prefer end_date instead.

unix_startintegeroptionalLegacy Unix timestamp (seconds since epoch) marking the start of the search window. Prefer start_date instead.

usernamestringoptionalRestrict results to messages associated with this SMTP2GO username.

smtp2go_view_sender_domains#List sender domains configured on the SMTP2GO account, including their DKIM/return-path verification status and DNS values, and their tracking domain (CNAME) configuration. Optionally filter to a single domain, or scope the lookup to a specific subaccount.2 params▾

List sender domains configured on the SMTP2GO account, including their DKIM/return-path verification status and DNS values, and their tracking domain (CNAME) configuration. Optionally filter to a single domain, or scope the lookup to a specific subaccount.

NameTypeRequiredDescription

domainstringoptionalIf provided, only retrieve the record for this specific domain instead of listing all sender domains.

subaccount_idstringoptionalIf making this API call on behalf of a subaccount, the unique ID of that subaccount.

smtp2go_view_sent_emails#Search and list emails sent through SMTP2GO within a date range, with optional filters for open/click activity, a specific email_id list, sending username, or a free-form filter_query. Supports pagination via continue_token and can return aggregate status_counts instead of (or alongside) the individual email list.12 params▾

Search and list emails sent through SMTP2GO within a date range, with optional filters for open/click activity, a specific email_id list, sending username, or a free-form filter_query. Supports pagination via continue_token and can return aggregate status_counts instead of (or alongside) the individual email list.

NameTypeRequiredDescription

clicked_onlybooleanoptionalWhen true, returns only emails that had a link clicked (requires Click Tracking to be enabled on the account). Defaults to false.

continue_tokenstringoptionalPagination token returned by a previous search when more results were available than the limit allowed. Pass it back to continue from where the previous page left off.

email_idarrayoptionalArray of specific email_id values to restrict results to.

end_datestringoptionalISO-8601 formatted datetime (UTC), inclusive upper bound of the search range. Defaults to the current time if omitted.

filter_querystringoptionalFree-form search string for complex filtering across email fields (e.g. sender, recipient, subject).

headersarrayoptionalArray of email header names whose values should be included in each returned email object.

ignore_casebooleanoptionalWhen true, makes string-based search fields (like filter_query) case insensitive. Defaults to false.

limitintegeroptionalMaximum number of emails to return, from 1 to 5000. Defaults to 5000.

opened_onlybooleanoptionalWhen true, returns only emails that were opened (requires Open Tracking to be enabled on the account). Defaults to false.

start_datestringoptionalISO-8601 formatted datetime (UTC), inclusive lower bound of the search range. Defaults to midnight of the current date if omitted.

status_countsbooleanoptionalWhen true, includes counts of each unique email status in the response. Defaults to false.

usernamestringoptionalRestrict results to emails sent by this SMTP2GO username.

smtp2go_view_sent_sms#Retrieve SMS messages sent (outbound) from your SMTP2GO account within a date range, including delivery status, destination number and country, sender, message content, and billed units. Defaults to the trailing 7 days when no date range is given.4 params▾

Retrieve SMS messages sent (outbound) from your SMTP2GO account within a date range, including delivery status, destination number and country, sender, message content, and billed units. Defaults to the trailing 7 days when no date range is given.

NameTypeRequiredDescription

end_datestringoptionalEnd of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.

start_datestringoptionalStart of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 7 days ago at midnight UTC.

subaccount_idstringoptionalSubaccount ID to fetch sent SMS on behalf of a specific subaccount.

usernamestringoptionalRestrict results to messages associated with this SMTP2GO username.

smtp2go_view_single_sender_emails#List the Single Sender email addresses verified on this SMTP2GO account. Single Sender Emails are individually-verified FROM addresses you can send mail from (distinct from the account-level Allowed Senders relay allowlist). Optionally filter by a specific email address, and optionally act on behalf of a subaccount.2 params▾

List the Single Sender email addresses verified on this SMTP2GO account. Single Sender Emails are individually-verified FROM addresses you can send mail from (distinct from the account-level Allowed Senders relay allowlist). Optionally filter by a specific email address, and optionally act on behalf of a subaccount.

NameTypeRequiredDescription

email_addressstringoptionalIf provided, only return the Single Sender entry matching this exact email address. Omit to list all verified Single Sender emails on the account.

subaccount_idstringoptionalIf provided, makes this API call on behalf of the specified subaccount instead of the main account.

smtp2go_view_smtp_users#Retrieve SMTP users on your SMTP2GO account. Pass a specific username to view that single SMTP user's settings, or omit it to list every SMTP user on the account (or subaccount). Returns each user's rate limits, IP pool, feedback/tracking settings, and status.2 params▾

Retrieve SMTP users on your SMTP2GO account. Pass a specific username to view that single SMTP user's settings, or omit it to list every SMTP user on the account (or subaccount). Returns each user's rate limits, IP pool, feedback/tracking settings, and status.

NameTypeRequiredDescription

subaccount_idstringoptionalID of a subaccount to view SMTP users for. Omit to act on the main account.

usernamestringoptionalUsername of a specific existing SMTP user to view. Omit to list all SMTP users.

smtp2go_view_suppressions#Search and list entries on the SMTP2GO suppression (block) list, with rich filtering by email address, recipient(s), reason(s), suppression type(s), a wildcard string, and a date range, plus fuzzy matching and pagination via continue_token. All parameters are optional — calling with no filters returns suppressions from the default 30-day window.14 params▾

Search and list entries on the SMTP2GO suppression (block) list, with rich filtering by email address, recipient(s), reason(s), suppression type(s), a wildcard string, and a date range, plus fuzzy matching and pagination via continue_token. All parameters are optional — calling with no filters returns suppressions from the default 30-day window.

NameTypeRequiredDescription

continue_tokenstringoptionalPagination token from a previous response, used to fetch the next page of results.

email_addressstringoptionalCheck whether this specific email address or domain is on the suppression list.

end_datestringoptionalISO-8601 formatted datetime (UTC) marking the end of the search window. Defaults to the current date at midnight UTC if omitted.

fuzzybooleanoptionalWhether the recipient and reason search fields should use fuzzy (partial) matching instead of exact matching.

reasonstringoptionalA single reason string to search for.

reasonsarrayoptionalAn array of reason strings to search for.

recipientstringoptionalA single recipient string to search for.

recipientsarrayoptionalAn array of recipient strings to search for.

sortstringoptionalDirection to sort the returned results: asc or desc.

start_datestringoptionalISO-8601 formatted datetime (UTC) marking the start of the search window. Defaults to 30 days prior to the current date at midnight UTC if omitted.

subaccount_idstringoptionalIf provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.

suppression_typestringoptionalRestrict the search to a single suppression type: manual, spam, unsubscribe, bounce, or compliance.

suppression_typesarrayoptionalRestrict the search to multiple suppression types from: manual, spam, unsubscribe, bounce, compliance.

wildcardstringoptionalOnly return suppressions where this string appears in the name, domain, or email address fields.

smtp2go_view_template_details#Retrieve the full details of a single email template on the SMTP2GO account, identified by its case-sensitive template ID, including its name, subject, HTML body, text body, template variables, tags, and last-updated timestamp.1 param▾

Retrieve the full details of a single email template on the SMTP2GO account, identified by its case-sensitive template ID, including its name, subject, HTML body, text body, template variables, tags, and last-updated timestamp.

NameTypeRequiredDescription

idstringrequiredThe case-sensitive ID of the email template to view.

smtp2go_view_webhook#Retrieve the configuration of the webhook currently set up on the SMTP2GO account. Returns the callback URL, webhook ID, subscribed email events, SMS events, custom headers, restricted usernames, output format, and auth header settings. Optionally scoped to a subaccount via subaccount_id.1 param▾

Retrieve the configuration of the webhook currently set up on the SMTP2GO account. Returns the callback URL, webhook ID, subscribed email events, SMS events, custom headers, restricted usernames, output format, and auth header settings. Optionally scoped to a subaccount via subaccount_id.

NameTypeRequiredDescription

subaccount_idstringoptionalIf provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.