Menu

Expand
Rate this page:

IP Address Management API

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.

Create an IP Pool with a Name and IP Assignments

The IP Address Management API is in 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

Base url: https://api.sendgrid.com

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.

Request Body

object
name
string

The name to assign to the IP Pool. An IP Pool name cannot begin with a space or period.

required
ips
array[string]

An array of IP addresses to assign to the IP Pool. All assignments must succeed.

maxItems: 100

Responses

object
name
string

The name assigned to the IP Pool.

id
string

The unique ID of the IP Pool.

ips
array[string]

An array of IP addresses assigned to the IP Pool. All assignments must succeed.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

object

IP Address Management Error Response Schema

errors
array[object]

An array of error objects.

field
string

Indicates which field caused the error. This may be an empty string if no specific field is responsible for the error.

message
string

An error-specific message that provides more information about the error's cause.

        
        
        
        Rate this page:

        Need some help?

        We all do sometimes. Get help now from the Twilio SendGrid Support Team.

        Running into a coding hurdle? Lean on the wisdom of the crowd by browsing the SendGrid tag on Stack Overflow or visiting Twilio's Stack Overflow Collective.

              
              
              

              Thank you for your feedback!

              Please select the reason(s) for your feedback. The additional information you provide helps us improve our documentation:

              Sending your feedback...
              🎉 Thank you for your feedback!
              Something went wrong. Please try again.

              Thanks for your feedback!

              thanks-feedback-gif