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 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.
Bearer <<YOUR_API_KEY_HERE>>
The ip
path parameter specifies an IP address to make the request against.
application/json
Optional
Indicates if a parent on the account is able to send email from the IP address.
Optional
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.
OK
The IP address that was updated.
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.
An array of Subuser IDs the IP address was assigned to. This parameter is returned only if the IP address is enabled.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const ip = "ZGkrHSypTsudrGkmdpJJ";5const data = {6is_auto_warmup: true,7is_parent_assigned: true,8is_enabled: true,9};1011const request = {12url: `/v3/send_ips/ips/${ip}`,13method: "PATCH",14body: data,15};1617client18.request(request)19.then(([response, body]) => {20console.log(response.statusCode);21console.log(response.body);22})23.catch((error) => {24console.error(error);25});