Skip to main content
POST
/
api
/
v1
/
pools
Create a contact pool
curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "VIP customers",
  "description": "High-value leads, push first",
  "type": "FIFO",
  "max_parallel_items": 10,
  "max_retries": 3,
  "is_active": true
}
'
{
  "success": true,
  "message": "Pool created 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}"

Body

application/json
​
name
string
required

Display name. 3-255 characters. Not required to be unique — duplicates are allowed.

Required string length: 3 - 255
Example:

"VIP customers"

​
description
string
required

Free-form notes about who's in this pool and why. Required.

Example:

"High-value leads, push first"

​
type
enum<string>

Processing order strategy. FIFO = pending items dequeued in insertion order (oldest first). LIFO = newest first (good for hot leads). Parallel = up to max_parallel_items processed concurrently, ordered by priority then insertion. Default: FIFO.

Available options:
FIFO,
LIFO,
Parallel
Example:

"FIFO"

​
max_parallel_items
integer

Concurrency cap when type='Parallel'. Ignored for FIFO/LIFO. Capped server-side at 100. Default: 10.

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

10

​
max_retries
integer

Pool-level retry ceiling. When a campaign is attached, the rule's max_total_calls takes precedence. Default: 3.

Required range: x >= 0
Example:

3

​
is_active
boolean

Active flag. Inactive pools are excluded from campaign creation but remain readable via the API. Default: true.

Example:

true

Response

Pool created.

​
success
boolean
Example:

true

​
message
string
Example:

"Pool created 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.