On this page

Update IPs assigned to a subuser

API Overview

For more information about Subusers, visit the longform Subusers documentation. You can also manage Subusers in the SendGrid console.

Operation overview

PUT/v3/subusers/{subuser_name}/ips

Base url: https://api.sendgrid.com (for global users and subusers)

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

This endpoint allows you update your subusers' assigned IP.

Each subuser should be assigned to an IP address from which all of this subuser's mail will be sent. Often, this is the same IP as the parent account, but each subuser can have one or more of their own IP addresses as well.

More information:

Operation details

Authentication

API Key

Headers

Property nameTypeRequiredDescription

authorizationstring

required

Default: Bearer <<YOUR_API_KEY_HERE>>

Path parameters

Property nameTypeRequiredDescription

subuserNamestring

required

The username of the Subuser.

Request body

Encoding type:application/json

SchemaExample

array[string<ipv4>]

The IP addresses you would like to assign to the subuser.

Responses

200401

SchemaExample

Property nameTypeRequiredDescriptionChild properties

ipsarray[string<ipv4>]

Optional

The IP addresses that are assigned to the subuser.

Update IPs assigned to a subuser

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