Skip to main content
PATCH
Update a dedicated IP

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 dedicated IP identifier (UUID).

Body

application/json

Applies one change per request. pool_id takes precedence over warm-up changes: when it is present, the IP moves to that pool (with weight, force, and drain) and other fields are ignored. Otherwise, use warmup_paused or warmup.paused; a Boolean warmup_paused takes precedence. The PTR hostname is managed by Telnyx and cannot be changed: when neither pool_id nor a warm-up field is present, a body that includes ptr_hostname (including null) returns 422 and the IP is unchanged. A body with none of these fields returns the IP unchanged.

pool_id
string<uuid>

Move the IP to this pool, replacing its current membership. Use the IP's current pool to change only its weight. To take an IP out of a pool, use DELETE /email/ip_pools/{id}/ips/{ip_id}.

weight
integer
default:100

Routing weight in the target pool. Used only with pool_id.

Required range: x >= 1
force
boolean
default:false

Set together with drain: true to move the last IP out of its current pool. Used only with pool_id.

drain
boolean
default:false

Set together with force: true to move the last IP out of its current pool. Acknowledges that mail routed to the emptied pool is held. Used only with pool_id.

warmup_paused
boolean

Pause (true) or resume (false) the warm-up ramp; equivalent to the pause_warmup and resume_warmup actions. A Boolean value takes precedence over warmup.paused. When a pause field is present and pool_id is absent, supplying neither pause field as a Boolean invokes resume.

warmup
object

Alias for warmup_paused.

Response

Updated dedicated IP

data
object
required

A dedicated sending IP address owned by the account.