Skip to content Skip to navigation Skip to topbar

Assign a Batch of Subusers to an IP

API Overview

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.

(warning)

Warning

The IP Address Management API is in public beta at this time. This means the API and documentation are still in development and subject to change without advanced notice.

Operation overview

POST/v3/send_ips/ips/{ip}/subusers:batchAdd

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

This operation appends a batch of Subusers to a specified IP address. This endpoint requires all Subuser assignments to succeed. If a Subuser assignment fails, this endpoint will return an error.

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

Authorizationstringrequired

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

ipstringrequired

The ip path parameter specifies an IP address to make the request against.

Request body

SchemaExample

Property nameTypeRequiredDescriptionChild properties

subusersarray[string]required

An array of Subuser IDs to be assigned to the specified IP address. All Subuser assignments must succeed.

Responses

200400401500

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ipstring

The IP address the Subusers were assigned to.

subusersarray[string]

An array of Subuser IDs that were assigned to the specified IP address.

Bad Request

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Unauthorized

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Internal Server Error

SchemaExample

Property nameTypeRequiredDescriptionChild properties

errorsarray[object]

An array of error objects.

Show child properties for errors

Assign a Batch of Subusers to an IP

Node.js

Python

Java

PHP

Ruby

curl


_25const client = require('@sendgrid/client');
_25client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25const ip = "ZGkrHSypTsudrGkmdpJJ";
_25const data = {
_25  "subusers": [
_25    "12345",
_25    "67890"
_25  ]
_25};
_25
_25const request = {
_25  url: `/v3/send_ips/ips/${ip}/subusers:batchAdd`,
_25  method: 'POST',
_25  body: data
_25}
_25
_25client.request(request)
_25  .then(([response, body]) => {
_25    console.log(response.statusCode);
_25    console.log(response.body);
_25  })
_25  .catch(error => {
_25    console.error(error);
_25  });