Add IPs
The IP Address API lets you manage the dedicated IP addresses assigned to your SendGrid account. Use these endpoints to add dedicated IP addresses, list IP addresses, check how many IP addresses you can add, and inspect IP pool assignments.
POST/v3/ips
Base url: https://api.sendgrid.com (for global users)
This endpoint is for adding a(n) IP Address(es) to your account.
Property nameTypeRequiredDescription
Authorizationstring
required
Default:
Bearer <<YOUR_API_KEY_HERE>>Encoding type:
application/jsonSchemaExample
Property nameTypeRequiredDescriptionChild properties
countinteger
required
The amount of IPs to add to the account.
subusersarray[string]
Optional
Array of usernames to be assigned a send IP.
warmupboolean
Optional
Whether or not to warmup the IPs being added.
Default:
false201400
SchemaExample
Property nameTypeRequiredDescriptionChild properties
ipsarray[object]
Optional
List of IP objects.
Show ips properties
remaining_ipsinteger
Optional
The number of IPs that can still be added to the user.
warmupboolean
Optional
Whether or not the IPs are being warmed up.
1const client = require("@sendgrid/client");2client.setApiKey(process.env.SENDGRID_API_KEY);34const data = {5count: 90323478,6subusers: ["subuser1", "subuser2"],7warmup: true,8};910const request = {11url: `/v3/ips`,12method: "POST",13body: data,14};1516client17.request(request)18.then(([response, body]) => {19console.log(response.statusCode);20console.log(response.body);21})22.catch((error) => {23console.error(error);24});