Add a Batch of IPs to an IP Pool
The IP Address Management API combines functionality that was previously split between the Twilio SendGrid IP Address API and IP Pools API. 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.
Info
Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More
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.
POST/v3/send_ips/pools/{poolid}/ips:batchAdd
Base url: https://api.sendgrid.com (for global users and subusers)
Base url: https://api.eu.sendgrid.com (for EU regional subusers)
This operation appends a batch of IPs to an IP Pool. This operation requires all IP assignments to succeed. If any IP assignments fail, this endpoint will return an error.
Bearer <<YOUR_API_KEY_HERE>>Specifies the unique ID for an IP Pool.
application/jsonAn array of IP addresses to assign to the specified IP Pool. All assignments must succeed.
OK
Optional
The name of the IP Pool.
Optional
The unique ID of the IP Pool.
Optional
An array of IP addresses assigned to the IP Pool.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const poolid = "poolid";5const data = {6ips: ["127.0.0.1", "127.0.0.2", "127.0.0.3", "127.0.0.4"],7};89const request = {10url: `/v3/send_ips/pools/${poolid}/ips:batchAdd`,11method: "POST",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});
