Skip to main content
PUT
/
account
/
ip
/
allocate
Allocate a New IP
curl --request PUT \
  --url https://api.sendpost.io/api/v1/account/ip/allocate \
  --header 'Content-Type: application/json' \
  --header 'X-Account-ApiKey: <api-key>' \
  --data '{
  "overflowPool": true,
  "ips": [
    "34.21.14.11"
  ]
}'
{
  "id": 11321,
  "publicIP": "52.34.11.12",
  "systemDomain": {
    "id": 117,
    "name": "piedpiper.com",
    "dkim": {
      "host": "1587987845._domainkey.hooli.com",
      "type": "TXT",
      "textValue": "v=DKIM1;k=rsa;s=email;h=sha256;p=MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDsGMUVM1bqebA0bgtf0HQ6P/FZJy42k/OHP0OgVv4WMSsHOvCFre1/6d1GTx3ldeJf612K3L7wV4iJfDMh2FEpuQ+z+pOro3FarWuawoiJbBudgQQ8rResnZ4Sg3W1Zr3tcZgBCEQ9WoLDv/B2dd01p3ZJ40hsco+Fw75Ldnrd3wIDAQAB"
    },
    "returnPath": {
      "host": "sp-bounces.hooli.com",
      "type": "CNAME",
      "textValue": "sp.sendpost.email"
    },
    "track": {
      "host": "track.hooli.com",
      "type": "CNAME",
      "textValue": "api.sendpost.io"
    },
    "dmarc": {
      "host": "_dmarc.hooli.com",
      "type": "TXT",
      "textValue": "v=DMARC1; p=none;"
    },
    "dkimConfig": "<string>",
    "dkimVerified": false,
    "dmarcVerified": false,
    "returnPathVerified": false,
    "trackVerified": true,
    "created": 1567512491587205000
  },
  "reverseDNSHostname": "example.mtaspg.email",
  "type": 0,
  "gmailSettings": "{\"name\":\"gmail\",\"maxConcurrentConnections\":100,...}",
  "yahooSettings": "{\"name\":\"yahoo\",\"maxConcurrentConnections\":16,...}",
  "aolSettings": "{\"name\":\"aol\",\"maxConcurrentConnections\":20,...}",
  "microsoftSettings": "{\"name\":\"microsoft\",\"maxConcurrentConnections\":16,...}",
  "comcastSettings": "{\"name\":\"comcast\",\"maxConcurrentConnections\":20,...}",
  "yandexSettings": "{\"name\":\"yandex\",\"maxConcurrentConnections\":2,...}",
  "gmxSettings": "{\"name\":\"gmx\",\"maxConcurrentConnections\":2,...}",
  "mailruSettings": "{\"name\":\"mailru\",\"maxConcurrentConnections\":1,...}",
  "icloudSettings": "{\"name\":\"icloud\",\"maxConcurrentConnections\":20,...}",
  "zohoSettings": "{\"name\":\"zoho\",\"maxConcurrentConnections\":1,...}",
  "qqSettings": "{\"name\":\"qq\",\"maxConcurrentConnections\":1,...}",
  "defaultSettings": "{\"name\":\"default\",\"maxConcurrentConnections\":14,...}",
  "attSettings": "{\"name\":\"att\",\"maxConcurrentConnections\":1,...}",
  "created": 1703224038766344700,
  "infraClassification": "",
  "infraMonitor": true,
  "state": 1,
  "autoWarmupPlan": null
}

Authorizations

​
X-Account-ApiKey
string
header
required

This api key can be used for all account level operations

Body

application/json
​
overflowPool
boolean
required

Determines whether emails should be sent over shared IP when the IP pool is full

Example:

true

​
ips
string[]
required

List of IP resources within the pool

Response

200 - application/json

Details of the allocated IP

​
id
integer
required

Unique ID for the IP

Example:

11321

​
publicIP
string
required

The public IP address associated with the resource

Example:

"52.34.11.12"

​
created
integer
required

The timestamp (UNIX epoch) when the IP was created

Example:

1703224038766344700

​
systemDomain
object

Details of the system domain associated with the IP

​
reverseDNSHostname
string

The reverse DNS hostname for the IP

Example:

"example.mtaspg.email"

​
type
integer

Type of the IP

Example:

0

​
gmailSettings
string

Configuration for Gmail delivery settings in JSON format

Example:

"{\"name\":\"gmail\",\"maxConcurrentConnections\":100,...}"

​
yahooSettings
string

Configuration for Yahoo delivery settings in JSON format

Example:

"{\"name\":\"yahoo\",\"maxConcurrentConnections\":16,...}"

​
aolSettings
string

Configuration for AOL delivery settings in JSON format

Example:

"{\"name\":\"aol\",\"maxConcurrentConnections\":20,...}"

​
microsoftSettings
string

Configuration for Microsoft delivery settings in JSON format

Example:

"{\"name\":\"microsoft\",\"maxConcurrentConnections\":16,...}"

​
comcastSettings
string

Configuration for Comcast delivery settings in JSON format

Example:

"{\"name\":\"comcast\",\"maxConcurrentConnections\":20,...}"

​
yandexSettings
string

Configuration for Yandex delivery settings in JSON format

Example:

"{\"name\":\"yandex\",\"maxConcurrentConnections\":2,...}"

​
gmxSettings
string

Configuration for GMX delivery settings in JSON format

Example:

"{\"name\":\"gmx\",\"maxConcurrentConnections\":2,...}"

​
mailruSettings
string

Configuration for Mail.ru delivery settings in JSON format

Example:

"{\"name\":\"mailru\",\"maxConcurrentConnections\":1,...}"

​
icloudSettings
string

Configuration for iCloud delivery settings in JSON format

Example:

"{\"name\":\"icloud\",\"maxConcurrentConnections\":20,...}"

​
zohoSettings
string

Configuration for Zoho delivery settings in JSON format

Example:

"{\"name\":\"zoho\",\"maxConcurrentConnections\":1,...}"

​
qqSettings
string

Configuration for QQ delivery settings in JSON format

Example:

"{\"name\":\"qq\",\"maxConcurrentConnections\":1,...}"

​
defaultSettings
string

Default delivery settings in JSON format

Example:

"{\"name\":\"default\",\"maxConcurrentConnections\":14,...}"

​
attSettings
string

Configuration for AT&T delivery settings in JSON format

Example:

"{\"name\":\"att\",\"maxConcurrentConnections\":1,...}"

​
infraClassification
string

Classification of the infrastructure

Example:

""

​
infraMonitor
boolean

Indicates whether infrastructure monitoring is enabled

Example:

true

​
state
integer

The state of the IP

Example:

1

​
autoWarmupPlan
string | null

The auto-warmup plan associated with the IP

Example:

null

⌘I