Update Campaign By Id

curl --request PUT \
  --url 'https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "outbound_call",
  "attributes": {},
  "execution_weekdays": [
    123
  ],
  "time_window_start": "<string>",
  "time_window_end": "<string>",
  "time_zone": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "interval": 123,
  "enabled": true
}
'

import requests

url = "https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key="

payload = {
    "name": "<string>",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "outbound_call",
    "attributes": {},
    "execution_weekdays": [123],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "enabled": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    widget_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'outbound_call',
    attributes: {},
    execution_weekdays: [123],
    time_window_start: '<string>',
    time_window_end: '<string>',
    time_zone: '<string>',
    start_time: '2023-11-07T05:31:56Z',
    interval: 123,
    enabled: true
  })
};

fetch('https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=', 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://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'widget_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'outbound_call',
    'attributes' => [
        
    ],
    'execution_weekdays' => [
        123
    ],
    'time_window_start' => '<string>',
    'time_window_end' => '<string>',
    'time_zone' => '<string>',
    'start_time' => '2023-11-07T05:31:56Z',
    'interval' => 123,
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/api/v1/campaign/update/{campaign_id}?api_key="

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}")

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

	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.put("https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}"

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

{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "outbound_call",
    "attributes": {},
    "status": "not_started",
    "execution_weekdays": [
      123
    ],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "enabled": true
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

PUT

api

campaign

update

{campaign_id}

Update Campaign By Id

curl --request PUT \
  --url 'https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "outbound_call",
  "attributes": {},
  "execution_weekdays": [
    123
  ],
  "time_window_start": "<string>",
  "time_window_end": "<string>",
  "time_zone": "<string>",
  "start_time": "2023-11-07T05:31:56Z",
  "interval": 123,
  "enabled": true
}
'

import requests

url = "https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key="

payload = {
    "name": "<string>",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "outbound_call",
    "attributes": {},
    "execution_weekdays": [123],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "enabled": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    widget_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    type: 'outbound_call',
    attributes: {},
    execution_weekdays: [123],
    time_window_start: '<string>',
    time_window_end: '<string>',
    time_zone: '<string>',
    start_time: '2023-11-07T05:31:56Z',
    interval: 123,
    enabled: true
  })
};

fetch('https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=', 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://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'widget_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'type' => 'outbound_call',
    'attributes' => [
        
    ],
    'execution_weekdays' => [
        123
    ],
    'time_window_start' => '<string>',
    'time_window_end' => '<string>',
    'time_zone' => '<string>',
    'start_time' => '2023-11-07T05:31:56Z',
    'interval' => 123,
    'enabled' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "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://api.example.com/api/v1/campaign/update/{campaign_id}?api_key="

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}")

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

	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.put("https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/campaign/update/{campaign_id}?api_key=")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"widget_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"type\": \"outbound_call\",\n  \"attributes\": {},\n  \"execution_weekdays\": [\n    123\n  ],\n  \"time_window_start\": \"<string>\",\n  \"time_window_end\": \"<string>\",\n  \"time_zone\": \"<string>\",\n  \"start_time\": \"2023-11-07T05:31:56Z\",\n  \"interval\": 123,\n  \"enabled\": true\n}"

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

{
  "message": "Data updated successfully",
  "meta": {},
  "data": {
    "name": "<string>",
    "widget_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "outbound_call",
    "attributes": {},
    "status": "not_started",
    "execution_weekdays": [
      123
    ],
    "time_window_start": "<string>",
    "time_window_end": "<string>",
    "time_zone": "<string>",
    "start_time": "2023-11-07T05:31:56Z",
    "interval": 123,
    "enabled": true
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

api_key

string

query

required

Your API key for authentication. You can generate it from the Settings page. Format: starts with in-.

Path Parameters

campaign_id

string<uuid>

required

Body

application/json

name

string | null

type

enum<string> | null

Available options:

outbound_call

attributes

Attributes · object | null

status

enum<string> | null

Available options:

not_started,

to_be_run,

in_progress,

paused,

cancelled,

completed

execution_weekdays

integer[] | null

time_window_start

string<time> | null

time_window_end

string<time> | null

time_zone

string | null

start_time

string<date-time> | null

interval

integer | null

enabled

boolean | null

Response

Successful Response

message

string | null

default:Data updated successfully