On this page

Add IPs

API Overview

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

Operation overview

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

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Request body

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

Responses

201400

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ipsarray[object]

List of IP objects.

Show child properties for ips

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 IPs

1const client = require('@sendgrid/client');
2client.setApiKey(process.env.SENDGRID_API_KEY);
3
4const data = {
5  "count": 90323478,
6  "subusers": [
7    "subuser1",
8    "subuser2"
9  ],
10  "warmup": true,
11  "user_can_send": true
12};
13
14const request = {
15  url: `/v3/ips`,
16  method: 'POST',
17  body: data
18}
19
20client.request(request)
21  .then(([response, body]) => {
22    console.log(response.statusCode);
23    console.log(response.body);
24  })
25  .catch(error => {
26    console.error(error);
27  });