Dedicated IPs

Update a dedicated IP

Changed on

Move the IP to another pool, or pause/resume its warm-up ramp. One change applies per request. pool_id takes precedence over warm-up changes. Otherwise, use warmup_paused or warmup.paused; a Boolean warmup_paused takes precedence. Moving the last IP out of a pool requires force: true and drain: true. The PTR hostname is managed by Telnyx: a request that includes ptr_hostname returns 422 unless pool_id or a warm-up field is present, in which case ptr_hostname is ignored.

patch/email/dedicated_ips/{id}

Request

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

Path parameters

idstring uuid required

The dedicated IP identifier (UUID).

Request body

pool_idstring 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}.

weightinteger

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

forceboolean

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

drainboolean

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_pausedboolean

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.

Response

Updated dedicated IP

Changes