Assign a Batch of Subusers to 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.
Info
Regional Email sending in the European Union (EU) is GA for Twilio SendGrid Pro plan or above. Learn More
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:batchAdd
Base url: https://api.sendgrid.com (for global users and subusers)
Base url: https://api.eu.sendgrid.com (for EU regional subusers)
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.
Bearer <<YOUR_API_KEY_HERE>>The ip path parameter specifies an IP address to make the request against.
application/jsonAn array of Subuser IDs to be assigned to the specified IP address. All Subuser assignments must succeed.
OK
Optional
The IP address the Subusers were assigned to.
Optional
An array of Subuser IDs that were assigned to the specified IP address.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const ip = "ip";5const data = {6subusers: ["12345", "67890"],7};89const request = {10url: `/v3/send_ips/ips/${ip}/subusers:batchAdd`,11method: "POST",12body: data,13};1415client16.request(request)17.then(([response, body]) => {18console.log(response.statusCode);19console.log(response.body);20})21.catch((error) => {22console.error(error);23});
