Attach one or more pools to a campaign

curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pool_uuids": [
    "da00a73e-9f0d-4570-bf2d-dc50970574d5"
  ]
}
'

import requests

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

payload = { "pool_uuids": ["da00a73e-9f0d-4570-bf2d-dc50970574d5"] }
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({pool_uuids: ['da00a73e-9f0d-4570-bf2d-dc50970574d5']})
};

fetch('https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/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/campaigns/{uuid}/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([
    'pool_uuids' => [
        'da00a73e-9f0d-4570-bf2d-dc50970574d5'
    ]
  ]),
  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/campaigns/{uuid}/pools"

	payload := strings.NewReader("{\n  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\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/campaigns/{uuid}/pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/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  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\n}"

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

{
  "success": true,
  "message": "N pool(s) attached to campaign, M task(s) created.",
  "data": {
    "campaign_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pools_attached": 123,
    "pools_skipped": 123,
    "pool_uuids_not_found": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "tasks_created": 123
  }
}

Campaigns

Attach one or more pools to a campaign

Pools are additive (not replace). UUIDs already attached are silently skipped, UUIDs that don’t resolve to a pool are returned in pool_uuids_not_found. If the campaign status is ‘In Process’, tasks are immediately created for every Pending ContactPoolItem in the newly attached pools, and ProcessWhatsAppCampaign is dispatched for text/sms campaigns. The attach + task creation are wrapped in a single DB transaction so a partial failure rolls back both the pivot rows and any tasks that were inserted.

POST

api

campaigns

{uuid}

pools

Attach one or more pools to a campaign

curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/pools \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "pool_uuids": [
    "da00a73e-9f0d-4570-bf2d-dc50970574d5"
  ]
}
'

import requests

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

payload = { "pool_uuids": ["da00a73e-9f0d-4570-bf2d-dc50970574d5"] }
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({pool_uuids: ['da00a73e-9f0d-4570-bf2d-dc50970574d5']})
};

fetch('https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/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/campaigns/{uuid}/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([
    'pool_uuids' => [
        'da00a73e-9f0d-4570-bf2d-dc50970574d5'
    ]
  ]),
  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/campaigns/{uuid}/pools"

	payload := strings.NewReader("{\n  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\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/campaigns/{uuid}/pools")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/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  \"pool_uuids\": [\n    \"da00a73e-9f0d-4570-bf2d-dc50970574d5\"\n  ]\n}"

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

{
  "success": true,
  "message": "N pool(s) attached to campaign, M task(s) created.",
  "data": {
    "campaign_uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "pools_attached": 123,
    "pools_skipped": 123,
    "pool_uuids_not_found": [
      "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    ],
    "tasks_created": 123
  }
}

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 campaign to attach pools to.

Body

application/json

pool_uuids

string<uuid>[]

required

UUIDs of pools to attach. Create pools with POST /api/v1/pools and populate them with POST /api/v1/pools/{uuid}/contacts before attaching. Duplicates within the array are deduplicated server-side.

Minimum array length: 1

Response

Operation summary. Response includes how many pools were attached, skipped, or not found, plus how many tasks were created.

success

boolean

Example:

true

message

string

Example:

"N pool(s) attached to campaign, M task(s) created."

data

object

Show child attributes

API Documentation

API Reference

Attach one or more pools to a campaign

Authorizations

Path Parameters

Body

Response