Menu

IP Address

Elements that can be shared among more than one endpoint definition.

Add IPs

POST /ips

This endpoint is for adding a(n) IP Address(es) to your account.

Authentication

  • API Key

Headers

Authorization
string
default: Bearer <<YOUR_API_KEY_HERE>>
required

Request Body

object
count
integer

The amount of IPs to add to the account.

required
subusers
array[string]

Array of usernames to be assigned a send IP.

warmup
boolean

Whether or not to warmup the IPs being added.

default: False
{
  "count": 90323478,
  "subusers": [
    "subuser1",
    "subuser2"
  ],
  "warmup": true,
  "user_can_send": true
}

Responses

object
ips
array[object]

List of IP objects.

required
ip
string

IP added to account.

subusers
array[string]

Array of usernames assigned a send IP.

remaining_ips
integer

The number of IPs that can still be added to the user.

required
warmup
boolean

Whether or not the IPs are being warmed up.

required
object
errors
array[object]
message
string

the error message

field
string or null

the field that generated the error

help
object

helper text or docs for troubleshooting

id
string
{
  "errors": [
    {
      "field": "field_name",
      "message": "error message"
    }
  ]
}
Rate this page:

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd browsing the SendGrid tag on Stack Overflow.

Thank you for your feedback!

We are always striving to improve our documentation quality, and your feedback is valuable to us. How could this documentation serve you better?

Sending your feedback...
🎉 Thank you for your feedback!
Something went wrong. Please try again.

Thanks for your feedback!

Refer us and get $10 in 3 simple steps!

Step 1

Get link

Get a free personal referral link here

Step 2

Give $10

Your user signs up and upgrade using link

Step 3

Get $10

1,250 free SMSes
OR 1,000 free voice mins
OR 12,000 chats
OR more