Skip to contentSkip to navigationSkip to topbar
On this page

Add IPs



API Overview

api-overview page anchor

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


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.


Authentication

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

The amount of IPs to add to the account.


subusersarray[string]Optional

Array of usernames to be assigned a send IP.


warmupbooleanOptional

Whether or not to warmup the IPs being added.

Default: false
201400
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipsarray[object]

List of IP objects.


remaining_ipsinteger

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


warmupboolean

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
user_can_send: true,
9
};
10
11
const request = {
12
url: `/v3/ips`,
13
method: "POST",
14
body: data,
15
};
16
17
client
18
.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
});

Need some help?

Terms of service

Copyright © 2024 Twilio Inc.