Delete a Batch of Subusers from an IP



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.

(information)
(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 (for global users and subusers)

Base url: https://api.eu.sendgrid.com (for EU regional subusers)

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


Property nameTypeRequiredDescription
Authorizationstring
required
Default: Bearer <<YOUR_API_KEY_HERE>>
Property nameTypeRequiredDescription
ipstring
required

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

Encoding type:application/json
SchemaExample
Property nameTypeRequiredDescriptionChild properties
subusersarray[string]
required

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

204400401500

No Content

1
const client = require("@sendgrid/client");
2
client.setApiKey(process.env.SENDGRID_API_KEY);
3
4
const ip = "ip";
5
const data = {
6
subusers: ["12345", "67890"],
7
};
8
9
const request = {
10
url: `/v3/send_ips/ips/${ip}/subusers:batchDelete`,
11
method: "POST",
12
body: data,
13
};
14
15
client
16
.request(request)
17
.then(([response, body]) => {
18
console.log(response.statusCode);
19
console.log(response.body);
20
})
21
.catch((error) => {
22
console.error(error);
23
});