Clone a pool

New pool with the same description and members.

POST/v1/numbers/pools/{id}/clone

Path Parameters

idstringrequired

Body Parameters

The body is optional.

namestring

Details

Numbers can belong to several pools.

Responses

201Pool
The new 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/clone', {
  method: 'POST',
  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 201

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