Skip to contentSkip to navigationSkip to topbar
Rate this page:
On this page

Delete a Batch of Subusers from an IP



API Overview

api-overview page anchor

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.


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

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

This operation removes a batch of Subusers from a specified IP address.


Authentication

authentication page anchor
Authorizationstringrequired
Default: Bearer <<YOUR_API_KEY_HERE>>
ipstringrequired

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

SchemaExample
subusersarray[string]required

An array of Subuser IDs to be removed from the specified IP address.

204400401500

No Content

Delete a Batch of Subusers from an IP

delete-a-batch-of-subusers-from-an-ip page anchor
Node.js
Python
C#
Java
Go
PHP
Ruby
curl

_25
const client = require('@sendgrid/client');
_25
client.setApiKey(process.env.SENDGRID_API_KEY);
_25
_25
const ip = "ZGkrHSypTsudrGkmdpJJ";
_25
const data = {
_25
"subusers": [
_25
"12345",
_25
"67890"
_25
]
_25
};
_25
_25
const request = {
_25
url: `/v3/send_ips/ips/${ip}/subusers:batchDelete`,
_25
method: 'POST',
_25
body: data
_25
}
_25
_25
client.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
});


Rate this page: