v1

latestOpenAPI 3.1.02026-07-2616459400.5 KB

IP Management API

Assign IPs to subaccount

This allows a parent account to allocate one or more dedicated IP addresses to a subaccount by linking them with a specified sending domain. This ensures that the subaccount can send emails using the assigned IPs. The request must include the subaccount name, sending domain, and IP addresses, with all IPs belonging to the same region and owned by the parent account.

post/ip/assign

Request body

Example request

{
  "assignments": [
    {
      "ip_address": [
        "192.168.1.100",
        "192.168.1.101"
      ],
      "account_name": "subaccount1",
      "sending_domain": "mail.example.com",
      "region": "US"
    }
  ]
}

Response

IPs assigned successfully

status'success' | 'partial_success' | 'error'

messagestring

Example response

{
  "status": "success",
  "message": "All IPs were assigned successfully",
  "results": [
    {
      "account_name": "subaccount1",
      "ip": "192.168.1.100",
      "sending_domain": "mail.example.com",
      "status": "success",
      "message": "IP assigned successfully"
    }
  ]
}