Skip to contentSkip to navigationSkip to topbar
Twilio SendGrid Docs
On this page

Add IPs

API Overview

api-overview page anchor

Elements that can be shared among more than one endpoint definition.

Operation overview

operation-overview page anchor

POST/v3/ips

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

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

This endpoint is for adding a(n) IP Address(es) to your account.

Operation details

operation-details page anchor

Authentication

authentication page anchor

Headers

headers page anchor
Property nameTypeRequiredDescription
authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

request-body page anchor
Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
countinteger
required

The amount of IPs to add to the account.

subusersarray[string]

Optional

Array of usernames to be assigned a send IP.

warmupboolean

Optional

Whether or not to warmup the IPs being added.

Default: false

Responses

responses page anchor
201400
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipsarray[object]

Optional

List of IP objects.

remainingIpsinteger

Optional

The number of IPs that can still be added to the user.

warmupboolean

Optional

Whether or not the IPs are being warmed up.

Add IPsLink to code sample: Add IPs
1
const client = require("@sendgrid/client");

2
client.setApiKey(process.env.SENDGRID_API_KEY);

3


4
const data = {

5
  count: 90323478,

6
  subusers: ["subuser1", "subuser2"],

7
  warmup: true,

8
};

9


10
const request = {

11
  url: `/v3/ips`,

12
  method: "POST",

13
  body: data,

14
};

15


16
client

17
  .request(request)

18
  .then(([response, body]) => {

19
    console.log(response.statusCode);

20
    console.log(response.body);

21
  })

22
  .catch((error) => {

23
    console.error(error);

24
  });