Skip to main content
PUT
Update a pool

Authorizations

Authorization
string
header
required

Use a Bearer token to access these API endpoints. Example: "Bearer {your-token}"

Path Parameters

uuid
string<uuid>
required

UUID of the pool to update.

Body

application/json
name
string

New display name.

Required string length: 3 - 255
description
string

New free-form description.

type
enum<string>

Switch the processing strategy. Note: existing in-flight pool items keep their current status; only future dispatches honor the new ordering.

Available options:
FIFO,
LIFO,
Parallel
max_parallel_items
integer

Update the parallel cap (only meaningful when type='Parallel').

Required range: 1 <= x <= 100
Example:

20

max_retries
integer

Update the pool-level retry ceiling. Campaign rules still take precedence when present.

Required range: x >= 0
Example:

5

is_active
boolean

Activate or deactivate the pool. Deactivating does not stop running campaigns or cancel scheduled tasks; it only hides the pool from new campaign builders.

Response

Updated pool resource.

success
boolean
Example:

true

message
string
Example:

"Pool updated successfully"

data
object

Contact pool. Bucket of contacts that one or more campaigns can draw from. Returned with contacts_count on every endpoint, and additionally with status_counts + campaigns on detail (GET /pools/{uuid}) endpoints.