Create a contact pool - Mindhunters API Documentation

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
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/pools"

payload = {
    "name": "VIP customers",
    "description": "High-value leads, push first",
    "type": "FIFO",
    "max_parallel_items": 10,
    "max_retries": 3,
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'VIP customers',
    description: 'High-value leads, push first',
    type: 'FIFO',
    max_parallel_items: 10,
    max_retries: 3,
    is_active: true
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.mihu.ai/api/v1/pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'VIP customers',
    'description' => 'High-value leads, push first',
    'type' => 'FIFO',
    'max_parallel_items' => 10,
    'max_retries' => 3,
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.mihu.ai/api/v1/pools"

	payload := strings.NewReader("{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{subdomain}.mihu.ai/api/v1/pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Pool created successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "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"
  }
}

POST

api

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
}
'

import requests

url = "https://{subdomain}.mihu.ai/api/v1/pools"

payload = {
    "name": "VIP customers",
    "description": "High-value leads, push first",
    "type": "FIFO",
    "max_parallel_items": 10,
    "max_retries": 3,
    "is_active": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'VIP customers',
    description: 'High-value leads, push first',
    type: 'FIFO',
    max_parallel_items: 10,
    max_retries: 3,
    is_active: true
  })
};

fetch('https://{subdomain}.mihu.ai/api/v1/pools', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{subdomain}.mihu.ai/api/v1/pools",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'VIP customers',
    'description' => 'High-value leads, push first',
    'type' => 'FIFO',
    'max_parallel_items' => 10,
    'max_retries' => 3,
    'is_active' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{subdomain}.mihu.ai/api/v1/pools"

	payload := strings.NewReader("{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{subdomain}.mihu.ai/api/v1/pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/pools")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"VIP customers\",\n  \"description\": \"High-value leads, push first\",\n  \"type\": \"FIFO\",\n  \"max_parallel_items\": 10,\n  \"max_retries\": 3,\n  \"is_active\": true\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "message": "Pool created successfully",
  "data": {
    "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "description": "<string>",
    "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"
  }
}

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.

Show child attributes