Skip to main content
PATCH
/
v1
/
campaign
/
{id}
Update Campaign
curl --request PATCH \
  --url https://api.nedzo.ai/v1/campaign/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "agent_id": 123,
  "start_time": "<string>",
  "end_time": "<string>",
  "min_calls_per_hour": 123,
  "max_calls_per_hour": 123,
  "daily_usage_cap": 123,
  "dials": 123,
  "max_dials_per_contact": 123,
  "is_active": true
}
'
{
  "status_code": 123,
  "message": "<string>",
  "data": {
    "campaign": {
      "name": "<string>",
      "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "start_time": "<string>",
      "end_time": "<string>",
      "min_calls_per_hour": 123,
      "max_calls_per_hour": 123,
      "daily_usage_cap": 123,
      "max_dials_per_contact": 123,
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dials": 123,
      "outcome_appointment_booked": 123,
      "outcome_callback_requested": 123,
      "outcome_do_not_call": 123,
      "outcome_failed": 123,
      "outcome_follow_up": 123,
      "outcome_no_answer": 123,
      "outcome_not_interested": 123,
      "outcome_transferred": 123,
      "outcome_wrong_number": 123,
      "is_active": true,
      "total_min_used_today": 123,
      "total_min_used": 123,
      "total_pickups": 123,
      "total_positive_outcomes": 123
    }
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string<uuid>
required

Body

application/json
name
string | null
agent_id
integer | null
start_time
string<time> | null
end_time
string<time> | null
min_calls_per_hour
integer | null
max_calls_per_hour
integer | null
daily_usage_cap
integer | null
dials
integer | null
max_dials_per_contact
integer | null
is_active
boolean | null
default:true

Response

Successful Response

status_code
integer
required
message
string
required
data
object | null