Skip to main content
POST
/
v1
/
campaign
/
Create Campaign
curl --request POST \
  --url https://api.nedzo.ai/v1/campaign/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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
}
'
{
  "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.

Body

application/json
​
name
string
required

The name of the campaign, typically used to identify and organize the campaign.

​
agent_id
string<uuid>
required

The unique identifier for the agent associated with the campaign. This links the campaign to a specific agent.

​
start_time
string<time>
required

The start time of the campaign, indicating when the agent should begin making calls.

​
end_time
string<time>
required

The end time of the campaign, marking when the agent should stop making calls.

​
min_calls_per_hour
integer
required

The minimum number of calls or tasks an agent should complete per hour during the campaign.

​
max_calls_per_hour
integer
required

The maximum number of calls or tasks an agent can complete per hour during the campaign.

​
daily_usage_cap
integer | null

The daily limit on the number of calls an agent can perform. If not set, there may be no limit.

​
max_dials_per_contact
integer | null
default:25

The maximum number of times a contact can be dialed or contacted during the campaign. Default is 25.

Response

Successful Response

​
status_code
integer
required
​
message
string
required
​
data
object | null