Rename a pool

PATCH/v1/numbers/pools/{id}

Path Parameters

idstringrequired

Body Parameters

namestring
descriptionstring
routingsticky, local
How a recipient gets a number. sticky: the same member every time. local: a member in the recipient's area code, else one in their time zone, else any; still the same one each time. Default "sticky".

Responses

200Pool
The pool
401Error
Missing, malformed, or revoked API key
402Error
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429Error
Rate limit or quota exceeded

Response Fields

idstring
Example: pool_a1B2c3D4e5F6.
objectpool
namestring
routingsticky, local
descriptionstring
Nullable.
numbersarray of string
Active member numbers (E.164)
cloned_fromstring
Nullable.
created_atstring (date-time)

Errors

Every error has the same JSON shape, and request_id matches the X-Request-Id response header. Errors lists every code and what to do about it.

401
Missing, malformed, or revoked API key
402
Billable live calls only: the prepaid credit balance cannot cover the call (insufficient_credits); nothing was done or charged
429
Rate limit or quota exceeded

const res = await fetch('https://api.jointextkit.com/v1/numbers/pools/pool_a1B2c3D4e5F6', {
  method: 'PATCH',
  headers: {
    Authorization: `Bearer ${process.env.TEXTKIT_API_KEY}`,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({}),
});

if (!res.ok) throw new Error((await res.json()).error.message);
const data = await res.json();

Response 200

{
  "id": "pool_a1B2c3D4e5F6",
  "object": "pool",
  "routing": "sticky"
}