Update Campaign

Update campaign

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/update-campaign \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "id": 123,
  "agent_id": 123,
  "campaign_name": "<string>",
  "description": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "max_retry": 49,
  "max_delay": "<string>",
  "conditions": [
    {
      "rules": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/update-campaign"

payload = {
    "id": 123,
    "agent_id": 123,
    "campaign_name": "<string>",
    "description": "<string>",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "max_retry": 49,
    "max_delay": "<string>",
    "conditions": [{ "rules": [
                {
                    "field": "<string>",
                    "value": "<string>"
                }
            ] }]
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 123,
    agent_id: 123,
    campaign_name: '<string>',
    description: '<string>',
    start_date: '2023-12-25',
    end_date: '2023-12-25',
    max_retry: 49,
    max_delay: '<string>',
    conditions: [{rules: [{field: '<string>', value: '<string>'}]}]
  })
};

fetch('https://www.tryunleashx.com/api/v1/global/update-campaign', 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://www.tryunleashx.com/api/v1/global/update-campaign",
  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([
    'id' => 123,
    'agent_id' => 123,
    'campaign_name' => '<string>',
    'description' => '<string>',
    'start_date' => '2023-12-25',
    'end_date' => '2023-12-25',
    'max_retry' => 49,
    'max_delay' => '<string>',
    'conditions' => [
        [
                'rules' => [
                                [
                                                                'field' => '<string>',
                                                                'value' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/update-campaign"

	payload := strings.NewReader("{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("token", "<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://www.tryunleashx.com/api/v1/global/update-campaign")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/update-campaign")

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

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

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

POST

update-campaign

Update campaign

curl --request POST \
  --url https://www.tryunleashx.com/api/v1/global/update-campaign \
  --header 'Content-Type: application/json' \
  --header 'token: <token>' \
  --data '
{
  "id": 123,
  "agent_id": 123,
  "campaign_name": "<string>",
  "description": "<string>",
  "start_date": "2023-12-25",
  "end_date": "2023-12-25",
  "max_retry": 49,
  "max_delay": "<string>",
  "conditions": [
    {
      "rules": [
        {
          "field": "<string>",
          "value": "<string>"
        }
      ]
    }
  ]
}
'

import requests

url = "https://www.tryunleashx.com/api/v1/global/update-campaign"

payload = {
    "id": 123,
    "agent_id": 123,
    "campaign_name": "<string>",
    "description": "<string>",
    "start_date": "2023-12-25",
    "end_date": "2023-12-25",
    "max_retry": 49,
    "max_delay": "<string>",
    "conditions": [{ "rules": [
                {
                    "field": "<string>",
                    "value": "<string>"
                }
            ] }]
}
headers = {
    "token": "<token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {token: '<token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    id: 123,
    agent_id: 123,
    campaign_name: '<string>',
    description: '<string>',
    start_date: '2023-12-25',
    end_date: '2023-12-25',
    max_retry: 49,
    max_delay: '<string>',
    conditions: [{rules: [{field: '<string>', value: '<string>'}]}]
  })
};

fetch('https://www.tryunleashx.com/api/v1/global/update-campaign', 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://www.tryunleashx.com/api/v1/global/update-campaign",
  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([
    'id' => 123,
    'agent_id' => 123,
    'campaign_name' => '<string>',
    'description' => '<string>',
    'start_date' => '2023-12-25',
    'end_date' => '2023-12-25',
    'max_retry' => 49,
    'max_delay' => '<string>',
    'conditions' => [
        [
                'rules' => [
                                [
                                                                'field' => '<string>',
                                                                'value' => '<string>'
                                ]
                ]
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "token: <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"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://www.tryunleashx.com/api/v1/global/update-campaign"

	payload := strings.NewReader("{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")

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

	req.Header.Add("token", "<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://www.tryunleashx.com/api/v1/global/update-campaign")
  .header("token", "<token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://www.tryunleashx.com/api/v1/global/update-campaign")

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

request = Net::HTTP::Post.new(url)
request["token"] = '<token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"id\": 123,\n  \"agent_id\": 123,\n  \"campaign_name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"start_date\": \"2023-12-25\",\n  \"end_date\": \"2023-12-25\",\n  \"max_retry\": 49,\n  \"max_delay\": \"<string>\",\n  \"conditions\": [\n    {\n      \"rules\": [\n        {\n          \"field\": \"<string>\",\n          \"value\": \"<string>\"\n        }\n      ]\n    }\n  ]\n}"

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

Use this endpoint to update an existing campaign.

Endpoint

POST /update-campaign Content-Type: application/json Authentication: Required (workspace auth)

Request Body

To update a campaign, send its id and any fields you want to change.

{
  "id": 42,
  "agent_id": 123,
  "campaign_name": "Winter Sale Campaign - Updated",
  "description": "Updated description for winter offer campaign",
  "start_date": "2025-12-05",
  "end_date": "2026-01-05",
  "max_retry": 5,
  "max_delay": "{\"d\":1,\"h\":2,\"m\":30}",
  "campaign_status": "inprogress",
  "conditions": [
    {
      "rules": [
        { "field": "status", "operator": "==", "value": "active" },
        { "field": "region", "operator": "==", "value": "US" }
      ]
    },
    {
      "join": "OR",
      "rules": [
        { "field": "priority", "operator": "==", "value": "high" }
      ]
    }
  ]
}

Notes

id is required — it identifies the campaign to update.
Only the fields you send are updated.
campaign_status accepts a string value: draft, inprogress, hold, or pause.
max_delay must be passed as a JSON string with keys d (days), h (hours), and m (minutes) as numbers.
start_date and end_date must be in YYYY-MM-DD format (e.g., "2025-12-05").
max_retry cannot be greater than 50.

Conditions Format

The conditions field accepts an array of groups. Each group contains rules that are evaluated together. Structure:

Field	Type	Required	Description
`join`	string	No	`"OR"` or `"AND"` — how this group connects with the previous group. Omit for the first group.
`rules`	array	Yes	Array of condition rules within this group. Rules within a group are always joined with AND.

Each rule:

Field	Type	Required	Description
`field`	string	Yes	The field name to evaluate (from agent’s metadata input fields)
`operator`	string	Yes	One of the allowed operators (see table below)
`value`	string	Yes	The value to match against

Allowed operators:

Operator	Description
`==`	Equals (case-insensitive)
`!=`	Not equals
`>`	Greater than (numeric)
`>=`	Greater than or equal (numeric)
`<`	Less than (numeric)
`<=`	Less than or equal (numeric)
`contains`	Value contains the substring
`startsWith`	Value starts with the string
`endsWith`	Value ends with the string

Logic:

Rules within the same group are joined with AND.
Groups are joined with each other using the join field ("OR" or "AND").

Example — single condition:

"conditions": [
  {
    "rules": [
      { "field": "status", "operator": "==", "value": "active" }
    ]
  }
]

This means: status == “active” Example — multiple conditions with AND (same group):

"conditions": [
  {
    "rules": [
      { "field": "status", "operator": "==", "value": "active" },
      { "field": "region", "operator": "==", "value": "US" }
    ]
  }
]

This means: status == “active” AND region == “US” Example — two groups with OR:

"conditions": [
  {
    "rules": [
      { "field": "status", "operator": "==", "value": "active" },
      { "field": "region", "operator": "==", "value": "US" }
    ]
  },
  {
    "join": "OR",
    "rules": [
      { "field": "priority", "operator": "==", "value": "high" }
    ]
  }
]

This means: (status == “active” AND region == “US”) OR (priority == “high”) To clear conditions, send "conditions": null.

Example cURL

curl -X POST https://www.tryunleashx.com/api/v1/global/update-campaign \
  -H "Content-Type: application/json" \
  -H "token: <api_key>" \
  -d '{
    "id": 42,
    "campaign_name": "Winter Sale Campaign - Updated",
    "start_date": "2025-12-05",
    "end_date": "2026-01-05",
    "max_retry": 5,
    "max_delay": "{\"d\":1,\"h\":2,\"m\":30}",
    "campaign_status": "inprogress",
    "conditions": [
      {
        "rules": [
          { "field": "status", "operator": "==", "value": "active" }
        ]
      }
    ]
  }'

Headers

token

string

required

API token for authentication

Body

application/json

integer

required

Campaign ID to update

agent_id

integer

Updated voice agent to use for this campaign

campaign_name

string

Updated campaign name (must remain unique within workspace)

description

string

Updated description

start_date

string<date>

Updated start date in YYYY-MM-DD format (e.g. 2025-12-05)

end_date

string<date>

Updated end date in YYYY-MM-DD format (e.g. 2026-01-05)

max_retry

integer

Updated maximum retry attempts (cannot be greater than 50)

Required range: x <= 50

max_delay

string

Delay between retries as a JSON string. Keys: d (days), h (hours), m (minutes) with numeric values. Example: {"d":1,"h":2,"m":30}

campaign_status

enum<string>

Updated campaign status.

Available options:

draft,

inprogress,

hold,

pause

conditions

object[]

Condition groups with AND/OR logic. Each group contains rules joined by AND. Groups are joined by the 'join' field (OR or AND).

Show child attributes

Response

Campaign updated successfully

Create Campaign

Force Complete Campaign

API Documentation

Phone Numbers

Voice AI

Click to Call

Call Logs

Campaigns

Users

Endpoint

Request Body

Notes

Conditions Format

Example cURL

Headers

Body

Response

​Endpoint

​Request Body

​Notes

​Conditions Format

​Example cURL

Headers

Body

Response

Endpoint

Request Body

Notes

Conditions Format

Example cURL