Sign in

v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB
IP Management API

Assign pools to Subaccount

This allows a parent account to manage which IP pools are available to a subaccount. You can add new pools or remove existing ones from a subaccount, ensuring that eacg subaccount has the correct set of IP pools for its sending need.

post/ip/pool/subaccount/assign-pools

Request body

accountstring required

The username of the subaccount to which pools will be assigned or removed. The subaccount must exist and belong to the authenticated parent account.

sending_domainstring hostname required

The domain associated with the subaccount. This must be a valid domain owned by the account and is used to link pool assignments to the correct sending domain.

pools_to_addstring[]

A list of pool names to assign to the subaccount. Maximum of 10 pools per request. Each pool must exist, belong to the parent account, and not already be assigned to the subaccount.

pools_to_removestring[]

A list of pool names to remove from the subaccount. Maximum of 10 pools per request. Each pool must currently be assigned to the subaccount.

Example request

{
  "account": "subaccount1",
  "sending_domain": "mail.example.com",
  "pools_to_add": [
    "marketing-pool",
    "support-pool"
  ],
  "pools_to_remove": [
    "old-pool"
  ]
}

Response

Pools assigned successfully

statusstring
messagestring

Example response

{
  "status": "success",
  "message": "IP pools assigned successfully",
  "result": {
    "account": "subaccount1",
    "assigned_pools": [
      "marketing-pool",
      "support-pool"
    ],
    "updated_on": "2024-01-15T10:30:00Z"
  }
}