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.
Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More
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.
This operation adds a Twilio SendGrid IP address to your account. You can also assign up to 100 Subusers to the IP address at creation.
Bearer <<YOUR_API_KEY_HERE>>application/jsonIndicates if a parent on the account is able to send email from the IP address.
Optional
An array of Subuser IDs the IP address will be assigned to.
100Optional
The region to which the IP address is assigned. This property will only be returned if the include_region query parameter is included and set to true as part of the API request.
usPossible values: euusOptional
Boolean indicating whether or not to return the IP address's region information in the response.
falseCreated
Optional
The IP address that was added to your account.
Optional
Indicates if the IP address is set to automatically warmup. This parameter is returned only if the IP address is set to automatically warm up.
Optional
Indicates if a parent on the account is able to send email from the IP address.
Optional
An array of Subuser IDs the IP address was assigned to.
Optional
The region to which the IP address is assigned. This property will only be returned if the include_region query parameter is included and set to true as part of the API request.
euus1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5is_auto_warmup: true,6is_parent_assigned: true,7subusers: ["12345"],8};910const request = {11url: `/v3/send_ips/ips`,12method: "POST",13body: data,14};1516client17.request(request)18.then(([response, body]) => {19console.log(response.statusCode);20console.log(response.body);21})22.catch((error) => {23console.error(error);24});