v1

latestOpenAPI 3.1.02026-07-24700259.3 KB

SMTP USERS

Add an SMTP user

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.

post/users/smtp/add

Request body

usernamestring required

A username to access the SMTP2GO service via SMTP. Length = 5 to 100

email_passwordstring

A valid password for your new SMTP User. Must have an entropy of at least 64 bits. <a target='_blank' href='https://www.calculator.net/password-generator.html'>Consider using a password generator</a> or leave blank for an auto generated value. Ideally contain at least: 12 characters, 1 digit, symbol, uppercase letter, and lowercase letter.

descriptionstring

A comment or description of your new SMTP User

custom_ratelimitboolean

If true, a custom rate limit will be enabled for this user, and defined by the <code>custom_ratelimit_value</code> and <code>custom_ratelimit_period</code>. Default: false

custom_ratelimit_valueinteger

If passed, defines the limit of emails this user can send in the period specified in <code>custom_ratelimit_period</code>. Note: Only stores this value if <code>custom_ratelimit</code> is true.

custom_ratelimit_periodstring

If passed, defines the period for which this user will be limited to the number of emails specified in <code>custom_ratelimit_value</code>. Syntax: "<n> [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 <code>custom_ratelimit</code> is true.

ip_poolinteger

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 <code>/v3/dedicated_ips/view</code> endpoint.

feedback_enabledboolean

If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings. Default: false

feedback_domainstring

The domain to insert into the custom feedback links via the unsubscribe footer. Default: blank Warning: <ul> <li>In order to use the SMTP2go feedback handling feature, this parameter needs to be set to "default"</li><li>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"</li><ul>

feedback_htmlstring

The HTML content to insert into the custom feedback email body via the unsubscribe footer. Default: blank System Variables (Only available here):<ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>

feedback_textstring

The text content to insert into the custom feedback email body via the unsubscribe footer. Default: blank System Variables (Only available here):<ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>

open_tracking_enabledboolean

If true, open tracking will be enabled for this user. Default: false

click_tracking_enabledboolean

If true, click tracking will be enabled for this user. Default: false

archive_enabledboolean

If true, archiving (available on paid plans) will be enabled for this user. Default: false.

audit_emailstring

If passed, this email will be BCC'd on all emails sent by this SMTP User

bounce_notificationsstring

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].

statusstring

The initial status of the SMTP user, one of ['allowed', 'blocked', 'sandbox'], defaults to 'allowed'

subaccount_idstring

If you wish to make this API call on behalf of a subaccount then include its unique ID here

Example request

{
  "ip_pool": 1234
}

Response

SMTP User added

request_idstring required

Example response

{
  "request_id": "aa253464-0bd0-467a-b24b-6159dcd7be60",
  "data": {
    "results": [
      {
        "comments": "Comment explaining how amazing this Test person is",
        "username": "smtpuser@example.com",
        "email_password": "H#8dkK2djs",
        "sending_allowed": true,
        "custom_ratelimit": true,
        "custom_ratelimit_value": 100,
        "custom_ratelimit_period": "1 day",
        "default_ratelimit_period": "unlimited",
        "ippool": 1234,
        "feedback_enabled": true,
        "feedback_domain": "default",
        "archive_enabled": true,
        "open_tracking_enabled": true,
        "bounce_notifications": "from"
      }
    ]
  }
}