Skip to main content
PUT
/
api
/
v1
/
pools
/
{uuid}
Update a pool
curl --request PUT \
  --url https://{subdomain}.mihu.ai/api/v1/pools/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "type": "FIFO",
  "max_parallel_items": 20,
  "max_retries": 5,
  "is_active": true
}
'
{
  "success": true,
  "message": "Pool updated successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "type": "FIFO",
    "max_parallel_items": 123,
    "max_retries": 123,
    "is_active": true,
    "contacts_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.mindhunters.ai/llms.txt

Use this file to discover all available pages before exploring further.

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.