Edit SMTP user details

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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

A valid username of your existing SMTP User that you wish to edit

string

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.

string

A comment or description of your new SMTP User

boolean
Defaults to false

If true, a custom rate limit will be enabled for this user, and defined by the custom_ratelimit_value and custom_ratelimit_period.

int32

If passed, defines the maximum number of emails this user can send in the custom_ratelimit_period. Values: 1 to 2147483647

string

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"

integer

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.

boolean

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

string

The domain to insert into the custom feedback links via the unsubscribe footer

string

The HTML content to insert into the custom feedback email body via the unsubscribe footer

string

The text content to insert into the custom feedback email body via the unsubscribe footer

boolean

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

boolean

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

boolean

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

string

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

string

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

string

If passed will set the status of the SMTP user, one of ['allowed', 'blocked', 'sandbox']

string

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

Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json