Skip to main content
PATCH
Update an IP pool

Authorizations

Authorization
string
header
required

Telnyx API key supplied as Authorization: Bearer <token>. In production, auth may be validated by the API gateway and forwarded via Telnyx auth headers.

Path Parameters

id
string<uuid>
required

The IP pool identifier (UUID).

Body

application/json
name
string

Pool name: 1-64 characters of lowercase letters, digits, ., _, and -, starting and ending with a letter or digit. Must be unique within the account and must not start with dip_.

is_default
boolean

Set or clear the account default flag. An account can have one default pool.

domain_id
string<uuid> | null

Scope the pool to one of the account's email domains, or null to remove the scope.

Response

Updated IP pool

data
object
required

An account-scoped pool of dedicated IPs. Mail uses a pool only when the pool is scoped to the sending domain (domain_id) or is the account default (is_default).