---
title: "Patch an IP Auth"
method: PATCH
path: "/ip_auth/edit"
tags: ["IP AUTH"]
---

# Patch an IP Auth

`PATCH /ip_auth/edit`

Patch an existing IP Auth ignoring missing properties

## Request body

- object
  - `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 <code>custom_ratelimit_value</code> and <code>custom_ratelimit_period</code>.
  - `custom_ratelimit_value` integer — If passed, defines the limit of emails this user can send in the period specified in <code>custom_ratelimit_period</code>.<br><br><strong>Note:</strong> Only stores this value if <code>custom_ratelimit</code> 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 <code>custom_ratelimit_value</code>.<br><br><strong>Syntax:</strong> "\<n\> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".<br><br><strong>Examples: </strong> "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".<br><br><strong>Note:</strong> Only stores this value if <code>custom_ratelimit</code> 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 <code>/v3/dedicated_ips/view</code> endpoint.
  - `feedback_enabled` boolean — If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.
  - `feedback_html` string — The HTML content to insert into the custom feedback email body via the unsubscribe footer.<br><br><strong>System Variables (Only available here):</strong><ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>
  - `feedback_text` string — The text content to insert into the custom feedback email body via the unsubscribe footer.<br><br><strong>System Variables (Only available here):</strong><ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>
  - `open_tracking_enabled` boolean — If true, open tracking will be enabled for this IP Auth user.
  - `click_tracking_enabled` boolean — If true, click tracking will be enabled for this IP Auth.
  - `archive_enabled` boolean — 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 — 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 — 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.

## Response `200`

Successfully patched IP Auth

- object
  - `data` object[], required — An array of IP Auth results
    - `request_id` string, required
    - `data` object, required
      - `ip_address` string — The IP address of the IP Auth
      - `description` string — A comment or description of the IP Auth.
      - `custom_rate_limit` boolean — If enabled will use the values of <code>custom_ratelimit_value</code> and <code>custom_ratelimit_period</code> for rate limiting.
      - `custom_ratelimit_value` integer — If passed, defines the limit of emails this IP Auth can send in the period specified in <code>custom_ratelimit_period</code>.
      - `custom_ratelimit_period` string — If passed, defines the period for which this user will be limited to the number of emails specified in <code>custom_ratelimit_value</code>.<br><br><strong>Syntax:</strong> "\<n\> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".<br><br><strong>Examples: </strong> "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".<br><br><strong>Note:</strong> Only stores this value if <code>custom_ratelimit</code> is true.
      - `default_ratelimit_value` string — The default limit of emails this IP Auth can send in the period specified in <code>default_ratelimit_period</code>. <strong>Note:</strong> Used if <code>custom_ratelimit</code> is false.
      - `default_ratelimit_period` string — The default period for which this IP Auth will be limited to the number of emails specified in <code>default_ratelimit_value</code>.<br><br><strong>Syntax:</strong> "\<n\> [hour[s]|day[s]|week[s]|month[s]] [hh:mm:ss]".<br><br><strong>Examples: </strong> "0:30:00", "1 hour", "2 days", "3 months", "4 months 5:00:00".<br><br><strong>Note:</strong> Used if <code>custom_ratelimit</code> is false.
      - `ippool` integer
      - `feedback_enabled` boolean — If true, custom feedback via the unsubscribe footer will be enabled and defined by the below settings.
      - `feedback_html` string — The HTML content to insert into the custom feedback email body via the unsubscribe footer. Default: blank <br><br><strong>System Variables (Only available here):</strong><ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>
      - `feedback_text` string — The text content to insert into the custom feedback email body via the unsubscribe footer. Default: blank<br><br><strong>System Variables (Only available here):</strong><ul><li>Unsubscribe URL = %%UNSUBSCRIBE%% </li><li>Email address = %%EMAIL%%</li></ul>
      - `open_tracking_enabled` boolean — If true, open tracking will be enabled for this IP Auth.
      - `click_tracking_enabled` boolean — If true, click tracking will be enabled for this IP Auth.
      - `archive_enabled` boolean — 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 — 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 — The initial status of the IP Auth, one of ['allowed', 'blocked', 'sandbox'].
  - `request_id` string, required

## Other responses

- `400` — 400

---

[API](https://skmtc.net/smtp2go/apis/smtp2go-api-v3-0-4.md) · [All operations](https://skmtc.net/smtp2go/apis/smtp2go-api-v3-0-4/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/smtp2go/smtp2go-api-v3-0-4/versions/1ba6b25eebb9/schema)