Update a number pool

update a number pool. Rename the pool and/or replace its complete member set.

PATCH https://api.centerfy.ai/webhooks/inbound/number-pools/:id

Headers

Header	Required	Value	Description
`x-api-key`	Yes	your sub-account API key (cfy_…)	API key; or Authorization: Bearer `<key>`.
`Content-Type`	Yes	application/json	request body is JSON.

Path parameters

Name	Type	Required	Description
`id`	`string (uuid)`	Yes	the number pool id; 404 otherwise.

Body parameters

Name	Type	Required	Default	Description
`name`	`string`	No	—	Optional. New name for the pool. If present it must be non-blank (400 ‘name cannot be blank’ otherwise).
`phone_number_ids`	`array`	No	—	Optional. The COMPLETE desired set of member phone-number UUIDs (set semantics). Membership is diffed: numbers not in the list are removed, new ones added. Pass [] to clear all numbers. Must be an array (400 otherwise); each entry must be a valid UUID and a phone number you own (400 otherwise). At least one of name or phone_number_ids must be sent (400 ‘nothing to update’ otherwise).

Request body

{
  "name": "West Coast Sales",
  "phone_number_ids": [
    "<phone_number_id_1>",
    "<phone_number_id_2>"
  ]
}

Example

curl -X PATCH "https://api.centerfy.ai/webhooks/inbound/number-pools/{id}" \
  -H "x-api-key: $CENTERFY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "West Coast Sales",
  "phone_number_ids": [
    "<phone_number_id_1>",
    "<phone_number_id_2>"
  ]
}'

import { CenterfyClient } from "@centerfy/sdk";

const centerfy = new CenterfyClient({ apiKey: process.env.CENTERFY_API_KEY! });

const result = await centerfy.numberPools.update("<poolId>", {
  "name": "West Coast Sales",
  "phone_number_ids": [
    "<phone_number_id_1>",
    "<phone_number_id_2>"
  ]
});
console.log(result);

centerfy numberPools update <poolId> '{"name":"West Coast Sales","phone_number_ids":["<phone_number_id_1>","<phone_number_id_2>"]}'

MCP tool: centerfy_number_pools_update (see MCP server)

Response

{
  "status": "success",
  "updated": true,
  "added_numbers": 1,
  "removed_numbers": 0,
  "number_pool": {
    "id": "3f1c9a2e-5b6d-4e8a-9c1f-2a3b4c5d6e7f",
    "name": "West Coast Sales",
    "number_count": 2,
    "numbers": [
      {
        "phone_number_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "phone_number": "+14155550123"
      },
      {
        "phone_number_id": "b2c3d4e5-f6a7-8901-bcde-f23456789012",
        "phone_number": "+14155550199"
      }
    ],
    "created_at": "2026-05-01T12:00:00.000Z",
    "updated_at": "2026-06-12T09:30:00.000Z"
  }
}

Errors

400 — invalid pool id, nothing to update, blank name, phone_number_ids not an array, an invalid UUID in the list, or a number you do not own.
404 — pool not found.
401 — missing or invalid key.