Skip to content Skip to navigation Skip to topbar

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

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

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

Node.js

Python

Java

PHP

Ruby

curl


_27const client = require('@sendgrid/client');
_27client.setApiKey(process.env.SENDGRID_API_KEY);
_27
_27const data = {
_27  "count": 90323478,
_27  "subusers": [
_27    "subuser1",
_27    "subuser2"
_27  ],
_27  "warmup": true,
_27  "user_can_send": true
_27};
_27
_27const request = {
_27  url: `/v3/ips`,
_27  method: 'POST',
_27  body: data
_27}
_27
_27client.request(request)
_27  .then(([response, body]) => {
_27    console.log(response.statusCode);
_27    console.log(response.body);
_27  })
_27  .catch(error => {
_27    console.error(error);
_27  });