# Update Details for an IP Address ## API Overview The IP Address Management API combines functionality that was previously split between the Twilio SendGrid [IP Address API](/docs/sendgrid/api-reference/ip-address) and [IP Pools API](/docs/sendgrid/api-reference/ip-pools). This functionality includes adding IP addresses to your account, assigning IP addresses to IP Pools and Subusers, among other tasks. More details about each operation can be found in the descriptions and schemas for each endpoint. > \[!NOTE] > > Regional Email sending in the European Union (EU) is available for [Twilio SendGrid Pro plan or above](https://sendgrid.com/en-us/pricing). EU Regional Email sending requires use of an EU IP address and EU subuser. Learn more about [sending emails with Twilio SendGrid on EU servers](https://www.twilio.com/en-us/blog/send-emails-in-eu). > \[!WARNING] > > The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice. ## Operation overview ```json {"path":"https://api.sendgrid.com/v3/send_ips/ips/{ip}","method":"patch","servers":[{"url":"https://api.sendgrid.com","description":"for global users"}]} ``` This operation updates an IP address's settings, including whether the IP is set to warm up automatically, if the IP is assigned by a parent account, and whether the IP is enabled or disabled. The request body must include at least one of the `is_auto_warmup`, `is_parent_assigned`, or `is_enabled` fields. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}}] ``` ### Path parameters ```json [{"name":"ip","in":"path","schema":{"type":"string"},"description":"The `ip` path parameter specifies an IP address to make the request against.","required":true,"refName":"#/components/parameters/IpAddressManagementPathIp","modelName":"__components_parameters_IpAddressManagementPathIp"}] ``` ### Request body ```json {"schema":{"type":"object","properties":{"is_auto_warmup":{"type":"boolean","description":"Indicates if the IP address is set to automatically [warmup](/docs/sendgrid/ui/sending-email/warming-up-an-ip-address)."},"is_parent_assigned":{"type":"boolean","description":"Indicates if a parent on the account is able to send email from the IP address."},"is_enabled":{"type":"boolean","description":"Indicates if the IP address is billed and able to send email. This parameter applies to non-Twilio SendGrid APIs that been added to your Twilio SendGrid account. This parameter's value is `null` for Twilio SendGrid IP addresses."}}},"examples":{"example-1":{"value":{"is_auto_warmup":true,"is_parent_assigned":true,"is_enabled":true}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"200","schema":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"ip":{"type":"string","description":"The IP address that was updated."},"is_auto_warmup":{"type":"boolean","description":"Indicates if the IP address is set to automatically [warmup](/docs/sendgrid/ui/sending-email/warming-up-an-ip-address)."},"is_parent_assigned":{"type":"boolean","description":"Indicates if a parent on the account is able to send email from the IP address. This parameter is returned only if the IP address is parent assigned."},"is_enabled":{"type":"boolean","description":"An array of Subuser IDs the IP address was assigned to. This parameter is returned only if the IP address is enabled."}}},"examples":{"200":{"value":{"ip":"127.0.0.1","is_auto_warmup":true,"is_parent_assigned":true,"is_enabled":true}}}}}}},{"responseCode":"400","schema":{"description":"Bad Request","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"invalid ip address":{"value":{"errors":[{"field":"ip","message":"invalid IP address"}]},"refName":"#/components/examples/IpAddressManagement400IpInvalidError","modelName":"__components_examples_IpAddressManagement400IpInvalidError"},"ip unverified ownership":{"value":{"errors":[{"field":"ip","message":"unable to verify IP ownership"}]},"refName":"#/components/examples/IpAddressManagement400IpOwnershipError","modelName":"__components_examples_IpAddressManagement400IpOwnershipError"},"JSON parse error":{"value":{"errors":[{"field":"","message":"failed to parse the request body as a JSON payload"}]},"refName":"#/components/examples/IpAddressManagement400JsonParseError","modelName":"__components_examples_IpAddressManagement400JsonParseError"},"missing required field":{"value":{"errors":[{"field":"","message":"at least one of the following is required: is_enabled, is_auto_warmup, is_parent_assigned"}]},"refName":"#/components/examples/IpAddressManagement400MissingRequiredFieldError","modelName":"__components_examples_IpAddressManagement400MissingRequiredFieldError"}}}}}},{"responseCode":"401","schema":{"description":"Unauthorized","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","x-examples":{"example-1":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}},"refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"Missing required scope":{"value":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}}}},"application/xml":{"schema":{"type":"object","properties":{"errors":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"message":{"type":"string"}}}}},"x-examples":{"example-1":{"errors":[{"field":"","message":"missing required scope: scope1, scope2"}]}}}}},"refName":"#/components/responses/IpAddressManagement401","modelName":"__components_responses_IpAddressManagement401"}},{"responseCode":"500","schema":{"description":"Internal Server Error","content":{"application/json":{"schema":{"type":"object","example-1":{"errors":[{"field":"after_key","message":"must be a numeric value"}]},"description":"IP Address Management Error Response Schema","x-examples":{"example-1":{"errors":[{"field":"","message":"internal server error"}]}},"refName":"IpAddressManagementErrorResponse","modelName":"IpAddressManagementErrorResponse","properties":{"errors":{"type":"array","description":"An array of error objects.","items":{"type":"object","properties":{"field":{"type":"string","description":"Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error."},"message":{"type":"string","description":"An error-specific message that provides more information about the error's cause."}}}}}},"examples":{"Generic 500":{"value":{"errors":[{"field":"","message":"internal server error"}]}}}}},"refName":"#/components/responses/IpAddressManagement500","modelName":"__components_responses_IpAddressManagement500"}}] ``` Update Details for an IP Address ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const ip = "ip"; const data = { is_auto_warmup: true, is_parent_assigned: true, is_enabled: true, }; const request = { url: `/v3/send_ips/ips/${ip}`, method: "PATCH", body: data, }; client .request(request) .then(([response, body]) => { console.log(response.statusCode); console.log(response.body); }) .catch((error) => { console.error(error); }); ``` ```python import os from sendgrid import SendGridAPIClient sg = SendGridAPIClient(os.environ.get("SENDGRID_API_KEY")) ip = "ip" data = {"is_auto_warmup": True, "is_parent_assigned": True, "is_enabled": True} response = sg.client.send_ips.ips._(ip).patch(request_body=data) print(response.status_code) print(response.body) print(response.headers) ``` ```csharp using System; using System.Collections.Generic; using System.Threading.Tasks; using SendGrid; public class Program { public static async Task Main() { string apiKey = Environment.GetEnvironmentVariable("SENDGRID_API_KEY"); var client = new SendGridClient(apiKey); var ip = "ip"; var data = @"{ ""is_auto_warmup"": true, ""is_parent_assigned"": true, ""is_enabled"": true }"; var response = await client.RequestAsync( method: SendGridClient.Method.PATCH, urlPath: $"send_ips/ips/{ip}", requestBody: data); Console.WriteLine(response.StatusCode); Console.WriteLine(response.Body.ReadAsStringAsync().Result); Console.WriteLine(response.Headers.ToString()); } } ``` ```java import com.sendgrid.*; import java.io.IOException; import org.json.JSONObject; import java.util.HashMap; public class Example { public static void main(String[] args) throws IOException { try { SendGrid sg = new SendGrid(System.getenv("SENDGRID_API_KEY")); Request request = new Request(); request.setMethod(Method.PATCH); request.setEndpoint("/send_ips/ips/ip"); request.setBody(new JSONObject(new HashMap() { { put("is_auto_warmup", true); put("is_parent_assigned", true); put("is_enabled", true); } }).toString()); Response response = sg.api(request); System.out.println(response.getStatusCode()); System.out.println(response.getBody()); System.out.println(response.getHeaders()); } catch (IOException ex) { throw ex; } } } ``` ```go package main import ( "fmt" "github.com/sendgrid/sendgrid-go" "os" ) func main() { apiKey := os.Getenv("SENDGRID_API_KEY") host := "https://api.sendgrid.com" request := sendgrid.GetRequest(apiKey, "/v3/send_ips/ips/ip", host) request.Method = "PATCH" request.Body = []byte(`{ "is_auto_warmup": true, "is_parent_assigned": true, "is_enabled": true }`) response, err := sendgrid.API(request) if err != nil { fmt.Println(err.Error()) os.Exit(1) } else { fmt.Println(response.StatusCode) fmt.Println(response.Body) fmt.Println(response.Headers) } } ``` ```php /sendgrid-php.php'; $apiKey = getenv("SENDGRID_API_KEY"); $sg = new \SendGrid($apiKey); $request_body = json_decode('{ "is_auto_warmup": true, "is_parent_assigned": true, "is_enabled": true }'); $ip = "ip"; try { $response = $sg->client ->send_ips() ->ips() ->_($ip) ->patch($request_body); print $response->statusCode() . "\n"; print_r($response->headers()); print $response->body() . "\n"; } catch (Exception $ex) { echo "Caught exception: " . $ex->getMessage(); } ``` ```ruby require 'sendgrid-ruby' include SendGrid sg = SendGrid::API.new(api_key: ENV['SENDGRID_API_KEY']) data = JSON.parse('{ "is_auto_warmup": true, "is_parent_assigned": true, "is_enabled": true }') ip = "ip" response = sg.client.send_ips.ips._(ip).patch(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X PATCH "https://api.sendgrid.com/v3/send_ips/ips/ip" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"is_auto_warmup": true, "is_parent_assigned": true, "is_enabled": true}' ```