{"openapi":"3.0.0","info":{"description":"SMTP2GO is a transactional email delivery service with SMTP relay and REST API. The v3 API sends standard and MIME emails (with templates and attachments), manages allowed senders/recipients, API keys, and reports on activity, bounces and delivery statistics.","version":"v3"},"servers":[{"description":"SMTP2GO is a transactional email delivery service with SMTP relay and REST API. The v3 API sends standard and MIME emails (with templates and attachments), manages allowed senders/recipients, API keys, and reports on activity, bounces and delivery statistics.","url":"https://api.apirails.com/smtp2go"}],"paths":{"/single_sender_emails/add":{"post":{"tags":["Single Sender Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-a-single-sender-email","api_endpoint":"https://api.smtp2go.com/v3/single_sender_emails/add"},"summary":"Add a single sender email","description":"Use the API to add a single sender email address to your account, to use from which to send mail. If the email address has previously been added and not yet verified, this action will simply resend the verification email.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_address":{"type":"string","description":"The email address that you wish to send emails from","required":true},"message":{"type":"string","description":"(Optional) If provided, will add a text only message to the email."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"email_address":"send@example.com","message":"message","subaccount_id":"subaccount_id"}}}}}},"/suppression/add":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-a-suppression","api_endpoint":"https://api.smtp2go.com/v3/suppression/add"},"summary":"Add a suppression","description":"Suppresses the specified email address or domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"block_description":{"type":"string","description":"The description given for suppressing the email or domain from deliveries"},"email_address":{"type":"string","description":"The email address or domain you would like to suppress from deliveries","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"block_description":"block_description","email_address":"email_address","subaccount_id":"subaccount_id"}}}}}},"/allowed_recipients/add":{"post":{"tags":["Allowed Recipients"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-allowed-recipients","api_endpoint":"https://api.smtp2go.com/v3/allowed_recipients/add"},"summary":"Add allowed recipients","description":"Add one or more email addresses and domain names to your Allowed Recipients List. Further details of the associated setting are found in the SMTP2GO Guides.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_recipients":{"type":"array","description":"Array of email addresses and domain names.","required":true,"items":{"type":"string"}},"enabled":{"type":"boolean","description":"A flag indicating if this list is taken into account when sending","enum":[true,false]},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_recipients":["test-person@example.com","other@example.com"],"enabled":true,"subaccount_id":"subaccount_id"}}}}}},"/allowed_senders/add":{"post":{"tags":["Allowed Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-allowed-senders","api_endpoint":"https://api.smtp2go.com/v3/allowed_senders/add"},"summary":"Add allowed senders","description":"Add one or more email addresses and domain names to your Allowed or Restricted Senders List. How this list of email addresses and domain names are used is shown by the current 'mode' value; if the Restrict Senders setting is on, they will form either a whitelist or blacklist. If the setting is off, the list will be disabled. Further details of the associated setting are found in the SMTP2GO Guides. Details of how this mode can be set via the update end-point, are given further in the documentation. A post to this endpoint will return a success, even if the Restrict Senders setting is not in use.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_senders":{"type":"array","description":"Array of email addresses and domain names.","required":true,"items":{"type":"string"}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_senders":["test-person@example.com","other@example.com"],"subaccount_id":"subaccount_id"}}}}}},"/template/add":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-an-email-template","api_endpoint":"https://api.smtp2go.com/v3/template/add"},"summary":"Add an email template","description":"Adds a new email template that you can use to format your emails.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"html_body":{"type":"string","description":"The HTML body of the email template.","required":true},"id":{"type":"string","description":"The case-sensitive ID of the email template. Min length: 5 Character. Max length: 24 Characters.","required":true},"subject":{"type":"string","description":"The subject of the email template.","required":true},"tags":{"type":"array","description":"The list of Tags to associate to this email template","items":{"type":"string"}},"template_name":{"type":"string","description":"The name of the email template. Min length: 1 Character. Max length: 64 Characters.","required":true},"template_variables":{"type":"object","description":"The variables to use within this email template in the format `{\"variable1\": \"value1\", \"variable2\": \"value2\"}`"},"text_body":{"type":"string","description":"The Plain Text body of the email template.","required":true}}},"example":{"html_body":"html_body","id":"id","subject":"subject","tags":["tags"],"template_name":"template_name","template_variables":"template_variables","text_body":"text_body"}}}}}},"/users/smtp/add":{"post":{"tags":["SMTP Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-an-smtp-user","api_endpoint":"https://api.smtp2go.com/v3/users/smtp/add"},"summary":"Add an SMTP user","description":"Add a new SMTP user to your account. Full details of the available options for new user accounts can be found in the SMTP User Guide.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this user. Default: false.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this SMTP User"},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account. Default is [from]."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this user. Default: false","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period . Default: false","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of your new SMTP User"},"email_password":{"type":"string","description":"A valid password for your new SMTP User. Must have an entropy of at least 64 bits. Consider using a password generator or leave blank for an auto generated value. Ideally contain at least: 12 characters, 1 digit, symbol, uppercase letter, and lowercase letter."},"feedback_domain":{"type":"string","description":"The domain to insert into the custom feedback links via the unsubscribe footer. Default: blank Warning: In order to use the SMTP2go feedback handling feature, this parameter needs to be set to \"default\" Setting this value to anything other than \"default\", disables the ability for SMTP2go to correctly manage the feedback responses and should not normally be set to anything other than \"default\""},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings. Default: false","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. Default: blank System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. Default: blank System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"ip_pool":{"type":"number","description":"If passed, any emails sent with this SMTP user will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this user. Default: false","enum":[true,false]},"status":{"type":"string","description":"The initial status of the SMTP user, one of ['allowed', 'blocked', 'sandbox'], defaults to 'allowed'"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"username":{"type":"string","description":"A username to access the SMTP2GO service via SMTP. Length = 5 to 100","required":true}}},"example":{"archive_enabled":"archive_enabled","audit_email":"audit_email","bounce_notifications":"bounce_notifications","click_tracking_enabled":"click_tracking_enabled","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"custom_ratelimit_period","custom_ratelimit_value":"custom_ratelimit_value","description":"description","email_password":"email_password","feedback_domain":"default","feedback_enabled":"feedback_enabled","feedback_html":"feedback_html","feedback_text":"feedback_text","ip_pool":1234,"open_tracking_enabled":"open_tracking_enabled","status":"allowed","subaccount_id":"subaccount_id","username":"username"}}}}}},"/api_keys/add":{"post":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-api-key","api_endpoint":"https://api.smtp2go.com/v3/api_keys/add"},"summary":"Add a new API key","description":"Add a new API key to your account This endpoint is rate-limited to 5 requests per minute.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this API key.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this API key."},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this API key.","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of your new API key"},"endpoints":{"type":"array","description":"An array of endpoints that this API key will be allowed to use. The endpoints passed must be a subset of the endpoints allowed by the API key making this call. A full list of endpoints can be found in the app under Sending->API Keys->Permissions or programatically via the API here . We also accept wildcard patterns, for example to allow access to all email endpoints you can pass [\"/email/*\"] . To allow access to every endpoint simply pass \"endpoints\": [\"*\"]","items":{"type":"string"}},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"ip_pool":{"type":"number","description":"If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this API key.","enum":[true,false]},"status":{"type":"string","description":"The initial status of the API key, one of ['allowed', 'blocked', 'sandbox']."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"archive_enabled":"","audit_email":"audit_email","bounce_notifications":"from","click_tracking_enabled":"","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"0:30:00","custom_ratelimit_value":"custom_ratelimit_value","description":"test api key","endpoints":["/email/send"],"feedback_enabled":"","feedback_html":"test_html","feedback_text":"test_text","ip_pool":1234,"open_tracking_enabled":"","status":"allowed","subaccount_id":"subaccount_id"}}}}}},"/domain/add":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-sender-domain","api_endpoint":"https://api.smtp2go.com/v3/domain/add"},"summary":"Add a sender domain","description":"Add a sender domain to your account. Note that you must own any domains you wish to include in this list, as you will be required to verify and authenticate the emails sent via that domain. Find full details in the Sender Domains Guide.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auto_verify":{"type":"boolean","description":"If true, verify the domain now removing the need to call the 'domain/verify' endpoint or wait for the periodic verification every 7 minutes. Note: In order to successfully complete the verification, the 'tracking_subdomain' and 'returnpath_subdomain' must be configured in the domain DNS and propagated.","enum":[true,false]},"domain":{"type":"string","description":"Domain to add as a sender domain","required":true},"requisition_ssl":{"type":"boolean","description":"If true, requisition an SSL certificate for the tracking domain once verification is complete","enum":[true,false]},"returnpath_subdomain":{"type":"string","description":"An optional subdomain to use as a return-path subdomain"},"subaccount_access":{"type":"object","description":"Allow subaccounts to send from verified sender domains on the master account","properties":{"future_subaccounts":{"type":"boolean","description":"If set to true, will automatically add any new subaccounts to the access list","enum":[true,false]},"subaccounts":{"type":"array","description":"A list of subaccount_ids to be given access. ID's can be found by querying /subaccounts/search (list of IDs/values per the official docs; no item schema is specified)"}}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"tracking_subdomain":{"type":"string","description":"An optional subdomain used for click or open tracking and unsubscribe links"}}},"example":{"auto_verify":true,"domain":"domain","requisition_ssl":true,"returnpath_subdomain":"returnpath_subdomain","subaccount_access":"subaccount_access","subaccount_id":"subaccount_id","tracking_subdomain":"tracking_subdomain"}}}}}},"/subaccount/add":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-subaccount","api_endpoint":"https://api.smtp2go.com/v3/subaccount/add"},"summary":"Add a subaccount","description":"Adds a new subaccount on your master account. Note: This end-point is rate limited to 50 calls per hour.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archiving":{"type":"boolean","description":"Choose whether the subaccount is allowed to enable archiving. You still need to turn on archiving for individual senders within the subaccount.","enum":[true,false]},"dedicated_ip":{"type":"boolean","description":"Auto assign a dedicated IP to the subaccount (Only available if limit is greater than 100,000)","enum":[true,false]},"enable_sms":{"type":"boolean","description":"Enable SMS messaging for the subaccount. Additional charges apply.","enum":[true,false]},"enforce_2fa":{"type":"boolean","description":"Enforce team members of this subaccount to use 2FA.","enum":[true,false]},"fullname":{"type":"string","description":"A full name used for the subaccount","required":true},"limit":{"type":"number","description":"The number of emails the subaccount is allowed to send per billing cycle. Valid values: 2000, 5000, 10000, 20000, 30000, 40000, 50000, 60000, 80000, 100000, 250000, 500000, 1000000, 2000000, 3000000, 5000000, 10000000"},"sms_limit":{"type":"number","description":"Your subaccount will be able to send up to this monthly limit of SMS messages. Their sending will also be limited by the master account's overall monthly limit."},"subaccount_email":{"type":"string","description":"An optional email address for the first team member in the subaccount. An email invitation will be sent to this address."}}},"example":{"archiving":"","dedicated_ip":"","enable_sms":"","enforce_2fa":"","fullname":"fullname","limit":10000,"sms_limit":1000,"subaccount_email":"subaccount_email"}}}}}},"/webhook/add":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/add-webhook","api_endpoint":"https://api.smtp2go.com/v3/webhook/add"},"summary":"Add a new Webhook","description":"Add a new webhook with the given configuration. Setup of webhooks can be done on the Settings > Webhooks page in your SMTP2GO control panel.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auth_header_type":{"type":"string","description":"The type of authentiction header, Either bearer or basic or empty for no authentication."},"auth_header_value":{"type":"string","description":"The value of authentiction header, Either base64(user:pass) or a custom token ."},"events":{"type":"array","description":"A list of events the webhook will receive, from this list [ delivered , unsubscribe , spam , bounce , processed , reject , click , open ].","items":{"type":"string"}},"headers":{"type":"array","description":"Custom headers you would specifically like sent in the event data. The headers must already exist in the emails. Subject and Message-id headers are sent by default.","items":{"type":"string"}},"output_format":{"type":"string","description":"The format of the webhook data. Either form or json ."},"sms_events":{"type":"array","description":"A list of SMS events the webhook will receive, from this list [ delivered , failed , rejected , sending , submitted ].","items":{"type":"string"}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."},"url":{"type":"string","description":"The URL of the webhook.","required":true},"usernames":{"type":"array","description":"Usernames to be included in this webhook. All usernames will be included if none are specified.","items":{"type":"string"}}}},"example":{"auth_header_type":"","auth_header_value":"","events":["events"],"headers":["headers"],"output_format":"form","sms_events":["sms_events"],"subaccount_id":"subaccount_id","url":"url","usernames":["usernames"]}}}}}},"/subaccount/close":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/close-a-subaccount","api_endpoint":"https://api.smtp2go.com/v3/subaccount/close"},"summary":"Close a subaccount","description":"Changes the status of an Active subaccount to Closed","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email address of the subaccount you want to close"},"id":{"type":"string","description":"The id of the subaccount you want to close","required":true}}},"example":{"email":"email","id":"id"}}}}}},"/users/smtp/edit":{"post":{"tags":["SMTP Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-an-smtp-user","api_endpoint":"https://api.smtp2go.com/v3/users/smtp/edit"},"summary":"Edit SMTP user details","description":"Update an SMTP user's details with the parameters passed. Full details of the available options for SMTP user accounts is found in the SMTP User Guide.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving will be enabled for this user. Default: false","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this SMTP User"},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account. Default is [from]."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this user. Default: false","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \" {hour[s]|day[s]|week[s]|month[s]}[,hh:mm:ss]\". Examples: \"1 day\", \"1 week\", \"1 month\", \"2 months 3:00:00\""},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the maximum number of emails this user can send in the custom_ratelimit_period . Values: 1 to 2147483647"},"description":{"type":"string","description":"A comment or description of your new SMTP User"},"email_password":{"type":"string","description":"A valid password for your new SMTP User. Must have an entropy of at least 64 bits. Consider using a password generator or leave blank for an auto generated value. Ideally contain at least: 12 characters, 1 digit, symbol, uppercase letter, and lowercase letter."},"feedback_domain":{"type":"string","description":"The domain to insert into the custom feedback links via the unsubscribe footer"},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings. Default: false","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer"},"ip_pool":{"type":"number","description":"If passed, any emails sent with this SMTP user will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this user. Default: false","enum":[true,false]},"status":{"type":"string","description":"If passed will set the status of the SMTP user, one of ['allowed', 'blocked', 'sandbox']"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"username":{"type":"string","description":"A valid username of your existing SMTP User that you wish to edit","required":true}}},"example":{"archive_enabled":"archive_enabled","audit_email":"audit_email","bounce_notifications":"bounce_notifications","click_tracking_enabled":"click_tracking_enabled","custom_ratelimit":"","custom_ratelimit_period":"custom_ratelimit_period","custom_ratelimit_value":"custom_ratelimit_value","description":"description","email_password":"email_password","feedback_domain":"feedback_domain","feedback_enabled":"feedback_enabled","feedback_html":"feedback_html","feedback_text":"feedback_text","ip_pool":1234,"open_tracking_enabled":"open_tracking_enabled","status":"status","subaccount_id":"subaccount_id","username":"username"}}}}},"patch":{"tags":["SMTP Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/patch-an-smtp-user","api_endpoint":"https://api.smtp2go.com/v3/users/smtp/edit"},"summary":"Patch an SMTP user","description":"Patch an existing SMTP user ignoring missing properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this SMTP user.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this SMTP user."},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this SMTP user.","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of the SMTP user"},"email_password":{"type":"string","description":"A valid SMTP2GO password for your existing SMTP User. Must have an entropy of at least 64 bits. Consider using a password generator or leave blank for an auto generated value."},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"ip_pool":{"type":"number","description":"If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this SMTP user.","enum":[true,false]},"status":{"type":"string","description":"The initial status of the SMTP user, one of ['allowed', 'blocked', 'sandbox']."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."},"username":{"type":"string","description":"A valid username of your existing SMTP User that you wish to edit","required":true}}},"example":{"archive_enabled":"archive_enabled","audit_email":"audit_email","bounce_notifications":"bounce_notifications","click_tracking_enabled":"click_tracking_enabled","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"0:30:00","custom_ratelimit_value":"custom_ratelimit_value","description":"test smtp user","email_password":"email_password","feedback_enabled":"feedback_enabled","feedback_html":"test_html","feedback_text":"test_text","ip_pool":1234,"open_tracking_enabled":"open_tracking_enabled","status":"status","subaccount_id":"subaccount_id","username":"my_user"}}}}}},"/api_keys/edit":{"post":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-api-key","api_endpoint":"https://api.smtp2go.com/v3/api_keys/edit"},"summary":"Edit an API key","description":"Edit an existing API key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this API key.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this API key."},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this API key.","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of your new API key"},"endpoints":{"type":"array","description":"An array of endpoints that this API key will be allowed to use. Any additional endpoints passed must be a subset of the endpoints allowed by the API key making this call. A full list of endpoints can be found in the app under Sending->API Keys->Permissions or programatically via the API here . We also accept wildcard patterns, for example to allow access to all email endpoints you can pass [\"/email/*\"] . To allow access to every endpoint simply pass \"endpoints\": [\"*\"]","items":{"type":"string"}},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"id":{"type":"string","description":"The ID of the existing API key you wish to edit.","required":true},"ip_pool":{"type":"number","description":"If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this API key.","enum":[true,false]},"status":{"type":"string","description":"The initial status of the API key, one of ['allowed', 'blocked', 'sandbox']."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"archive_enabled":"","audit_email":"audit_email","bounce_notifications":"from","click_tracking_enabled":"","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"0:30:00","custom_ratelimit_value":"custom_ratelimit_value","description":"test api key","endpoints":["/email/send"],"feedback_enabled":"","feedback_html":"test_html","feedback_text":"test_text","id":"api-00000000000000000000000000000000","ip_pool":1234,"open_tracking_enabled":"","status":"allowed","subaccount_id":"subaccount_id"}}}}},"patch":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/patch-api-key","api_endpoint":"https://api.smtp2go.com/v3/api_keys/edit"},"summary":"Patch an API key","description":"Patch an existing API key ignoring missing properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this API key.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this API key."},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this API key.","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of your new API key"},"endpoints":{"type":"array","description":"An array of endpoints that this API key will be allowed to use. Any additional endpoints passed must be a subset of the endpoints allowed by the API key making this call. A full list of endpoints can be found in the app under Sending->API Keys->Permissions or programatically via the API here . We also accept wildcard patterns, for example to allow access to all email endpoints you can pass [\"/email/*\"] . To allow access to every endpoint simply pass \"endpoints\": [\"*\"]","items":{"type":"string"}},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"id":{"type":"string","description":"The ID of the existing API key you wish to edit.","required":true},"ip_pool":{"type":"number","description":"If passed, any emails sent with this API key will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this API key.","enum":[true,false]},"status":{"type":"string","description":"The initial status of the API key, one of ['allowed', 'blocked', 'sandbox']."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"archive_enabled":"archive_enabled","audit_email":"audit_email","bounce_notifications":"bounce_notifications","click_tracking_enabled":"click_tracking_enabled","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"0:30:00","custom_ratelimit_value":"custom_ratelimit_value","description":"test api key","endpoints":["endpoints"],"feedback_enabled":"feedback_enabled","feedback_html":"test_html","feedback_text":"test_text","id":"api-00000000000000000000000000000000","ip_pool":1234,"open_tracking_enabled":"open_tracking_enabled","status":"status","subaccount_id":"subaccount_id"}}}}}},"/domain/returnpath":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-return-path-domain","api_endpoint":"https://api.smtp2go.com/v3/domain/returnpath"},"summary":"Edit the return-path subdomain","description":"A Return Path Subdomain is used to instruct the server where to return emails that are not deliverable (ie. Bounces). This endpoint allows you to edit a Return Path Subdomain for a particular sender domain. Full details can be found in the Sender Domain Guide.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"The sender domain to edit the return-path subdomain for","required":true},"new_subdomain":{"type":"string","description":"The domains new return-path subdomain","required":true},"old_subdomain":{"type":"string","description":"The domains old return-path subdomain","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"domain":"domain","new_subdomain":"return","old_subdomain":"returns","subaccount_id":"subaccount_id"}}}}}},"/domain/subaccount_access":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-subaccount-access","api_endpoint":"https://api.smtp2go.com/v3/domain/subaccount_access"},"summary":"Edit subaccount access","description":"Allow subaccounts to send from verified sender domains on the master account.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"The sender domain to edit subaccount access for","required":true},"future_subaccounts":{"type":"boolean","description":"If set to true, will automatically add any new subaccounts to the access list","enum":[true,false]},"subaccounts":{"type":"array","description":"A list of subaccount_ids to be given access. ID's can be found by querying /subaccounts/search (list of IDs/values per the official docs; no item schema is specified)","required":true,"items":{"type":"string"}}}},"example":{"domain":"domain","future_subaccounts":"","subaccounts":["subaccounts"]}}}}}},"/domain/tracking":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-tracking-domain","api_endpoint":"https://api.smtp2go.com/v3/domain/tracking"},"summary":"Edit the tracking subdomain","description":"A Tracking Subdomain is used to monitor your email opens and clicks. This endpoint allows you to edit a tracking subdomain for a particular sender domain. Full details can be found in the Sender Domain Guide.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"The sender domain to edit the tracking subdomain for","required":true},"new_subdomain":{"type":"string","description":"The domains new tracking subdomain","required":true},"old_subdomain":{"type":"string","description":"The domains old tracking subdomain","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"domain":"domain","new_subdomain":"link","old_subdomain":"track","subaccount_id":"subaccount_id"}}}}}},"/webhook/edit":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/edit-webhook","api_endpoint":"https://api.smtp2go.com/v3/webhook/edit"},"summary":"Edit a specified Webhook","description":"Make changes to a specific webhook using its unique ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"auth_header_type":{"type":"string","description":"The type of authentiction header, Either bearer or basic or empty for no authentication."},"auth_header_value":{"type":"string","description":"The value of authentiction header, Either base64(user:pass) or a custom token ."},"events":{"type":"array","description":"A list of events the webhook will receive, from this list [ delivered , unsubscribe , spam , bounce , processed , reject , click , open ].","items":{"type":"string"}},"headers":{"type":"array","description":"Custom headers you would specifically like sent in the event data. The headers must already exist in the emails. Subject and Message-id headers are sent by default.","items":{"type":"string"}},"id":{"type":"number","description":"The ID of an existing webhook you want to edit","required":true},"output_format":{"type":"string","description":"The format of the webhook data. Either form or json"},"sms_events":{"type":"array","description":"A list of SMS events the webhook will receive, from this list [ delivered , failed , rejected , sending , submitted ].","items":{"type":"string"}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."},"url":{"type":"string","description":"The URL of the webhook."},"usernames":{"type":"array","description":"Usernames to be included in this webhook. All usernames will be included if none are specified.","items":{"type":"string"}}}},"example":{"auth_header_type":"","auth_header_value":"","events":["events"],"headers":["headers"],"id":"id","output_format":"form","sms_events":["sms_events"],"subaccount_id":"subaccount_id","url":"url","usernames":["usernames"]}}}}}},"/stats/email_bounces":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-bounces","api_endpoint":"https://api.smtp2go.com/v3/stats/email_bounces"},"summary":"Email bounces","description":"Retrieve a summary of bounces and rejects, for the last 30 days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"Allows statistics to be returned for a specific user."}}},"example":{"username":"username"}}}}}},"/stats/email_cycle":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-cycle","api_endpoint":"https://api.smtp2go.com/v3/stats/email_cycle"},"summary":"Email cycle","description":"Retrieve a summary of your Account activity, including the start and end date of your monthly plan, the number of emails sent this cycle, the number of emails remaining and the number of emails in your monthly allowance.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/stats/email_history":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-history","api_endpoint":"https://api.smtp2go.com/v3/stats/email_history"},"summary":"Email history","description":"Retrieve a summary of activity from a specified date range (defaults to last 30 days), per sender email address, SMTP username, domain or subaccount.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults the current time. Timezone is UTC"},"group_by":{"type":"string","description":"One of [ email_address , username , domain , subaccount ] - controls the grouping of results. Defaults to email_address"},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to 30 days prior to the current date at midnight. Timezone is UTC"},"subaccounts":{"type":"array","description":"Pass an optional list of subaccount ids to fetch a summary of only particular subaccounts, ID's can be found by querying /subaccounts/search (list of IDs/values per the official docs; no item schema is specified)","items":{"type":"string"}}}},"example":{"end_date":"end_date","group_by":"group_by","start_date":"start_date","subaccounts":["subaccounts"]}}}}}},"/stats/email_spam":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-spam","api_endpoint":"https://api.smtp2go.com/v3/stats/email_spam"},"summary":"Email spam","description":"Retrieve a summary of spam complaints and rejects, for the last 30 days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"Allows statistics to be returned for a specific user."}}},"example":{"username":"username"}}}}}},"/stats/email_summary":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-summary","api_endpoint":"https://api.smtp2go.com/v3/stats/email_summary"},"summary":"Email summary","description":"Retrieve a combination of the email_bounces, email_cycle, email_spam, and email_unsubs calls in one report. Note this call may take longer to complete.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"Allows statistics to be returned for a specific user"}}},"example":{"username":"username"}}}}}},"/stats/email_unsubs":{"post":{"tags":["Statistics"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/email-unsubscribes","api_endpoint":"https://api.smtp2go.com/v3/stats/email_unsubs"},"summary":"Email unsubscribes","description":"Retrieve a summary of unsubscribes and rejects, for the last 30 days.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"username":{"type":"string","description":"Allows statistics to be returned for a specific user."}}},"example":{"username":"username"}}}}}},"/ip_auth/edit":{"patch":{"tags":["IP AUTH"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/patch-ip-auth","api_endpoint":"https://api.smtp2go.com/v3/ip_auth/edit"},"summary":"Patch an IP Auth","description":"Patch an existing IP Auth ignoring missing properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archive_enabled":{"type":"boolean","description":"If true, archiving (available on paid plans) will be enabled for this IP Auth.","enum":[true,false]},"audit_email":{"type":"string","description":"If passed, this email will be BCC'd on all emails sent by this IP Auth."},"bounce_notifications":{"type":"string","description":"If passed, will control how bounce notifications are handled. Must be one of [from, drop, or a valid email address]. [from] will return the email to sender, [drop] will discard the event, and the inclusion of an email address will send the event on to this account."},"click_tracking_enabled":{"type":"boolean","description":"If true, click tracking will be enabled for this IP Auth.","enum":[true,false]},"custom_ratelimit":{"type":"boolean","description":"If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period .","enum":[true,false]},"custom_ratelimit_period":{"type":"string","description":"If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value . Syntax: \"\\ [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]\". Examples: \"0:30:00\", \"1 hour\", \"2 days\", \"3 months\", \"4 months 5:00:00\". Note: Only stores this value if custom_ratelimit is true."},"custom_ratelimit_value":{"type":"number","description":"If passed, defines the limit of emails this user can send in the period specified in custom_ratelimit_period . Note: Only stores this value if custom_ratelimit is true."},"description":{"type":"string","description":"A comment or description of the IP Auth"},"feedback_enabled":{"type":"boolean","description":"If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.","enum":[true,false]},"feedback_html":{"type":"string","description":"The HTML content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"feedback_text":{"type":"string","description":"The text content to insert into the custom feedback email body via the unsubscribe footer. System Variables (Only available here): Unsubscribe URL = %%UNSUBSCRIBE%% Email address = %%EMAIL%%"},"ip_address":{"type":"string","description":"A valid IP address of your existing IP Auth that you wish to edit","required":true},"ip_pool":{"type":"number","description":"If passed, any emails sent with this IP Auth will use dedicated IP's in this IP Pool, This value can be found on the /v3/dedicated_ips/view endpoint."},"open_tracking_enabled":{"type":"boolean","description":"If true, open tracking will be enabled for this IP Auth user.","enum":[true,false]},"status":{"type":"string","description":"The initial status of the IP Auth user, one of ['allowed', 'blocked', 'sandbox']."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"archive_enabled":"archive_enabled","audit_email":"audit_email","bounce_notifications":"bounce_notifications","click_tracking_enabled":"click_tracking_enabled","custom_ratelimit":"custom_ratelimit","custom_ratelimit_period":"0:30:00","custom_ratelimit_value":"custom_ratelimit_value","description":"test smtp user","feedback_enabled":"feedback_enabled","feedback_html":"test_html","feedback_text":"test_text","ip_address":"127.0.0.1","ip_pool":1234,"open_tracking_enabled":"open_tracking_enabled","status":"status","subaccount_id":"subaccount_id"}}}}}},"/single_sender_emails/remove":{"post":{"tags":["Single Sender Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-a-single-sender-email","api_endpoint":"https://api.smtp2go.com/v3/single_sender_emails/remove"},"summary":"Remove a single sender email","description":"Remove a single sender email address from your account. Include the address to remove as the email_address parameter.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_address":{"type":"string","description":"The email address to remove from your Single Sender Emails","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"email_address":"send@example.com","subaccount_id":"subaccount_id"}}}}}},"/suppression/remove":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-a-suppression","api_endpoint":"https://api.smtp2go.com/v3/suppression/remove"},"summary":"Remove a suppression","description":"Removes the suppression on the specified email address or domain","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_address":{"type":"string","description":"The email address or domain you would like to remove from your suppression list","required":true},"reasons":{"type":"array","description":"A list of block types you would like to remove for the given email or domain","required":true,"items":{"type":"string"}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"email_address":"test@example.com","reasons":["manual","spam"],"subaccount_id":"subaccount_id"}}}}}},"/allowed_recipients/remove":{"post":{"tags":["Allowed Recipients"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-allowed-recipients","api_endpoint":"https://api.smtp2go.com/v3/allowed_recipients/remove"},"summary":"Remove allowed recipients","description":"Remove one or more emails addresses or domain names stored in your Allowed Recipients List. Note: In the event that any of the email addresses or domains do not feature in the list, no error will be raised.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_recipients":{"type":"array","description":"Array of email addresses and domain names to remove.","required":true,"items":{"type":"string"}},"enabled":{"type":"boolean","description":"A flag indicating if this list is taken into account when sending","enum":[true,false]},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_recipients":["test-person@example.com"],"enabled":true,"subaccount_id":"subaccount_id"}}}}}},"/allowed_senders/remove":{"post":{"tags":["Allowed Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-allowed-senders","api_endpoint":"https://api.smtp2go.com/v3/allowed_senders/remove"},"summary":"Remove allowed senders","description":"Remove one or more emails addresses or domain names stored in your Allowed or Restricted Senders List. Note: In the event that any of the email addresses or domains do not feature in the list, no error will be raised.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_senders":{"type":"array","description":"Array of email addresses and domain names to remove.","required":true,"items":{"type":"string"}},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_senders":["test-person@example.com"],"subaccount_id":"subaccount_id"}}}}}},"/template/delete":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-an-email-template","api_endpoint":"https://api.smtp2go.com/v3/template/delete"},"summary":"Remove an email template","description":"Deletes the specified email template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"The case-sensitive ID of the email template that you wish to remove","required":true}}},"example":{"id":"id"}}}}}},"/users/smtp/remove":{"post":{"tags":["SMTP Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-an-smtp-user","api_endpoint":"https://api.smtp2go.com/v3/users/smtp/remove"},"summary":"Remove an SMTP user","description":"Remove an SMTP user from your account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"username":{"type":"string","description":"A valid SMTP2GO username of your existing SMTP User that you wish to remove","required":true}}},"example":{"subaccount_id":"subaccount_id","username":"username"}}}}}},"/api_keys/remove":{"post":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-api-key","api_endpoint":"https://api.smtp2go.com/v3/api_keys/remove"},"summary":"Remove an API key","description":"Remove an existing API key","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"The ID of the existing API key you wish to remove.","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"id":"api-00000000000000000000000000000000","subaccount_id":"subaccount_id"}}}}}},"/ip_auth/remove":{"post":{"tags":["IP AUTH"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-ip-auth","api_endpoint":"https://api.smtp2go.com/v3/ip_auth/remove"},"summary":"Remove an IP Auth entry","description":"Remove an IP Auth entry from your account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ip_address":{"type":"string","description":"A valid ip address of an existing IP Auth entry that you wish to remove","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"ip_address":"ip_address","subaccount_id":"subaccount_id"}}}}}},"/email/scheduled/remove":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-scheduled-emails","api_endpoint":"https://api.smtp2go.com/v3/email/scheduled/remove"},"summary":"Remove a scheduled email","description":"Removes a scheduled email by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"schedule_id":{"type":"string","description":"The schedule_id returned from /v3/email/scheduled/search or the following endpoints [ /v3/email/send , /v3/email/mime ] (when schedule is passed)","required":true}}},"example":{"schedule_id":"schedule_id"}}}}}},"/domain/remove":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-sender-domain","api_endpoint":"https://api.smtp2go.com/v3/domain/remove"},"summary":"Remove a sender domain","description":"Remove a sender domain from your account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"Sender Domain to delete.","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"domain":"domain","subaccount_id":"subaccount_id"}}}}}},"/webhook/remove":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/remove-webhook","api_endpoint":"https://api.smtp2go.com/v3/webhook/remove"},"summary":"Remove a specified Webhook","description":"Remove a specific webhook using its unique ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"number","description":"The ID of an existing webhook you want to remove","required":true},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"id":"id","subaccount_id":"subaccount_id"}}}}}},"/subaccount/reopen":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/reopen-a-closed-subaccount","api_endpoint":"https://api.smtp2go.com/v3/subaccount/reopen"},"summary":"Reopen a closed subaccount","description":"Changes the status of a Closed subaccount back to Active","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email address of the subaccount you want to reopen"},"id":{"type":"string","description":"The id of the subaccount you want to reopen","required":true}}},"example":{"email":"email","id":"id"}}}}}},"/activity/search":{"post":{"tags":["Activity"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/search-activity","api_endpoint":"https://api.smtp2go.com/v3/activity/search"},"summary":"Search activity","description":"Returns events (such as opens, unsubscribes) which match the filters passed. A count of events matching the filter is also included, as this may surpass the maximum of 1,000 items included within the response. This endpoint is rate-limited to 60 requests per minute.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_headers":{"type":"array","description":"A list of header keys to parse out of the raw headers","items":{"type":"string"}},"continue_token":{"type":"string","description":"If passed, will continue the search beyond the current page, using the same search parameters"},"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to now. Timezone is UTC.Defaults to current date at midnight. Valid formats are: 2006-01-02 , 2006-01-02 15:04:05 , 2006-01-02T15:04:05 , 2006-01-02T15:04:05.0000000 , 02 Jan 06 15:04 MST , 02 Jan 06 15:04 -0700 , 2006-01-02T15:04:05Z07:00 , 2006-01-02T15:04:05.999999999Z07:00 , Mon, 02 Jan 2006 15:04:05 MST"},"event_types":{"type":"array","description":"If passed, will limit the returned events to the provided event types. Values: 'processed', 'soft-bounced', 'hard-bounced', 'rejected', 'spam', 'delivered', 'unsubscribed', 'resubscribed', 'opened', 'clicked'","items":{"type":"string"}},"include_headers":{"type":"boolean","description":"Return the full email headers with the response","enum":[true,false]},"limit":{"type":"number","description":"The maximum number of events to return (Max: 1000)"},"only_latest":{"type":"boolean","description":"If true, will only return the most recent event for each email returned. Default: false","enum":[true,false]},"only_latest_by_sent":{"type":"boolean","description":"If true, will only return the most recent event for each email returned ordered by sent date (overrides only_latest field). Default: false","enum":[true,false]},"region":{"type":"string","description":"Optional. By default, activity search queries the region where the master account is located. If the account has subaccounts in other regions, pass this field to force the search to query activity data in that region.","enum":["us","eu","au"]},"search":{"type":"string","description":"If passed, will return all events for emails containing this string in any search fields. To return events with one or more text values, separate the text with '|' (e.g. 'text1 | text2')"},"search_email_id":{"type":"string","description":"If passed, will return all events for an email matching this specific id"},"search_recipient":{"type":"string","description":"If passed, will return all events for emails containing this string in the email recipient"},"search_sender":{"type":"string","description":"If passed, will return all events for emails containing this string in the email sender"},"search_subject":{"type":"string","description":"If passed, will return all events for emails containing this string in the email subject"},"search_usernames":{"type":"array","description":"If passed, will return all events for emails sent by this/these username/s","items":{"type":"string"}},"start_date":{"type":"string","description":"start_date (body parameter)"},"subaccounts":{"type":"array","description":"If passed, will return all events for emails sent by this/these subaccount_id/s (as returned from the /subaccount/search endpoint or as shown in the App)","items":{"type":"string"}}}},"example":{"custom_headers":["custom_headers"],"continue_token":"continue_token","end_date":"end_date","event_types":["event_types"],"include_headers":"","limit":100,"only_latest":"only_latest","only_latest_by_sent":"only_latest_by_sent","region":"us","search":"search","search_email_id":"search_email_id","search_recipient":"search_recipient","search_sender":"search_sender","search_subject":"search_subject","search_usernames":["search_usernames"],"start_date":"start_date","subaccounts":["subaccounts"]}}}}}},"/archive/search":{"post":{"tags":["Email Archive"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/search-archived-pages","api_endpoint":"https://api.smtp2go.com/v3/archive/search"},"summary":"Search archived content","description":"Retrieve a list of up to 5,000 archived emails matching the supplied parameters.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"continue_token":{"type":"string","description":"If passed, will continue the previous search if too many results were found."},"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to now. Timezone is UTC."},"envelope_from":{"type":"string","description":"If passed, only return emails with this envelope_from"},"headers":{"type":"string","description":"If passed, only return emails with this substring in the headers"},"limit":{"type":"number","description":"The maximum number of emails to return (Default: 5,000)"},"recipient":{"type":"string","description":"If passed, only return emails with this recipient"},"sender":{"type":"string","description":"If passed, only return emails with this sender"},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to current date at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC."},"subject":{"type":"string","description":"If passed, only return emails with this subject"},"username":{"type":"string","description":"If passed, only return email details sent by this user"}}},"example":{"continue_token":"continue_token","end_date":"end_date","envelope_from":"envelope_from","headers":"headers","limit":"limit","recipient":"recipient","sender":"sender","start_date":"start_date","subject":"subject","username":"username"}}}}}},"/template/search":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/search-email-templates","api_endpoint":"https://api.smtp2go.com/v3/template/search"},"summary":"View email templates","description":"Search your collection of email templates. Returns any templates that match your search criteria.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"continue_token":{"type":"string","description":"If provided, will fetch the next page of results, following on from the previous page of results from which this continue token was returned"},"fuzzy_search":{"type":"boolean","description":"If provided, will determine whether search terms are matched exactly or using wildcards. Default: false","enum":[true,false]},"page_size":{"type":"number","description":"If provided, will limit the number of email templates returned. Default 100"},"search_terms":{"type":"array","description":"If provided, will return email templates containing any of the strings provided in name, tag, id or subject fields.","items":{"type":"string"}},"sort_direction":{"type":"string","description":"If provided, will sort the returned email templates in ascending or descending order. Default: asc Values: asc or desc"},"tags":{"type":"array","description":"If provided, will return email templates containing any of the tags provided","items":{"type":"string"}}}},"example":{"continue_token":"continue_token","fuzzy_search":"fuzzy_search","page_size":"page_size","search_terms":["search_terms"],"sort_direction":"sort_direction","tags":["tags"]}}}}}},"/email/scheduled/search":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/search-scheduled-emails","api_endpoint":"https://api.smtp2go.com/v3/email/scheduled/search"},"summary":"Search schedule emails","description":"Allows searching of scheduled emails","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"limit":{"type":"number","description":"If passed will limit the search results"},"page":{"type":"number","description":"If passed will return the results of the specific page"},"schedule_id":{"type":"string","description":"The schedule_id returned from the `/email/send` endpoint"},"search_recipient":{"type":"string","description":"The recipient of the email you want to search for"},"search_sender":{"type":"string","description":"The sender of the email you want to search for"},"search_subject":{"type":"string","description":"The subject of the email you want to search for"}}},"example":{"limit":1000,"page":"page","schedule_id":"schedule_id","search_recipient":"search_recipient","search_sender":"search_sender","search_subject":"search_subject"}}}}}},"/subaccounts/search":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/search-subaccounts","api_endpoint":"https://api.smtp2go.com/v3/subaccounts/search"},"summary":"View subaccounts","description":"Returns any subaccounts that match search criteria","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"continue_token":{"type":"string","description":"A token provided by a prior call to this endpoint, passing this will cause it to fetch the next page of results"},"fuzzy_search":{"type":"boolean","description":"Determines if search terms match complete field values and are case sensitive (false) or partial fields and are case insensitive (true). Default: true","enum":[true,false]},"page_size":{"type":"number","description":"Number of subaccounts to retrieve per call"},"search_terms":{"type":"array","description":"Return subaccounts with one or more of the strings in the following array. Note: See 'fuzzy_search' for impact on case sensitivity","items":{"type":"string"}},"sort_direction":{"type":"string","description":"Sort direction, sorts either asc or desc by subaccount name"},"states":{"type":"string","description":"Controls which states you will be searched Valid values: all, active, closed, suspended"}}},"example":{"continue_token":"continue_token","fuzzy_search":true,"page_size":100,"search_terms":["search_terms"],"sort_direction":"asc","states":"all"}}}}}},"/email/batch":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/send-email-batch","api_endpoint":"https://api.smtp2go.com/v3/email/batch"},"summary":"Send a batch of emails","description":"Send a batch of emails","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"emails":{"type":"array","description":"An array of email objects to schedule","required":true,"items":{"type":"object","properties":{"custom_headers":{"type":"array","description":"An array of custom header objects to be applied to the email. For example, a `Reply-To` email can be specified here, with header `Reply-To` and value `name@example.com`. For sending purposes the following headers are not allowed `Content-Type`, `Content-Transfer-Encoding` and `MIME-Version`."},"attachments":{"type":"array","description":"An array of attachment objects to be attached to the email"},"bcc":{"type":"array","description":"An array of names and email addresses (up to 100) to BCC, in the format `Name `"},"cc":{"type":"array","description":"An array of names and email addresses (up to 100) to CC, in the format `Name `"},"html_body":{"type":"string","description":"A HTML encoded email body. Either html_body or text_body is required if template_id is not passed. Warning: To correctly track clicking of URLs you must: Enable click tracking for the API key Insert a full anchor HTML element (not just the URL) Include \"https://\" at the start of the HREF property"},"inlines":{"type":"array","description":"An array of images to be inlined into the email. Use an image in content as ` `"},"schedule":{"type":"string","description":"A timestamp that when passed allows you to schedule an email for sending. Must be in the future and within the next 3 days. The api response will include a `schedule_id` property which can then be used alongside webhooks (An `X-Smtp2go-Schedule-Id` header is added to the sent email corresponds to this id). A total of 50,000 emails can be queued at any one time."},"sender":{"type":"string","description":"The name and email address to send from, in the format `Name `","required":true},"subject":{"type":"string","description":"The subject of the email to be sent","required":true},"template_data":{"type":"string","description":"When a template_id is provided, include the pass-through values in the format `{\"variable1\": \"value1\", \"variable2\": \"value2\"}`"},"template_id":{"type":"string","description":"The ID of the template you wish to use"},"text_body":{"type":"string","description":"A plain text email body. Either html_body or text_body is required if template_id is not passed"},"to":{"type":"array","description":"An array of names and email addresses (up to 100) to send to, in the format `Name `","required":true}}}}}},"example":{"emails":["emails"]}}}}}},"/email/mime":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/send-mime-email","api_endpoint":"https://api.smtp2go.com/v3/email/mime"},"summary":"Send a MIME email","description":"Send an email by supplying a pre-encoded MIME string","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fastaccept":{"type":"boolean","description":"If true, the email will be accepted immediately and sent in a background process. Use webhooks if you need information about final delivery to the recipient. This will soon become the default method of sending via API.","enum":[true,false]},"mime_email":{"type":"string","description":"A valid MIME-encoded string that has been Base64 encoded","required":true},"schedule":{"type":"string","description":"A timestamp that when passed allows you to schedule an email for sending. Must be in the future and within the next 3 days. The api response will include a `schedule_id` property which can then be used alongside webhooks (An `X-Smtp2go-Schedule-Id` header is added to the sent email corresponds to this id). A total of 50,000 emails can be queued at any one time."}}},"example":{"fastaccept":"","mime_email":"mime_email","schedule":"schedule"}}}}}},"/sms/send":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/send-sms","api_endpoint":"https://api.smtp2go.com/v3/sms/send"},"summary":"Send SMS","description":"Send an SMS message to one or more numbers, up to a maximum of 100 numbers.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"content":{"type":"string","description":"The content of the SMS. If more than 160 characters, will be sent as multiple units.","required":true},"destination":{"type":"array","description":"An array of SMS numbers to send the message to (Maximum: 100 numbers). Numbers should include the country code of the recipient, and can optionally start with a plus symbol (+).","required":true,"items":{"type":"string"}},"sender":{"type":"string","description":"The message will be sent from this number (must be in e.164 format). Leave empty to use the default sender number. If the source and destination are located in different countries, a shared number in the recipient's country will be used for sending."}}},"example":{"content":"content","destination":["destination"],"sender":"sender"}}}}}},"/email/send":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/send-standard-email","api_endpoint":"https://api.smtp2go.com/v3/email/send"},"summary":"Send a standard email","description":"Send an email by passing a JSON email object","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"custom_headers":{"type":"array","description":"An array of custom header objects to be applied to the email. For example, a `Reply-To` email can be specified here, with header `Reply-To` and value `name@example.com`. For sending purposes the following headers are not allowed `Content-Type`, `Content-Transfer-Encoding` and `MIME-Version`.","items":{"type":"object","properties":{"header":{"type":"string","description":"Custom header to add to the email","required":true},"value":{"type":"string","description":"Custom header value to set","required":true}}}},"attachments":{"type":"array","description":"An array of attachment objects to be attached to the email","items":{"type":"object","properties":{"fileblob":{"type":"string","description":"The Base64 encoded binary data of the file. Required if no url is specified."},"filename":{"type":"string","description":"The filename to use for this binary data","required":true},"mimetype":{"type":"string","description":"The mimetype of the binary data"},"url":{"type":"string","description":"A URL pointing to the attachment data. The data is directly retrieved by our system, and cached for fast re-use for 24 hours. Required if no fileblob is specified"}}}},"bcc":{"type":"array","description":"An array of names and email addresses (up to 100) to BCC, in the format `Name `","items":{"type":"string"}},"cc":{"type":"array","description":"An array of names and email addresses (up to 100) to CC, in the format `Name `","items":{"type":"string"}},"fastaccept":{"type":"boolean","description":"If true, the email will be accepted immediately and sent in a background process. Use webhooks if you need information about final delivery to the recipient. This will soon become the default method of sending via API.","enum":[true,false]},"html_body":{"type":"string","description":"A HTML encoded email body. Either html_body or text_body is required if template_id is not passed. If template_id is passed this field is ignored. Warning: To correctly track clicking of URLs you must: Enable click tracking for the API key Insert a full anchor HTML element (not just the URL) Include \"https://\" at the start of the HREF property"},"inlines":{"type":"array","description":"An array of images to be inlined into the email. Use an image in content as ` `","items":{"type":"object","properties":{"fileblob":{"type":"string","description":"The Base64 encoded binary data of the file. Required if no url is specified."},"filename":{"type":"string","description":"The filename to use for this binary data","required":true},"mimetype":{"type":"string","description":"The mimetype of the binary data"},"url":{"type":"string","description":"A URL pointing to the attachment data. The data is directly retrieved by our system, and cached for fast re-use for 24 hours. Required if no fileblob is specified"}}}},"schedule":{"type":"string","description":"A timestamp that when passed allows you to schedule an email for sending. Must be in the future and within the next 3 days. The api response will include a `schedule_id` property which can then be used alongside webhooks (An `X-Smtp2go-Schedule-Id` header is added to the sent email corresponds to this id). A total of 50,000 emails can be queued at any one time."},"sender":{"type":"string","description":"The name and email address to send from, in the format `Name `","required":true},"subject":{"type":"string","description":"The subject of the email to be sent, Note: if template_id if passed this field is ignored. If you would like to set a custom subject in the template_data , use a variable ( {{custom_subject}} for instance) as the value of the templates subject and then set its value in template_data respectively."},"template_data":{"type":"string","description":"When a template_id is provided, include the pass-through values in the format `{\"variable1\": \"value1\", \"variable2\": \"value2\"}`"},"template_id":{"type":"string","description":"The ID of the template you wish to use"},"text_body":{"type":"string","description":"A plain text email body. Either html_body or text_body is required if template_id is not passed. If template_id is passed this field is ignored."},"to":{"type":"array","description":"An array of names and email addresses (up to 100) to send to, in the format `Name `","required":true,"items":{"type":"string"}}}},"example":{"custom_headers":["custom_headers"],"attachments":["attachments"],"bcc":["bcc"],"cc":["cc"],"fastaccept":"","html_body":"html_body","inlines":["inlines"],"schedule":"schedule","sender":"sender","subject":"subject","template_data":"template_data","template_id":"template_id","text_body":"text_body","to":["to"]}}}}}},"/sms/summary":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/sms-summary","api_endpoint":"https://api.smtp2go.com/v3/sms/summary"},"summary":"SMS Summary","description":"Retrieve a summary of SMS messages within a certain time range.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to now. Timezone is UTC."},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to current date at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"end_date":"end_date","start_date":"start_date","subaccount_id":"subaccount_id"}}}}}},"/subaccount/edit":{"post":{"tags":["Subaccounts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/update-a-subaccount","api_endpoint":"https://api.smtp2go.com/v3/subaccount/edit"},"summary":"Update a subaccount","description":"Changes the details on an existing subaccount","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archiving":{"type":"boolean","description":"Choose whether the subaccount is allowed to enable archiving. You still need to turn on archiving for individual senders within the subaccount.","enum":[true,false]},"dedicated_ip":{"type":"boolean","description":"If provided, will set to the new dedicated IP address for the subaccount (If limit is greater than 100,000)","enum":[true,false]},"enable_sms":{"type":"boolean","description":"Enable SMS messaging for the subaccount. Additional charges apply.","enum":[true,false]},"enforce_2fa":{"type":"boolean","description":"Enforce team members of this subaccount to use 2FA.","enum":[true,false]},"fullname":{"type":"string","description":"If provided, will set to the new full name for the subaccount"},"id":{"type":"string","description":"The id of an existing subaccount","required":true},"limit":{"type":"number","description":"If provided, will set to the new limit for the subaccount"},"sms_limit":{"type":"number","description":"Your subaccount will be able to send up to this monthly limit of SMS messages. Their sending will also be limited by the master account's overall monthly limit."}}},"example":{"archiving":"","dedicated_ip":"","enable_sms":"","enforce_2fa":"","fullname":"fullname","id":"id","limit":"limit","sms_limit":1000}}}}}},"/allowed_recipients/update":{"post":{"tags":["Allowed Recipients"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/update-allowed-recipients","api_endpoint":"https://api.smtp2go.com/v3/allowed_recipients/update"},"summary":"Update allowed recipients","description":"Replace the email addresses and domain names on your Allowed Recipients List using this endpoint. Further details of these modes are found in the SMPT2GO Guides. Note that a post to this endpoint will return a success, even if the setting is not in use.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_recipients":{"type":"array","description":"Array of email addresses and domain names.","required":true,"items":{"type":"string"}},"enabled":{"type":"boolean","description":"A flag indicating if this list should be taken into account when sending","required":true,"enum":[true,false]},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_recipients":["test-person@example.com","other@example.com"],"enabled":true,"subaccount_id":"subaccount_id"}}}}}},"/allowed_senders/update":{"post":{"tags":["Allowed Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/update-allowed-senders","api_endpoint":"https://api.smtp2go.com/v3/allowed_senders/update"},"summary":"Update allowed senders","description":"Replace the email addresses and domain names on your Allowed or Restricted Senders List using this endpoint. How the email addresses and domain names are used is defined in the current 'mode' value - further details of these modes are found in the SMPT2GO Guides. Note that a post to this endpoint will return a success, even if the setting is not in use.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowed_senders":{"type":"array","description":"Array of email addresses and domain names.","required":true,"items":{"type":"string"}},"mode":{"type":"string","description":"A string indicating how the list of email address and domain names is interpreted. and should be one of 'whitelist', 'blacklist' or 'disabled'. Warning: Changing the mode to 'whitelist' or 'blacklist' disables the 'Sender Domains' and 'Single Sender Emails' features.","required":true,"enum":["whitelist","blacklist","disabled"]},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"allowed_senders":["test-person@example.com","other@example.com"],"mode":"whitelist","subaccount_id":"subaccount_id"}}}}}},"/template/edit":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/update-an-email-template","api_endpoint":"https://api.smtp2go.com/v3/template/edit"},"summary":"Update an email template","description":"Changes details of an existing email template.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"html_body":{"type":"string","description":"If provided, will update the email template HTML body"},"id":{"type":"string","description":"The ID of the email template that you wish to change","required":true},"new_id":{"type":"string","description":"If provided, will update the email template ID"},"subject":{"type":"string","description":"If provided, will update the email template subject"},"tags":{"type":"array","description":"If provided, will update the email template tags","items":{"type":"string"}},"template_name":{"type":"string","description":"If provided, will update the email template name"},"template_variables":{"type":"object","description":"The pass-through values required by the template in the format `{\"variable1\": \"value1\", \"variable2\": \"value2\"}` (When template_id is provided)"},"text_body":{"type":"string","description":"If provided, will update the email template Plain Text body"}}},"example":{"html_body":"html_body","id":"id","new_id":"new_id","subject":"subject","tags":["tags"],"template_name":"template_name","template_variables":"template_variables","text_body":"text_body"}}}}}},"/domain/verify":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/verify-a-sender-domain","api_endpoint":"https://api.smtp2go.com/v3/domain/verify"},"summary":"Verify a sender domain","description":"Verify a sender domain on your account removing the need to wait for the periodic verification every 7 minutes.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"Domain to attempt verification for","required":true},"requisition_ssl":{"type":"boolean","description":"If true, requisition an SSL certificate for the tracking domain once verification is complete","enum":[true,false]},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"domain":"domain","requisition_ssl":true,"subaccount_id":"subaccount_id"}}}}}},"/single_sender_emails/view":{"post":{"tags":["Single Sender Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-all-single-sender-emails","api_endpoint":"https://api.smtp2go.com/v3/single_sender_emails/view"},"summary":"View single sender emails","description":"Returns a list of single sender email addresses on your account, along with their verification status. If you include a email_address, the response will only include items matching this search.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_address":{"type":"string","description":"(Optional) If provided, only return email addresses that match value"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"email_address":"email_address","subaccount_id":"subaccount_id"}}}}}},"/allowed_recipients/view":{"post":{"tags":["Allowed Recipients"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-allowed-recipients","api_endpoint":"https://api.smtp2go.com/v3/allowed_recipients/view"},"summary":"View allowed recipients","description":"Returns the email addresses and domain names on your Allowed Recipients list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"subaccount_id":"subaccount_id"}}}}}},"/allowed_senders/view":{"post":{"tags":["Allowed Senders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-allowed-senders","api_endpoint":"https://api.smtp2go.com/v3/allowed_senders/view"},"summary":"View allowed senders","description":"Returns the email addresses and domain names on your Allowed or Restricted Senders list, as well as the Restrict Senders setting, which dictates how they are interpreted.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"subaccount_id":"subaccount_id"}}}}}},"/archive/email":{"post":{"tags":["Email Archive"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-an-archived-email","api_endpoint":"https://api.smtp2go.com/v3/archive/email"},"summary":"View an archived email","description":"Fetch an archived email using the email_id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email_id":{"type":"string","description":"The unique email_id of the archived email you wish to retrieve","required":true}}},"example":{"email_id":"1u0SwL-B9zBpi9ffUq-JAB2"}}}}}},"/api_keys/permissions":{"post":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-api-key-permissions","api_endpoint":"https://api.smtp2go.com/v3/api_keys/permissions"},"summary":"View Permissions","description":"Retrieve a list of endpoints this API Key can use. This endpoint is available to all API Keys.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/api_keys/view":{"post":{"tags":["API KEYS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-api-keys","api_endpoint":"https://api.smtp2go.com/v3/api_keys/view"},"summary":"View API Keys","description":"Retrieve a list of API keys on this account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"A full API key to retrieve the information for."},"search":{"type":"string","description":"A search keyword used to refine the results."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"id":"id","search":"search","subaccount_id":"subaccount_id"}}}}}},"/dedicated_ips/view":{"post":{"tags":["Dedicated IPS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-dedicated-ips","api_endpoint":"https://api.smtp2go.com/v3/dedicated_ips/view"},"summary":"View Dedicated IP Addresses","description":"Retrieve a list of Dedicated IP addresses on this account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/ip_auth/view":{"post":{"tags":["IP AUTH"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-ip-auth","api_endpoint":"https://api.smtp2go.com/v3/ip_auth/view"},"summary":"View IP Auth","description":"Returns a list of all IP Auth entries that are managed by this account, or details of a specific IP Auth, when you include the [ip_address] in your request. If no entries are available, this will return an empty list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ip_address":{"type":"string","description":"If passed, a valid ip address of an existing IP Auth entry that you wish to view"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"ip_address":"ip_address","subaccount_id":"subaccount_id"}}}}}},"/sms/view-received":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-received-sms","api_endpoint":"https://api.smtp2go.com/v3/sms/view-received"},"summary":"View received SMS","description":"View received SMS messages.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to now. Timezone is UTC."},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to 7 days ago at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."},"unix_end":{"type":"number","description":"Deprecated: this is a legacy method of selecting the end of the search period as a unix timestamp. This can be left empty to use the end_date."},"unix_start":{"type":"number","description":"Deprecated: this is a legacy method of selecting the start of the search period as a unix timestamp. This can be left empty to use the start_date."},"username":{"type":"string","description":"If passed will filter the results based on the username information on the message"}}},"example":{"end_date":"end_date","start_date":"start_date","subaccount_id":"subaccount_id","unix_end":"unix_end","unix_start":"unix_start","username":"username"}}}}}},"/domain/view":{"post":{"tags":["Sender Domains"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-sender-domains","api_endpoint":"https://api.smtp2go.com/v3/domain/view"},"summary":"View sender domains","description":"Returns a list of sender domains on your account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"domain":{"type":"string","description":"(Optional) If provided, will only retrieve records for this domain"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"}}},"example":{"domain":"domain","subaccount_id":"subaccount_id"}}}}}},"/email/search":{"post":{"tags":["Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-sent-emails","api_endpoint":"https://api.smtp2go.com/v3/email/search"},"summary":"View and search sent emails","description":"Retrieve a list of up to 5,000 sent emails matching the supplied parameters. The filter_query field can be used to create complex filters to make your searching more efficient. Find full details in the Email and Email Archive Guide. Note: Allow around two minutes after delivery for recently sent emails to be included in a search result. This endpoint is deprecated and will not be accessible in future API versions. Please use the Activity Search endpoint instead. This endpoint is rate-limited to 20 requests per minute.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"clicked_only":{"type":"boolean","description":"If true, will return emails that have had a link clicked by at least one recipient. Note: Only returns information for emails sent from suitable accounts with Click Tracking enabled. See more info at Click Tracking","enum":[true,false]},"continue_token":{"type":"string","description":"If passed, the resulting query will paginate from the previous query"},"email_id":{"type":"array","description":"If passed, will only return emails with an ID contained within this array","items":{"type":"string"}},"end_date":{"type":"string","description":"ISO-8601 formatted datetime. Results will be inclusive of this value. Timezone is UTC. Defaults to current time."},"filter_query":{"type":"string","description":"If passed, will return results filtered by these search parameters. The query format is documented below"},"headers":{"type":"array","description":"If passed, will return the specified email header values","items":{"type":"string"}},"ignore_case":{"type":"boolean","description":"If true, all string searches will be case insensitive","enum":[true,false]},"limit":{"type":"number","description":"The maximum number of emails to return. Enter an integer between 1 and 5,000. Defaults to 5,000."},"opened_only":{"type":"boolean","description":"If true, will return emails that have been opened by at least one recipient. Note: Only returns information for emails sent from suitable accounts with Open Tracking enabled. See more info at Open Tracking","enum":[true,false]},"start_date":{"type":"string","description":"ISO-8601 formatted datetime. Results will be inclusive of this value. Timezone is UTC. Defaults to current date at midnight."},"status_counts":{"type":"boolean","description":"If true, will return an object with counts of each unique email status","enum":[true,false]},"username":{"type":"string","description":"If passed, will only return emails sent by this user"}}},"example":{"clicked_only":"","continue_token":"continue_token","email_id":["email_id"],"end_date":"end_date","filter_query":"null","headers":["[]"],"ignore_case":"","limit":5000,"opened_only":"","start_date":"start_date","status_counts":"","username":"username"}}}}}},"/sms/view-sent":{"post":{"tags":["SMS"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-sent-sms","api_endpoint":"https://api.smtp2go.com/v3/sms/view-sent"},"summary":"View sent SMS","description":"View sent SMS messages.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to now. Timezone is UTC."},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to 7 days ago at midnight. The range will be inclusive of start_date and exclusive of end_date. Timezone is UTC."},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."},"username":{"type":"string","description":"If passed will filter the results based on the username information on the message"}}},"example":{"end_date":"end_date","start_date":"start_date","subaccount_id":"subaccount_id","username":"username"}}}}}},"/users/smtp/view":{"post":{"tags":["SMTP Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-smtp-users","api_endpoint":"https://api.smtp2go.com/v3/users/smtp/view"},"summary":"View SMTP users","description":"Returns a list of all SMTP users that are managed by this account, or details of a specific user, when you include the [username] in your request. If no users are available, this will return an empty list.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"username":{"type":"string","description":"If passed, a valid SMTP2GO username of your existing SMTP User that you wish to view"}}},"example":{"subaccount_id":"subaccount_id","username":"username"}}}}}},"/suppression/view":{"post":{"tags":["Suppressions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-suppressions","api_endpoint":"https://api.smtp2go.com/v3/suppression/view"},"summary":"View suppressions","description":"Returns your suppressed email addresses and domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"continue_token":{"type":"string","description":"If returned from a request this can be passed to continue paging through the result of the results"},"email_address":{"type":"string","description":"If provided, checks if a specific email address or domain is in the block list"},"end_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to 30 days prior to the current date at midnight. Timezone is UTC"},"fuzzy":{"type":"boolean","description":"Indicates if the search should use fuzzy matching on recipients & reasons","enum":[true,false]},"reason":{"type":"string","description":"A reason string to search for"},"reasons":{"type":"array","description":"An array of reason strings to search for","items":{"type":"string"}},"recipient":{"type":"string","description":"A recipient string to search for"},"recipients":{"type":"array","description":"An array of recipient strings to search for","items":{"type":"string"}},"sort":{"type":"string","description":"The direction to sort the results, either asc or desc"},"start_date":{"type":"string","description":"ISO-8601 formatted datetime which defaults to the current date at midnight. Timezone is UTC"},"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here"},"suppression_type":{"type":"string","description":"If passed restricts the search to a single suppression type manual , spam , unsubscribe , bounce or compliance"},"suppression_types":{"type":"array","description":"If passed restricts the search to multiple suppression types manual , spam , unsubscribe , bounce or compliance","items":{"type":"string"}},"wildcard":{"type":"string","description":"If provided, only suppressions with this wildcard string in name, domain, or email address fields, will be returned"}}},"example":{"continue_token":"continue_token","email_address":"email_address","end_date":"end_date","fuzzy":"fuzzy","reason":"reason","reasons":["reasons"],"recipient":"recipient","recipients":["recipients"],"sort":"sort","start_date":"start_date","subaccount_id":"subaccount_id","suppression_type":"suppression_type","suppression_types":["suppression_types"],"wildcard":"wildcard"}}}}}},"/template/view":{"post":{"tags":["Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-template-details","api_endpoint":"https://api.smtp2go.com/v3/template/view"},"summary":"View template details","description":"Returns details of the email template with the specified ID.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"The case-sensitive ID of the email template that you wish to view","required":true}}},"example":{"id":"id"}}}}}},"/webhook/view":{"post":{"tags":["Webhooks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.smtp2go.com/reference/view-webhook","api_endpoint":"https://api.smtp2go.com/v3/webhook/view"},"summary":"View Webhooks","description":"Returns information for configured webhooks.","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"subaccount_id":{"type":"string","description":"If you wish to make this API call on behalf of a subaccount then include its unique ID here."}}},"example":{"subaccount_id":"subaccount_id"}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}