Update an IP pool

PATCH

ip_pools

{id}

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const IpPoolShow = await client.email.ipPools.update('id', {
  name: 'name',
});

console.log(IpPoolShow.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
ip_pool_show = client.email.ip_pools.update(
    id="id",
    name="name",
)
print(ip_pool_show.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	iPPool, err := client.Email.IPPools.Update(
		context.TODO(),
		"id",
		telnyx.EmailIPPoolUpdateParams{
			Name: telnyx.String("name"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", iPPool.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.email.ipPools.IpPoolUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        IpPoolUpdateParams params = IpPoolUpdateParams.builder()
            .name("name")
            .build();
        var response = client.email().ipPools().update("id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $ip_pool_show = $client->email->ipPools->update(
    'id',
    name: 'name',
  );

  var_dump($ip_pool_show);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PATCH \
  --url https://api.telnyx.com/v2/email/ip_pools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "renamed-pool"
}
'

{
  "data": {
    "id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
    "record_type": "ip_pool",
    "name": "renamed-pool",
    "is_default": true,
    "domain_id": null,
    "ips": [],
    "created_at": "2026-09-30T02:03:09.474123Z",
    "updated_at": "2026-10-14T21:30:00.000000Z"
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested ip pool was not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "must contain only lowercase letters, numbers, dots, underscores and hyphens",
      "source": {
        "pointer": "/data/attributes/name"
      }
    }
  ]
}

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

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).

Show child attributes

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const IpPoolShow = await client.email.ipPools.update('id', {
  name: 'name',
});

console.log(IpPoolShow.data);

import os
from telnyx import Telnyx

client = Telnyx(
    api_key=os.environ.get("TELNYX_API_KEY"),  # This is the default and can be omitted
)
ip_pool_show = client.email.ip_pools.update(
    id="id",
    name="name",
)
print(ip_pool_show.data)

package main

import (
	"context"
	"fmt"

	"github.com/team-telnyx/telnyx-go"
	"github.com/team-telnyx/telnyx-go/option"
)

func main() {
	client := telnyx.NewClient(
		option.WithAPIKey("My API Key"),
	)
	iPPool, err := client.Email.IPPools.Update(
		context.TODO(),
		"id",
		telnyx.EmailIPPoolUpdateParams{
			Name: telnyx.String("name"),
		},
	)
	if err != nil {
		panic(err.Error())
	}
	fmt.Printf("%+v\n", iPPool.Data)
}

package com.telnyx.sdk.example;

import com.telnyx.sdk.client.TelnyxClient;
import com.telnyx.sdk.client.okhttp.TelnyxOkHttpClient;
import com.telnyx.sdk.models.email.ipPools.IpPoolUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        TelnyxClient client = TelnyxOkHttpClient.fromEnv();

        IpPoolUpdateParams params = IpPoolUpdateParams.builder()
            .name("name")
            .build();
        var response = client.email().ipPools().update("id", params);
    }
}

<?php

require_once dirname(__DIR__) . '/vendor/autoload.php';

use Telnyx\Client;
use Telnyx\Core\Exceptions\APIException;

$client = new Client(apiKey: getenv('TELNYX_API_KEY') ?: 'My API Key');

try {
  $ip_pool_show = $client->email->ipPools->update(
    'id',
    name: 'name',
  );

  var_dump($ip_pool_show);
} catch (APIException $e) {
  echo $e->getMessage();
}

curl --request PATCH \
  --url https://api.telnyx.com/v2/email/ip_pools/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "renamed-pool"
}
'

{
  "data": {
    "id": "9b1c4d70-abcd-4e5f-8a9b-0c1d2e3f4a5b",
    "record_type": "ip_pool",
    "name": "renamed-pool",
    "is_default": true,
    "domain_id": null,
    "ips": [],
    "created_at": "2026-09-30T02:03:09.474123Z",
    "updated_at": "2026-10-14T21:30:00.000000Z"
  }
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "<string>",
      "title": "<string>",
      "detail": "<string>",
      "source": {
        "pointer": "<string>",
        "parameter": "<string>"
      }
    }
  ]
}

{
  "errors": [
    {
      "code": "10001",
      "title": "Not Found",
      "detail": "The requested ip pool was not found"
    }
  ]
}

{
  "errors": [
    {
      "code": "10015",
      "title": "Validation Failed",
      "detail": "must contain only lowercase letters, numbers, dots, underscores and hyphens",
      "source": {
        "pointer": "/data/attributes/name"
      }
    }
  ]
}

Getting Started

Sending Email

Inboxes

Domains & Validation

Deliverability

Templates & Suppression

Events & Webhooks

For AI Agents

Update an IP pool

Authorizations

Path Parameters

Body

Response