Skip to content

Pools

A pool is a named group of phones. A message sent with poolId goes to the pool’s online phones in turn. If a phone doesn’t accept it within 10 seconds, rejects it, or goes offline, it moves to another phone in the pool. Add a phone to a pool with PATCH /v1/devices/:id and { "poolId": "pool_…" }. See Pools in the portal.

Field Type Description
id string pool_…
name string Unique in your organization.
deviceIds string[] Phones in the pool.
createdAt string
GET/v1/poolsdevices:read

Returns every pool in one page (nextCursor: null).

Terminal window
curl https://api.smsfabric.com/v1/pools \
-H "X-Api-Key: $SMSFABRIC_API_KEY"
{
"data": [
{
"id": "pool_c6f9j2m5p8s1v4y7b0e3h6k9",
"name": "Cairo office",
"deviceIds": ["dev_m4p7s2v5y8b1e4h7k0n3q6t9", "dev_n5q8t1w4z7c0f3i6l9o2r5u8"],
"createdAt": "2026-10-05T09:00:00.000Z"
}
],
"nextCursor": null
}
POST/v1/poolsdevices:manage

Creates an empty pool. Returns 201. Supports Idempotency-Key. Audited as pool.created.

Body field Type Required Constraints
name string Yes 1 to 120 characters, unique in your organization.
Terminal window
curl https://api.smsfabric.com/v1/pools \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Cairo office"}'
{ "id": "pool_c6f9j2m5p8s1v4y7b0e3h6k9", "name": "Cairo office", "deviceIds": [], "createdAt": "2026-11-19T10:30:00.000Z" }
Error When
409 pool_exists A pool with this name exists.
PATCH/v1/pools/:iddevices:manage
Body field Type Required Constraints
name string Yes 1 to 120 characters.
Terminal window
curl -X PATCH https://api.smsfabric.com/v1/pools/pool_c6f9j2m5p8s1v4y7b0e3h6k9 \
-H "X-Api-Key: $SMSFABRIC_API_KEY" \
-H "Content-Type: application/json" \
-d '{"name": "Cairo HQ"}'

Returns the pool. 404 not_found if it isn’t in your organization.

DELETE/v1/pools/:iddevices:manage

Deletes the pool. Its phones stay paired and leave the pool (poolId: null). Returns 204. Audited as pool.deleted.

Terminal window
curl -X DELETE https://api.smsfabric.com/v1/pools/pool_c6f9j2m5p8s1v4y7b0e3h6k9 \
-H "X-Api-Key: $SMSFABRIC_API_KEY"