Skip to main content
PUT
/
api
/
v1
/
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": {},
  "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
}
'
{
  "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
  }
}

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
​
widget_id
string<uuid> | null
​
type
enum<string> | null
Available options:
outbound_call
​
attributes
Attributes · object
​
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
​
meta
Meta · object
​
data
ICampaignUpdate · object