Skip to contentSkip to navigationSkip to topbar
On this page

Add a Twilio SendGrid IP Address



API Overview

api-overview page anchor

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.

(information)

Info

(warning)

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/ips

Base url: https://api.sendgrid.com (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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.


Authentication

authentication page anchor
Property nameTypeRequiredDescription
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
is_auto_warmupbooleanrequired

Indicates if the IP address is set to automatically warmup.


is_parent_assignedbooleanrequired

Indicates if a parent on the account is able to send email from the IP address.


subusersarray[string]Optional

An array of Subuser IDs the IP address will be assigned to.


regionenum<string>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.

Default: usPossible values:
euus

include_regionbooleanOptional

Boolean indicating whether or not to return the IP address's region information in the response.

Default: false
201400401500

Created

SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipstring

The IP address that was added to your account.


is_auto_warmupboolean

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.


is_parent_assignedboolean

Indicates if a parent on the account is able to send email from the IP address.


subusersarray[string]

An array of Subuser IDs the IP address was assigned to.


regionenum<string>

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.

Possible values:
euus
Add a Twilio SendGrid IP AddressLink to code sample: Add a Twilio SendGrid IP Address
1
const client = require('@sendgrid/client');
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const data = {
5
"is_auto_warmup": true,
6
"is_parent_assigned": true,
7
"subusers": [
8
"12345"
9
]
10
};
11
12
const request = {
13
url: `/v3/send_ips/ips`,
14
method: 'POST',
15
body: data
16
}
17
18
client.request(request)
19
.then(([response, body]) => {
20
console.log(response.statusCode);
21
console.log(response.body);
22
})
23
.catch(error => {
24
console.error(error);
25
});