The SMTP2GO connector lets your AI agent act in each user's SMTP2GO account. Each user connects their own SMTP2GO API key once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 74 tools.
- Tools
- 74
- What they doRead · write · destructive
- 29 · 33 · 1229 read33 write12 destructive
- Users sign in with
- API key
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. 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>Create the SMTP2GO connection
In AgentKit > Connections, create a SMTP2GO connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Console steps with screenshots
Register your Scalekit environment with the SMTP2GO connector so Scalekit can authenticate requests on your behalf. The connection name you create will be used to identify and invoke the connection programmatically. Then complete the configuration in your application as follows:
-
Create an API key
- Sign in to your SMTP2GO dashboard and go to Settings > API Keys.
- Click Add API Key, give it a descriptive name, for example
Agent Auth, and choose the permission level your agent needs.
-
Copy the key
- SMTP2GO shows the key once, right after you create it. Copy it and store it securely.
-
Add the key in Scalekit
- In Scalekit dashboard, go to AgentKit > Connections > Create Connection. Find SMTP2GO and click Create.
- Paste the API key you copied in step 2.
- Click Save.
-
Authorize a user and make your first call
quickstart.mts import { ScalekitClient } from '@scalekit-sdk/node'import 'dotenv/config'import { createInterface } from 'node:readline/promises'const scalekit = new ScalekitClient(process.env.SCALEKIT_ENVIRONMENT_URL,process.env.SCALEKIT_CLIENT_ID,process.env.SCALEKIT_CLIENT_SECRET,)const actions = scalekit.actionsconst connector = 'smtp2go'const identifier = 'user_123'// Generate an authorization link for the userconst { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })console.log('Authorize SMTP2GO:', link)const rl = createInterface({ input: process.stdin, output: process.stdout })await rl.question('Press Enter after authorizing...')rl.close()// Make your first callconst result = await actions.executeTool({connector,identifier,toolName: 'smtp2go_email_bounces_report',toolInput: {},})console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py import osfrom scalekit import ScalekitClientfrom dotenv import load_dotenvload_dotenv()scalekit_client = ScalekitClient(env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),client_id=os.getenv("SCALEKIT_CLIENT_ID"),client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),)actions = scalekit_client.actionsconnection_name = "smtp2go"identifier = "user_123"# Generate an authorization link for the userlink_response = actions.get_authorization_link(connection_name=connection_name,identifier=identifier,)print("Authorize SMTP2GO:", link_response.link)input("Press Enter after authorizing...")# Make your first callresult = actions.execute_tool(tool_input={},tool_name="smtp2go_email_bounces_report",connection_name=connection_name,identifier=identifier,)print(result)Terminal window python quickstart.pyEach user opens the link once and enters their SMTP2GO credentials there. If your app already has a user's credentials, add the account from your backend instead, as the console steps above show. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolsmtp2go_email_bounces_reportRetrieve 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.Read-onlyEmail 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.
Inputs
usernamestring- Restrict the bounce statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.
smtp2go_email_cycle_reportRetrieve 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.Read-onlyEmail 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.
Inputs
This tool takes no inputs.
smtp2go_email_history_reportRetrieve a time-series history of email sending activity from SMTP2GO, grouped by email address, username, domain, or subaccount.Read-onlyEmail 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.
Inputs
end_datestring- End of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.
group_bystring- Controls how the returned history is grouped. One of email_address, username, domain, or subaccount. Defaults to email_address.one of
email_addressusernamedomainsubaccountdefaultemail_address start_datestring- Start of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 30 days before the current time.
subaccountsarray- List of subaccount IDs to restrict the report to. Omit to include activity from all subaccounts.
smtp2go_email_spam_reportRetrieve 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.Read-onlyEmail 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.
Inputs
usernamestring- Restrict the spam statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.
smtp2go_email_summary_reportRetrieve an overall sending summary for the SMTP2GO account, or for a single user on the account, for the current billing cycle.Read-onlyEmail 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.
Inputs
usernamestring- Restrict the summary statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.
smtp2go_email_unsubscribes_reportRetrieve 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.Read-onlyEmail 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.
Inputs
usernamestring- Restrict the unsubscribe statistics to a single SMTP2GO user on this account. Omit to return statistics for the whole account.
smtp2go_search_activitySearch delivery activity events (processed, delivered, bounced, opened, clicked, etc.) for emails sent through SMTP2GO within a date range.Read-onlySearch 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.
Inputs
continue_tokenstring- Pagination 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_headersarray- Array of custom header names to extract from each email's raw headers and include in the response, e.g. X-MyCustomID.
end_datestring- ISO-8601 formatted datetime (UTC), exclusive upper bound of the search range. Defaults to now if omitted.
event_typesarray- Array of event types to restrict results to. Valid values: processed, soft-bounced, hard-bounced, rejected, spam, delivered, unsubscribed, resubscribed, opened, clicked.
include_headersboolean- When true, includes the full email headers in each returned event. Defaults to false.default
false limitinteger- Maximum number of activity events to return, up to 1000. Defaults to 100.default
100 only_latestboolean- When true, returns only the most recent event per email instead of every matching event. Defaults to false.default
false only_latest_by_sentboolean- When 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.default
false regionstring- Forces this search to a specific regional datacenter (us, eu, or au), independent of the connection's API Region setting.one of
useuau searchstring- Returns 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_idstring- Restrict results to events for this specific email_id.
search_recipientstring- Restrict results to events for emails addressed to this recipient.
search_senderstring- Restrict results to events for emails sent from this sender address.
search_subjectstring- Restrict results to events for emails whose subject matches this text.
search_usernamesarray- Array of SMTP2GO usernames to restrict results to emails sent by any of these users.
start_datestring- ISO-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.
subaccountsarray- Array of subaccount IDs to restrict results to activity belonging to any of these subaccounts.
smtp2go_search_archived_emailsSearch 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.Read-onlySearch 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.
Inputs
continue_tokenstring- Pagination 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_datestring- ISO-8601 formatted datetime (UTC), inclusive upper bound of the search range. Defaults to the current time if omitted.
envelope_fromstring- Restrict results to archived emails with this SMTP envelope-from address (may differ from the visible From/sender header).
headersstring- Restrict results to archived emails containing this substring anywhere in their headers.
limitinteger- Maximum number of archived emails to return. Defaults to 5000.default
5000 recipientstring- Restrict results to archived emails addressed to this recipient.
senderstring- Restrict results to archived emails sent from this sender address.
start_datestring- ISO-8601 formatted datetime (UTC), inclusive lower bound of the search range. Defaults to midnight of the current date if omitted.
subjectstring- Restrict results to archived emails whose subject matches this text.
usernamestring- Restrict results to archived emails sent by this SMTP2GO username.
smtp2go_search_email_templatesSearch email templates on the SMTP2GO account by keyword and/or tags, with pagination.Read-onlySearch 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.
Inputs
continue_tokenstring- Pagination token from a previous search response's continue_token field, used to fetch the next page of results.
fuzzy_searchboolean- Whether search_terms should be matched using wildcard/fuzzy matching instead of exact matching.default
false page_sizeinteger- Maximum number of templates to return in this page of results.default
100 search_termsarray- Return templates whose name, tag, id, or subject fields contain any of these strings.
sort_directionstring- Sort direction for the returned templates: asc or desc.one of
ascdescdefaultasc tagsarray- Return templates containing any of these tags.
smtp2go_search_scheduled_emailsSearch emails that have been scheduled for future delivery via the Send Email or Send MIME Email tools but have not yet been sent.Read-onlySearch 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.
Inputs
limitinteger- Maximum number of scheduled emails to return. Defaults to 1000.default
1000 pageinteger- 1-based page number of results to return, for paginating beyond the limit.
schedule_idstring- The 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_recipientstring- Restrict results to scheduled emails addressed to this recipient.
search_senderstring- Restrict results to scheduled emails sent from this sender address.
search_subjectstring- Restrict results to scheduled emails whose subject matches or contains this text.
smtp2go_search_subaccountsSearch 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.Read-onlySearch 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.
Inputs
continue_tokenstring- Pagination token returned from a previous call, used to fetch the next page of results. Omit to fetch the first page.
fuzzy_searchboolean- Whether search_terms match partial, case-insensitive substrings (true) or complete, case-sensitive field values (false). Defaults to true.default
true page_sizeinteger- Number of subaccounts to return per page. Defaults to 100.default
100 search_termsarray- One 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_directionstring- Sort results by subaccount name. One of 'asc' (ascending) or 'desc' (descending). Defaults to 'asc'.one of
ascdescdefaultasc statesstring- Filter results by subaccount state. One of 'all', 'active', 'closed', or 'suspended'. Defaults to 'all'.one of
allactiveclosedsuspendeddefaultall
smtp2go_sms_summaryRetrieve 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.Read-onlySMS 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.
Inputs
end_datestring- End of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.
start_datestring- Start of the reporting window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current date at midnight UTC.
subaccount_idstring- Subaccount ID to fetch the SMS summary on behalf of a specific subaccount.
smtp2go_view_allowed_recipientsView the current Allowed Recipients list and whether it is enforced when sending, for this SMTP2GO account.Read-onlyView 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.
Inputs
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_view_allowed_sendersView the current Allowed Senders list and its mode for this SMTP2GO account.Read-onlyView 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.
Inputs
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_view_api_key_permissionsRetrieve the list of API endpoint paths that the API key used to authenticate this request is permitted to call (e.g.Read-onlyView 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.
Inputs
This tool takes no inputs.
smtp2go_view_api_keysRetrieve information about API keys on your SMTP2GO account.Read-onlyView 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.
Inputs
idstring- The full value of a specific API key to retrieve information for. Leave blank to return all API keys (optionally filtered by 'search').
searchstring- A search keyword used to filter results, matched against fields like the key's description or username.
subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_view_archived_emailFetch 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.Read-onlyView 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.
Inputs
email_idstringrequired- The unique email_id of the archived email to retrieve. Obtain this from the Search Archived Emails tool's results.
smtp2go_view_dedicated_ipsRetrieve all dedicated IP pools on your SMTP2GO account, including each pool's ID, name, and the list of dedicated IP addresses assigned to it.Read-onlyView 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.
Inputs
This tool takes no inputs.
smtp2go_view_ip_allow_listRetrieve the IP addresses on your SMTP2GO account's IP allow list, along with whether the list is currently enabled.Read-onlyView IP Allow List
Retrieve the IP addresses on your SMTP2GO account's IP allow list, along with whether the list is currently enabled.
Inputs
typestring- Which IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.one of
smtpapidefaultsmtp
smtp2go_view_ip_authRetrieve 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.Read-onlyView 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.
Inputs
ip_addressstring- A specific IP address of an existing IP Auth entry to view. Leave blank to return all configured IP Auth entries.
subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_view_received_smsRetrieve 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.Read-onlyView 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.
Inputs
end_datestring- End of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.
start_datestring- Start of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 7 days ago at midnight UTC.
subaccount_idstring- Subaccount ID to fetch received SMS on behalf of a specific subaccount.
unix_endinteger- Legacy Unix timestamp (seconds since epoch) marking the end of the search window. Prefer end_date instead.
unix_startinteger- Legacy Unix timestamp (seconds since epoch) marking the start of the search window. Prefer start_date instead.
usernamestring- Restrict results to messages associated with this SMTP2GO username.
smtp2go_view_sender_domainsList sender domains configured on the SMTP2GO account, including their DKIM/return-path verification status and DNS values, and their tracking domain (CNAME) configuration.Read-onlyView 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.
Inputs
domainstring- If provided, only retrieve the record for this specific domain instead of listing all sender domains.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_view_sent_emailsSearch 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.Read-onlyView 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.
Inputs
clicked_onlyboolean- When true, returns only emails that had a link clicked (requires Click Tracking to be enabled on the account). Defaults to false.default
false continue_tokenstring- Pagination 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_idarray- Array of specific email_id values to restrict results to.
end_datestring- ISO-8601 formatted datetime (UTC), inclusive upper bound of the search range. Defaults to the current time if omitted.
filter_querystring- Free-form search string for complex filtering across email fields (e.g. sender, recipient, subject).
headersarray- Array of email header names whose values should be included in each returned email object.
ignore_caseboolean- When true, makes string-based search fields (like filter_query) case insensitive. Defaults to false.default
false limitinteger- Maximum number of emails to return, from 1 to 5000. Defaults to 5000.default
5000 opened_onlyboolean- When true, returns only emails that were opened (requires Open Tracking to be enabled on the account). Defaults to false.default
false start_datestring- ISO-8601 formatted datetime (UTC), inclusive lower bound of the search range. Defaults to midnight of the current date if omitted.
status_countsboolean- When true, includes counts of each unique email status in the response. Defaults to false.default
false usernamestring- Restrict results to emails sent by this SMTP2GO username.
smtp2go_view_sent_smsRetrieve 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.Read-onlyView 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.
Inputs
end_datestring- End of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to the current time.
start_datestring- Start of the search window, as an ISO-8601 datetime in UTC. If omitted, SMTP2GO defaults to 7 days ago at midnight UTC.
subaccount_idstring- Subaccount ID to fetch sent SMS on behalf of a specific subaccount.
usernamestring- Restrict results to messages associated with this SMTP2GO username.
smtp2go_view_single_sender_emailsList the Single Sender email addresses verified on this SMTP2GO account.Read-onlyView 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.
Inputs
email_addressstring- If provided, only return the Single Sender entry matching this exact email address. Omit to list all verified Single Sender emails on the account.
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_view_smtp_usersRetrieve SMTP users on your SMTP2GO account.Read-onlyView 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.
Inputs
subaccount_idstring- ID of a subaccount to view SMTP users for. Omit to act on the main account.
usernamestring- Username of a specific existing SMTP user to view. Omit to list all SMTP users.
smtp2go_view_suppressionsSearch 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.Read-onlyView 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.
Inputs
continue_tokenstring- Pagination token from a previous response, used to fetch the next page of results.
email_addressstring- Check whether this specific email address or domain is on the suppression list.
end_datestring- ISO-8601 formatted datetime (UTC) marking the end of the search window. Defaults to the current date at midnight UTC if omitted.
fuzzyboolean- Whether the recipient and reason search fields should use fuzzy (partial) matching instead of exact matching.
reasonstring- A single reason string to search for.
reasonsarray- An array of reason strings to search for.
recipientstring- A single recipient string to search for.
recipientsarray- An array of recipient strings to search for.
sortstring- Direction to sort the returned results: asc or desc.one of
ascdesc start_datestring- ISO-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_idstring- If provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.
suppression_typestring- Restrict the search to a single suppression type: manual, spam, unsubscribe, bounce, or compliance.one of
manualspamunsubscribebouncecompliance suppression_typesarray- Restrict the search to multiple suppression types from: manual, spam, unsubscribe, bounce, compliance.
wildcardstring- Only return suppressions where this string appears in the name, domain, or email address fields.
smtp2go_view_template_detailsRetrieve 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.Read-onlyView 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.
Inputs
idstringrequired- The case-sensitive ID of the email template to view.
smtp2go_view_webhookRetrieve the configuration of the webhook currently set up on the SMTP2GO account.Read-onlyView 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.
Inputs
subaccount_idstring- If provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.
smtp2go_add_allowed_recipientsAdd 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.WriteAdd 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.
Inputs
allowed_recipientsarrayrequired- Array of email addresses and/or domain names to add to the Allowed Recipients list. Example: ["user@example.com", "example.com"].
enabledboolean- Whether the Allowed Recipients list is taken into account when sending mail. If omitted, the account's current setting is left unchanged.
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_add_allowed_sendersAdd 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.WriteAdd 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.
Inputs
allowed_sendersarrayrequired- Array of email addresses and/or domain names to add to the Allowed Senders list. Example: ["user@example.com", "example.com"].
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_add_api_keyCreate a new API key on your SMTP2GO account.WriteAdd 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.
Inputs
archive_enabledboolean- Whether to enable message archiving for emails sent with this API key. Archiving is available on paid plans.default
false audit_emailstring- An email address to BCC on every message sent using this API key.
bounce_notificationsstring- How 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.default
from click_tracking_enabledboolean- Whether to enable click tracking for emails sent with this API key.default
false custom_ratelimitboolean- Whether to enable a custom send rate limit for this API key instead of the account default.default
false custom_ratelimit_periodstring- The 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_valueinteger- The number of emails this API key can send within the period defined by custom_ratelimit_period. Only used when custom_ratelimit is true.
descriptionstring- A comment or description to help identify this API key's purpose.
endpointsarray- Array of API endpoint paths this key is permitted to call. Supports wildcard patterns, e.g. '/email/*'. Defaults to ['/email/send'] if omitted.
feedback_enabledboolean- Whether to enable a custom unsubscribe feedback footer for emails sent with this API key.default
false feedback_htmlstring- HTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Only used when feedback_enabled is true.default
feedback_textstring- Plain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Only used when feedback_enabled is true.default
ip_poolinteger- The ID of a dedicated IP pool. Emails sent using this API key will be routed through the dedicated IPs in this pool.
open_tracking_enabledboolean- Whether to enable open tracking for emails sent with this API key.default
false statusstring- The initial status of the new API key: 'allowed' (fully active), 'blocked' (cannot send), or 'sandbox' (test mode, no real delivery).one of
allowedblockedsandboxdefaultallowed subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_add_email_templateCreate a new reusable email template on the SMTP2GO account.WriteAdd 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.
Inputs
html_bodystringrequired- The HTML body content of the email template.
idstringrequired- Caller-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.
subjectstringrequired- The subject line of the email template.
template_namestringrequired- The display name of the email template. Minimum length 1 character, maximum length 64 characters.
text_bodystringrequired- The plain text body content of the email template.
tagsarray- List of tags to associate with this template, for organizing and filtering templates later.
template_variablesobject- Default pass-through values for variables used within this template, as a JSON object. Example: {"first_name":"there","company_name":"Acme"}.
smtp2go_add_ip_allow_listAdd 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.WriteAdd 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.
Inputs
ip_addressstringrequired- The IP address to add to the allow list.
descriptionstring- A comment or description for this allow list entry, for your own reference.
typestring- Which IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.one of
smtpapidefaultsmtp
smtp2go_add_sender_domainAdd a new sender domain to SMTP2GO for DNS-based sending setup (DKIM signing, return-path, and click/open tracking).WriteAdd 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.
Inputs
domainstringrequired- The 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_verifyboolean- If 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.default
true requisition_sslboolean- If true, requisition an SSL certificate for the tracking domain once verification completes. Defaults to true.default
true returnpath_subdomainstring- An optional subdomain to use as the return-path (bounce handling) subdomain, e.g. 'returns' for returns.example.com.
subaccount_accessobject- Object 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_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
tracking_subdomainstring- An optional subdomain used for click/open tracking links and unsubscribe links, e.g. 'track' for track.example.com.
smtp2go_add_single_sender_emailAdd a single verified sender email address to SMTP2GO.WriteAdd 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.
Inputs
email_addressstringrequired- The email address you want to send emails from. A verification email will be sent to this address to confirm ownership.
messagestring- Optional plain-text-only message to include in the verification email sent to the address.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_add_smtp_userCreate a new SMTP user (an SMTP relay login credential) on your SMTP2GO account.WriteAdd 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.
Inputs
usernamestringrequired- SMTP access username for the new SMTP user. Must be 5-100 characters and unique on the account.
archive_enabledboolean- Enable email archiving for this user (available on paid plans only). Defaults to false.default
false audit_emailstring- Email address that should be BCC'd on every outbound message sent by this user.
bounce_notificationsstring- How 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'.default
from click_tracking_enabledboolean- Enable click tracking for links in emails sent by this user. Defaults to false.default
false custom_ratelimitboolean- Enable a custom sending rate limit for this user instead of the account default. Defaults to false.default
false custom_ratelimit_periodstring- Period 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_valueinteger- Maximum number of emails this user can send within the rate limit period. Only applies when custom_ratelimit is true.
descriptionstring- Free-text comment describing what this SMTP user is used for.
email_passwordstring- 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_domainstring- Domain 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.default
default feedback_enabledboolean- Enable a custom unsubscribe/feedback footer on emails sent by this user. Defaults to false.default
false feedback_htmlstring- HTML content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.
feedback_textstring- Plain-text content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.
ip_poolinteger- Numeric ID of a dedicated IP pool this user should send through. Find pool IDs via the dedicated IPs view endpoint.
open_tracking_enabledboolean- Enable open tracking for emails sent by this user. Defaults to false.default
false statusstring- Initial 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'.one of
allowedblockedsandboxdefaultallowed subaccount_idstring- ID of a subaccount to create this SMTP user on behalf of. Omit to act on the main account.
smtp2go_add_subaccountCreate a new subaccount under your SMTP2GO account.WriteAdd 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.
Inputs
fullnamestringrequired- Full name used to identify the new subaccount.
archivingboolean- Allow this subaccount to enable email archiving. Defaults to false.default
false dedicated_ipboolean- Automatically assign a dedicated sending IP to this subaccount. Requires limit to be greater than 100,000. Defaults to false.default
false enable_smsboolean- Enable SMS messaging for this subaccount. Defaults to false.default
false enforce_2faboolean- Require this subaccount's team members to use two-factor authentication. Defaults to false.default
false limitinteger- Maximum 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).one of
2000500010000200003000040000500006000080000100000250000500000100000020000003000000500000010000000default10000 sms_limitinteger- Maximum number of SMS messages this subaccount can send per month. Defaults to 1000.default
1000 subaccount_emailstring- Email address for the first team member of this subaccount.
smtp2go_add_suppressionAdd an email address or entire domain to the SMTP2GO suppression (block) list, preventing future deliveries to it.WriteAdd 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.
Inputs
email_addressstringrequired- The email address or domain to add to the suppression list. Deliveries to this address (or any address at this domain) will be blocked.
block_descriptionstring- A description explaining why this email or domain is being suppressed. Stored alongside the suppression entry.
subaccount_idstring- If provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.
smtp2go_add_webhookRegister a new webhook on the SMTP2GO account that will POST event data to a target URL.WriteAdd 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.
Inputs
urlstringrequired- The callback URL that SMTP2GO will POST event data to.
auth_header_typestring- Type of Authorization header SMTP2GO should send with the webhook request: bearer or basic. Leave blank for no authentication header.one of
bearerbasic auth_header_valuestring- The 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.
eventsarray- List of email events this webhook should receive. Valid values: delivered, unsubscribe, spam, bounce, processed, reject, click, open.
headersarray- Custom 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_formatstring- The payload format SMTP2GO will use when POSTing event data to the webhook URL: form or json.one of
formjsondefaultform sms_eventsarray- List of SMS events this webhook should receive. Valid values: delivered, failed, rejected, sending, submitted.
subaccount_idstring- If provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.
usernamesarray- SMTP2GO sending usernames to restrict this webhook to. If omitted, events from all usernames are included.
smtp2go_close_subaccountClose an existing subaccount by its subaccount ID, suspending its ability to send.WriteClose 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.
- Idempotent
Inputs
idstringrequired- Unique ID of the subaccount to close.
emailstring- Email address associated with the subaccount to close.
smtp2go_edit_api_keyEdit an existing SMTP2GO API key by its ID.WriteEdit 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.
- Idempotent
Inputs
idstringrequired- The ID of the existing API key to edit.
archive_enabledboolean- Whether 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_emailstring- An email address to BCC on every message sent using this API key. Leave blank to keep the current value.
bounce_notificationsstring- How 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_enabledboolean- Whether to enable click tracking for emails sent with this API key. Leave blank to keep the current setting.
custom_ratelimitboolean- Whether 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_periodstring- The 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_valueinteger- The 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.
descriptionstring- A comment or description to help identify this API key's purpose. Leave blank to keep the current description.
endpointsarray- Array 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_enabledboolean- Whether to enable a custom unsubscribe feedback footer for emails sent with this API key. Leave blank to keep the current setting.
feedback_htmlstring- HTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Leave blank to keep the current value.
feedback_textstring- Plain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Leave blank to keep the current value.
ip_poolinteger- The 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_enabledboolean- Whether to enable open tracking for emails sent with this API key. Leave blank to keep the current setting.
statusstring- The 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.one of
allowedblockedsandbox subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_edit_ip_allow_listEdit an existing entry on your SMTP2GO account's IP allow list, identified by its current IP address.WriteEdit 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.
- Idempotent
Inputs
ip_addressstringrequired- The current IP address of the existing allow list entry to edit.
descriptionstring- A comment or description for this allow list entry, for your own reference.
new_ip_addressstring- A new IP address to replace the existing entry with.
typestring- Which IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.one of
smtpapidefaultsmtp
smtp2go_edit_return_path_domainChange the return-path (bounce handling) subdomain used by an already-added sender domain in SMTP2GO.WriteEdit 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.
- Idempotent
Inputs
domainstringrequired- The sender domain whose return-path subdomain you want to change, e.g. 'example.com'. Must already be added as a sender domain.
new_subdomainstringrequired- The 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_subdomainstringrequired- The domain's current return-path subdomain, e.g. 'returns'.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_edit_smtp_userUpdate an existing SMTP user's settings on your SMTP2GO account by username.WriteEdit 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.
- Idempotent
Inputs
usernamestringrequired- Username of the existing SMTP user to edit.
archive_enabledboolean- Enable email archiving for this user (available on paid plans only). Defaults to false.default
false audit_emailstring- Email address that should be BCC'd on every outbound message sent by this user.
bounce_notificationsstring- How 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'.default
from click_tracking_enabledboolean- Enable click tracking for links in emails sent by this user. Defaults to false.default
false custom_ratelimitboolean- Enable a custom sending rate limit for this user instead of the account default. Defaults to false.default
false custom_ratelimit_periodstring- Period 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_valueinteger- Maximum number of emails this user can send within the rate limit period. Only applies when custom_ratelimit is true.
descriptionstring- Free-text comment describing what this SMTP user is used for.
email_passwordstring- New 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_domainstring- Domain 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_enabledboolean- Enable a custom unsubscribe/feedback footer on emails sent by this user. Defaults to false.default
false feedback_htmlstring- HTML content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.
feedback_textstring- Plain-text content for the feedback/unsubscribe footer. Supports the placeholders %%UNSUBSCRIBE%% and %%EMAIL%%.
ip_poolinteger- Numeric ID of a dedicated IP pool this user should send through. Find pool IDs via the dedicated IPs view endpoint.
open_tracking_enabledboolean- Enable open tracking for emails sent by this user. Defaults to false.default
false statusstring- Account status for this SMTP user. One of 'allowed' (can send normally), 'blocked' (sending disabled), or 'sandbox' (test mode, mail is not actually delivered).one of
allowedblockedsandbox subaccount_idstring- ID 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_accessSet which subaccounts are allowed to send using a verified sender domain owned by the master account.WriteEdit 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.
- Idempotent
Inputs
domainstringrequired- The sender domain to edit subaccount access for, e.g. 'example.com'. Must already be a verified sender domain on the master account.
subaccountsarrayrequired- List 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_subaccountsboolean- If true, any subaccounts created in the future will automatically be granted access to this sender domain. Defaults to false.default
false
smtp2go_edit_tracking_domainChange the click/open tracking subdomain used by an already-added sender domain in SMTP2GO.WriteEdit 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.
- Idempotent
Inputs
domainstringrequired- The sender domain whose tracking subdomain you want to change, e.g. 'example.com'. Must already be added as a sender domain.
new_subdomainstringrequired- The new tracking subdomain to switch to, e.g. 'link'. You'll need to add a matching CNAME DNS record for it to verify.
old_subdomainstringrequired- The domain's current tracking subdomain, e.g. 'track'.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_edit_webhookEdit an existing SMTP2GO webhook by its ID.WriteEdit 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.
- Idempotent
Inputs
idintegerrequired- The 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_typestring- Type of authentication header to send with each webhook call: 'bearer' or 'basic'. Leave blank to keep the current setting.one of
bearerbasic auth_header_valuestring- Value 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.
eventsarray- List 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.
headersarray- Custom headers you would like sent along with the webhook event data. Leave blank to keep the current header list.
output_formatstring- Format the webhook payload should be sent in: 'form' (application/x-www-form-urlencoded) or 'json'. Leave blank to keep the current format.one of
formjson sms_eventsarray- List of SMS events this webhook should receive. Valid values: delivered, failed, rejected, sending, submitted. Leave blank to keep the current event list.
subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
urlstring- New 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.
usernamesarray- List of SMTP2GO usernames whose activity should trigger this webhook. Leave blank to keep the current list.
smtp2go_enable_ip_allow_listEnable or disable the IP allow list on your SMTP2GO account.WriteEnable 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.
- Idempotent
Inputs
enabledbooleanrequired- Whether the IP allow list should be enabled (true) or disabled (false).
typestring- Which IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.one of
smtpapidefaultsmtp
smtp2go_patch_api_keyPartially update an existing SMTP2GO API key by its ID, ignoring any properties you don't include.WritePatch 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.
- Idempotent
Inputs
idstringrequired- The ID of the existing API key to patch.
archive_enabledboolean- Whether 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_emailstring- An email address to BCC on every message sent using this API key. Omit to leave the current value untouched.
bounce_notificationsstring- How 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_enabledboolean- Whether to enable click tracking for emails sent with this API key. Omit to leave the current setting untouched.
custom_ratelimitboolean- Whether 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_periodstring- The 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_valueinteger- The 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.
descriptionstring- A comment or description to help identify this API key's purpose. Omit to leave the current description untouched.
endpointsarray- Array of API endpoint paths this key is permitted to call. Supports wildcard patterns, e.g. '/email/*'. Omit to leave the current list untouched.
feedback_enabledboolean- Whether to enable a custom unsubscribe feedback footer for emails sent with this API key. Omit to leave the current setting untouched.
feedback_htmlstring- HTML content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Omit to leave the current value untouched.
feedback_textstring- Plain-text content for the custom unsubscribe feedback footer. Supports the %%UNSUBSCRIBE%% and %%EMAIL%% placeholders. Omit to leave the current value untouched.
ip_poolinteger- The 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_enabledboolean- Whether to enable open tracking for emails sent with this API key. Omit to leave the current setting untouched.
statusstring- The 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.one of
allowedblockedsandbox subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_patch_ip_authPartially update an existing IP-based authentication (IP Auth) entry in SMTP2GO, identified by its IP address.WritePatch 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.
- Idempotent
Inputs
ip_addressstringrequired- The IP address of the existing IP Auth entry to edit. Must match an IP Auth entry already configured on the account.
archive_enabledboolean- Whether sent-email archiving is enabled for this IP Auth entry.
audit_emailstring- An email address that will be BCC'd on every email sent through this IP Auth entry.
bounce_notificationsstring- Where 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_enabledboolean- Whether click tracking is enabled for emails sent through this IP Auth entry.
custom_ratelimitboolean- Whether 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_periodstring- The 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_valueinteger- The number of emails this IP Auth entry may send within the period defined by custom_ratelimit_period. Only applied when custom_ratelimit is true.
descriptionstring- A comment or description for this IP Auth entry, for your own reference.
feedback_enabledboolean- Whether custom feedback (unsubscribe footer) content is enabled for emails sent through this IP Auth entry.
feedback_htmlstring- HTML content inserted into the custom feedback/unsubscribe footer of the email body. Only used when feedback_enabled is true.
feedback_textstring- Plain text content inserted into the custom feedback/unsubscribe footer of the email body. Only used when feedback_enabled is true.
ip_poolinteger- ID of the IP Pool. Emails sent using this IP Auth entry will use the dedicated IPs in this pool.
open_tracking_enabledboolean- Whether open tracking is enabled for emails sent through this IP Auth entry.
statusstring- Access status for this IP Auth entry. One of: allowed, blocked, sandbox.one of
allowedblockedsandbox subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_patch_smtp_userPartially update an existing SMTP user on your SMTP2GO account by username.WritePatch 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.
- Idempotent
Inputs
usernamestringrequired- Username of the existing SMTP user to partially update.
archive_enabledboolean- Enable or disable email archiving for this user (paid plans only). Leave unset to keep the current setting.
audit_emailstring- Email address that should be BCC'd on every outbound message sent by this user. Leave unset to keep the current value.
bounce_notificationsstring- How bounce notifications are handled: 'from', 'drop', or a specific email address. Leave unset to keep the current value.
click_tracking_enabledboolean- Enable or disable click tracking for links in emails sent by this user. Leave unset to keep the current setting.
custom_ratelimitboolean- Enable or disable a custom sending rate limit for this user. Leave unset to keep the current setting.
custom_ratelimit_periodstring- Period 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_valueinteger- Maximum number of emails this user can send within the rate limit period. Leave unset to keep the current value.
descriptionstring- Free-text comment describing what this SMTP user is used for. Leave unset to keep the current value.
email_passwordstring- New SMTP password for this user. Must have at least 64-bit entropy. Leave unset to keep the current password unchanged.
feedback_enabledboolean- Enable or disable the custom unsubscribe/feedback footer. Leave unset to keep the current setting.
feedback_htmlstring- HTML content for the feedback/unsubscribe footer. Supports %%UNSUBSCRIBE%% and %%EMAIL%%. Leave unset to keep the current value.
feedback_textstring- Plain-text content for the feedback/unsubscribe footer. Supports %%UNSUBSCRIBE%% and %%EMAIL%%. Leave unset to keep the current value.
ip_poolinteger- Numeric ID of a dedicated IP pool this user should send through. Leave unset to keep the current value.
open_tracking_enabledboolean- Enable or disable open tracking for emails sent by this user. Leave unset to keep the current setting.
statusstring- Account status for this SMTP user. One of 'allowed', 'blocked', or 'sandbox'. Leave unset to keep the current status.one of
allowedblockedsandbox subaccount_idstring- ID 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_reopen_subaccountReopen a previously closed subaccount by its subaccount ID, restoring its ability to send.WriteReopen Subaccount
Reopen a previously closed subaccount by its subaccount ID, restoring its ability to send.
- Idempotent
Inputs
idstringrequired- Unique ID of the closed subaccount to reopen.
emailstring- Email address associated with the subaccount to reopen.
smtp2go_send_emailSend a single transactional email through SMTP2GO.WriteSend 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.
Inputs
senderstringrequired- The 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.
toarrayrequired- Array 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).
attachmentsarray- Array 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.
bccarray- Array of BCC recipient names and email addresses, up to 100 entries, same format as 'to'.
ccarray- Array of CC recipient names and email addresses, up to 100 entries, same format as 'to'.
custom_headersarray- Array 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"}].
fastacceptboolean- When 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.default
false html_bodystring- HTML-encoded body content of the email. Required if neither text_body nor template_id is provided.
inlinesarray- Array 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.
schedulestring- Future 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.
subjectstring- Subject line of the email. Ignored if template_id is provided and the template defines its own subject.
template_datastring- Key-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_idstring- Identifier 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_bodystring- Plain text body content of the email. Required if neither html_body nor template_id is provided.
smtp2go_send_email_batchSend up to 1,000 emails in a single SMTP2GO request, each with its own sender, recipients, subject, and body.WriteSend 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.
Inputs
emailsarrayrequired- Array 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_emailSend a raw MIME-encoded email through SMTP2GO.WriteSend 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.
Inputs
mime_emailstringrequired- A 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.
fastacceptboolean- When 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.default
false schedulestring- Future 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_smsSend an SMS text message through SMTP2GO to one or more destination phone numbers.WriteSend 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.
Inputs
contentstringrequired- The text content of the SMS message. If the content exceeds 160 characters, SMTP2GO automatically splits it into multiple billed message units.
destinationarrayrequired- Array 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"].
senderstring- Optional 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_update_allowed_recipientsReplace the full Allowed Recipients list and set whether it is enforced when sending, for this SMTP2GO account.WriteUpdate 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.
- Idempotent
Inputs
allowed_recipientsarrayrequired- Array of email addresses and/or domain names that replaces the entire current Allowed Recipients list. Example: ["user@example.com", "example.com"].
enabledbooleanrequired- Whether the Allowed Recipients list should be taken into account when sending mail.
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_update_allowed_sendersReplace the full Allowed Senders list and set its mode for this SMTP2GO account.WriteUpdate 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.
- Idempotent
Inputs
allowed_sendersarrayrequired- Array of email addresses and/or domain names that replaces the entire current Allowed Senders list. Example: ["user@example.com", "example.com"].
modestringrequired- How 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.one of
whitelistblacklistdisabled subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_update_email_templateUpdate an existing email template on the SMTP2GO account, identified by its current template ID.WriteUpdate 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.
- Idempotent
Inputs
idstringrequired- The case-sensitive ID of the existing email template to update.
html_bodystring- If provided, updates the HTML body content of the template.
new_idstring- If provided, renames the template's ID to this new case-sensitive value.
subjectstring- If provided, updates the subject line of the template.
tagsarray- If provided, replaces the list of tags associated with this template.
template_namestring- If provided, updates the display name of the template.
template_variablesobject- If provided, replaces the default pass-through values for variables used within this template, as a JSON object. Example: {"first_name":"there"}.
text_bodystring- If provided, updates the plain text body content of the template.
smtp2go_update_subaccountUpdate settings on an existing subaccount by its subaccount ID.WriteUpdate 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.
- Idempotent
Inputs
idstringrequired- Unique ID of the existing subaccount to update.
archivingboolean- Whether this subaccount is allowed to enable email archiving. Defaults to false.default
false dedicated_ipboolean- Whether this subaccount should have a dedicated sending IP. Defaults to false.default
false enable_smsboolean- Whether SMS messaging is enabled for this subaccount. Defaults to false.default
false enforce_2faboolean- Whether this subaccount's team members are required to use two-factor authentication. Defaults to false.default
false fullnamestring- New full name for the subaccount.
limitinteger- New maximum number of emails this subaccount can send per billing cycle.
sms_limitinteger- New maximum number of SMS messages this subaccount can send per month. Defaults to 1000.default
1000
smtp2go_verify_sender_domainTrigger a DNS verification check for a sender domain already added to SMTP2GO.WriteVerify 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.
- Idempotent
Inputs
domainstringrequired- The sender domain to attempt verification for, e.g. 'example.com'. Must already be added as a sender domain.
requisition_sslboolean- If true, requisition an SSL certificate for the tracking domain once verification completes. Defaults to true.default
true subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_remove_allowed_recipientsRemove specific email addresses and/or domain names from this SMTP2GO account's Allowed Recipients list.DestructiveRemove 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.
- Idempotent
Inputs
allowed_recipientsarrayrequired- Array 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.
enabledboolean- Whether the Allowed Recipients list is taken into account when sending mail. If omitted, the account's current setting is left unchanged.
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_remove_allowed_sendersRemove specific email addresses and/or domain names from this SMTP2GO account's Allowed Senders list.DestructiveRemove 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.
- Idempotent
Inputs
allowed_sendersarrayrequired- Array of email addresses and/or domain names to remove from the Allowed Senders list. Example: ["user@example.com", "example.com"].
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_remove_api_keyPermanently remove an existing API key from your SMTP2GO account by its ID.DestructiveRemove 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.
- Idempotent
Inputs
idstringrequired- The ID of the existing API key to remove.
subaccount_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
smtp2go_remove_email_templatePermanently delete an email template from the SMTP2GO account, identified by its case-sensitive template ID.DestructiveRemove Email Template
Permanently delete an email template from the SMTP2GO account, identified by its case-sensitive template ID. This action cannot be undone.
- Idempotent
Inputs
idstringrequired- The case-sensitive ID of the email template to remove.
smtp2go_remove_ip_allow_listPermanently remove an IP address from your SMTP2GO account's IP allow list.DestructiveRemove IP Allow List
Permanently remove an IP address from your SMTP2GO account's IP allow list. This action cannot be undone.
- Idempotent
Inputs
ip_addressstringrequired- The IP address to remove from the allow list.
typestring- Which IP allow list to operate on: 'smtp' for SMTP sending IPs, or 'api' for API access IPs. Defaults to 'smtp'.one of
smtpapidefaultsmtp
smtp2go_remove_ip_authPermanently remove an existing IP-based authentication (IP Auth) entry from SMTP2GO, identified by its IP address.DestructiveRemove 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.
- Idempotent
Inputs
ip_addressstringrequired- The IP address of the existing IP Auth entry to remove. Must match an IP Auth entry already configured on the account.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_remove_scheduled_emailsCancel a previously scheduled email so it will not be sent.DestructiveRemove Scheduled Email
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.
- Idempotent
Inputs
schedule_idstringrequired- The 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_domainPermanently delete a sender domain from SMTP2GO, along with its DKIM/return-path configuration and any tracking domain (CNAME) setup.DestructiveRemove 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.
- Idempotent
Inputs
domainstringrequired- The sender domain to delete, e.g. 'example.com'. Must already be added as a sender domain.
subaccount_idstring- If making this API call on behalf of a subaccount, the unique ID of that subaccount.
smtp2go_remove_single_sender_emailRemove a verified Single Sender email address from this SMTP2GO account, so it can no longer be used as a verified FROM address.DestructiveRemove 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.
- Idempotent
Inputs
email_addressstringrequired- The exact email address to remove from the account's verified Single Sender Emails.
subaccount_idstring- If provided, makes this API call on behalf of the specified subaccount instead of the main account.
smtp2go_remove_smtp_userPermanently remove an existing SMTP user (SMTP relay credential) from your SMTP2GO account by username.DestructiveRemove 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.
- Idempotent
Inputs
usernamestringrequired- Username of the existing SMTP user to remove.
subaccount_idstring- ID 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_suppressionRemove 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.DestructiveRemove 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.
- Idempotent
Inputs
email_addressstringrequired- The email address or domain to remove from the suppression list.
reasonsarrayrequired- The block types (reasons) to remove for the given email address or domain. Valid values: manual, spam, unsubscribe, bounce, compliance.
subaccount_idstring- If provided, this call is made on behalf of the subaccount with this unique ID instead of the main account.
smtp2go_remove_webhookPermanently remove an existing webhook from your SMTP2GO account by its ID.DestructiveRemove 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.
- Idempotent
Inputs
idintegerrequired- The 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_idstring- If you wish to make this API call on behalf of a subaccount, include its unique ID here.
No tools match.