Patch an IP Auth

patch

https://api.smtp2go.com/v3/ip_auth/edit

Patch an existing IP Auth ignoring missing properties

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

ip_address

string

required

A valid IP address of your existing IP Auth that you wish to edit

description

string

A comment or description of the IP Auth

custom_ratelimit

boolean

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

custom_ratelimit_value

integer

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.

custom_ratelimit_period

string

If passed, defines the period for which this user will be limited to the number of emails specified in custom_ratelimit_value.

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 custom_ratelimit is true.

ip_pool

integer

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.

feedback_enabled

boolean

Defaults to null

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

feedback_html

string

Defaults to null

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

string

Defaults to null

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%%

open_tracking_enabled

boolean

Defaults to null

If true, open tracking will be enabled for this IP Auth user.

click_tracking_enabled

boolean

Defaults to null

If true, click tracking will be enabled for this IP Auth.

archive_enabled

boolean

Defaults to null

If true, archiving (available on paid plans) will be enabled for this IP Auth.

audit_email

string

If passed, this email will be BCC'd on all emails sent by this IP Auth.

bounce_notifications

string

Defaults to null

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.

status

string

Defaults to null

The initial status of the IP Auth user, one of ['allowed', 'blocked', 'sandbox'].

subaccount_id

string

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

Responses

200Successfully patched IP Auth

400400