Publish (activate) a campaign — schedule tasks and start processing

curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/publish \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/publish', 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}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "message": "Campaign published successfully",
  "data": {
    "campaign": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "In Process",
      "campaign_type": "call"
    },
    "tasks_created": 123
  }
}

Campaigns

Publish (activate) a campaign — schedule tasks and start processing

Transitions the campaign from Active/Draft/Paused/Failed to ‘In Process’ AND creates tasks for every pending ContactPoolItem in attached pools. The status change and task creation happen inside a single DB transaction — if task creation throws, the status flip is rolled back. For text/sms campaigns, also dispatches ProcessWhatsAppCampaign post-commit so the coordinator can sync delivery webhooks. Preconditions checked before doing any work: (1) campaign exists, (2) status is one of Active/Draft/Paused/Failed, (3) at least one pool is attached, (4) the agent has a channel binding, (5) at least one ContactPoolItem with status=‘Pending’ exists across attached pools. Note: tasks_created may legitimately be 0 if all pending contacts are blacklisted, already completed, or already at max attempts — that’s still a successful publish.

POST

api

campaigns

{uuid}

publish

Publish (activate) a campaign — schedule tasks and start processing

curl --request POST \
  --url https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/publish \
  --header 'Authorization: Bearer <token>'

import requests

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

headers = {"Authorization": "Bearer <token>"}

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

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{subdomain}.mihu.ai/api/v1/campaigns/{uuid}/publish', 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}/publish",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

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

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

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

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

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "message": "Campaign published successfully",
  "data": {
    "campaign": {
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "name": "<string>",
      "status": "In Process",
      "campaign_type": "call"
    },
    "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 publish.

Response

Campaign is now In Process. Response includes the full campaign resource and the count of tasks just scheduled.

success

boolean

Example:

true

message

string

Example:

"Campaign published successfully"

data

object

Show child attributes

API Documentation

API Reference

Publish (activate) a campaign — schedule tasks and start processing

Authorizations

Path Parameters

Response