Menu

IP Address

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

Add IPs

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

the field that generated the error

help
object

helper text or docs for troubleshooting

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

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.