IP Pools

Delete an IP pool

Changed on

Delete the pool. Member IPs are kept but leave the pool, so they carry no mail until added to another pool. Deleting a pool changes routing for subsequently resolved messages. It does not reroute messages already assigned to the deleted pool. Deleting a pool that still has IPs requires force=true and drain=true.

delete/email/ip_pools/{id}

Request

  • Base URL: https://api.telnyx.com/v2
  • URL: https://api.telnyx.com/v2/email/ip_pools/{id}
  • Auth: HTTP bearer

Path parameters

idstring uuid required

The IP pool identifier (UUID).

Query parameters

forceboolean

Set together with drain=true to delete a pool that still has IPs. Either flag alone has no effect.

drainboolean

Set together with force=true to delete a pool that still has IPs. Acknowledges deletion while the pool still has members; this flag does not reroute already queued messages.

Response

Pool deleted. No response body.

Changes