# Create an IP Pool with a Name and IP Assignments ## 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/pools","method":"post","servers":[{"url":"https://api.sendgrid.com","description":"for global users and subusers"},{"url":"https://api.eu.sendgrid.com","description":"for EU regional subusers"}]} ``` This operation will create a named IP Pool and associate specified IP addresses with the newly created Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error and the Pool will not be created. Each IP Pool may have a maximum of 100 assigned IP addresses. ## Operation details ### Authentication API Key ### Headers ```json [{"in":"header","name":"Authorization","required":true,"default":"Bearer <>","schema":{"type":"string"}}] ``` ### Request body ```json {"schema":{"type":"object","required":["name"],"properties":{"name":{"type":"string","description":"The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period."},"ips":{"type":"array","description":"An array of IP addresses to assign to the IP Pool. All assignments must succeed.","maxItems":100,"items":{"type":"string"}}}},"examples":{"example-1":{"value":{"name":"transactional_pool","ips":["127.0.0.1","127.0.0.2"]}}},"encodingType":"application/json"} ``` ### Responses ```json [{"responseCode":"201","schema":{"description":"Created","content":{"application/json":{"schema":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the IP Pool."},"id":{"type":"string","description":"The unique ID of the IP Pool."},"ips":{"type":"array","description":"An array of IP addresses assigned to the IP Pool. All assignments must succeed.","items":{"type":"string"}}}},"examples":{"201":{"value":{"name":"transactional_pool","id":"12345","ips":["127.0.0.1","127.0.0.2"]}}}}}}},{"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":{"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"},"name not found":{"value":{"errors":[{"field":"name","message":"not found in the request body"}]},"refName":"#/components/examples/IpAddressManagement400NameMissingError","modelName":"__components_examples_IpAddressManagement400NameMissingError"},"name begins with dot or space":{"value":{"errors":[{"field":"name","message":"cannot start with a dot or a space"}]},"refName":"#/components/examples/IpAddressManagement400NameDotSpaceError","modelName":"__components_examples_IpAddressManagement400NameDotSpaceError"},"name invalid length":{"value":{"errors":[{"field":"name","message":"needs to be between 2 to 64 characters long"}]},"refName":"#/components/examples/IpAddressManagement400NameLengthError","modelName":"__components_examples_IpAddressManagement400NameLengthError"},"name already exists":{"value":{"errors":[{"field":"name","message":"already exists"}]},"refName":"#/components/examples/IpAddressManagement400NameExistsError","modelName":"__components_examples_IpAddressManagement400NameExistsError"},"pool limit reached":{"value":{"errors":[{"field":"","message":"100 pools limit has been reached"}]},"refName":"#/components/examples/IpAddressManagement400PoolLimitError","modelName":"__components_examples_IpAddressManagement400PoolLimitError"}}}}}},{"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"}}] ``` Create an IP Pool with a Name and IP Assignments ```js const client = require("@sendgrid/client"); client.setApiKey(process.env.SENDGRID_API_KEY); const data = { name: "transactional_pool", ips: ["127.0.0.1", "127.0.0.2"], }; const request = { url: `/v3/send_ips/pools`, method: "POST", 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")) data = {"name": "transactional_pool", "ips": ["127.0.0.1", "127.0.0.2"]} response = sg.client.send_ips.pools.post(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 data = @"{ ""name"": ""transactional_pool"", ""ips"": [ ""127.0.0.1"", ""127.0.0.2"" ] }"; var response = await client.RequestAsync( method: SendGridClient.Method.POST, urlPath: "send_ips/pools", 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; import java.util.Arrays; 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.POST); request.setEndpoint("/send_ips/pools"); request.setBody(new JSONObject(new HashMap() { { put("name", "transactional_pool"); put("ips", Arrays.asList("127.0.0.1", "127.0.0.2")); } }).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/pools", host) request.Method = "POST" request.Body = []byte(`{ "name": "transactional_pool", "ips": [ "127.0.0.1", "127.0.0.2" ] }`) 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('{ "name": "transactional_pool", "ips": [ "127.0.0.1", "127.0.0.2" ] }'); try { $response = $sg->client ->send_ips() ->pools() ->post($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('{ "name": "transactional_pool", "ips": [ "127.0.0.1", "127.0.0.2" ] }') response = sg.client.send_ips.pools.post(request_body: data) puts response.status_code puts response.headers puts response.body ``` ```bash curl -X POST "https://api.sendgrid.com/v3/send_ips/pools" \ --header "Authorization: Bearer $SENDGRID_API_KEY" \ --header "Content-Type: application/json" \ --data '{"name": "transactional_pool", "ips": ["127.0.0.1", "127.0.0.2"]}' ```