v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB

IP Management API

Remove Pools from Subaccount

This allows a parent account to unassign IP pools from a subaccount.

post/ip/pool/subaccount/remove-pools

Request body

accountstring required

The username of the subaccount from which the pools will be removed.

sending_domainstring hostname required

The sending domain associated with the subaccount. Must be valid and active for the account.

pools_to_removestring[]

A list of IP pool names to remove from the subaccount. At least one pool must be provided. Each pool must already be assigned to the subaccount. Maximum of 10 pools per request.

Example request

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

Response

Pools removed successfully

statusstring

messagestring

Example response

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