Skip to main content
POST
/
campaigns
/
save-campaign
Create a new scheduled campaign
curl --request POST \
  --url https://api.cleartalk.ai/campaigns/save-campaign \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "agent_id": 20,
  "agentname": "Agent Name",
  "batchQuantity": 100,
  "repeatAfter": 100,
  "active": true,
  "selected_tag": "Tag",
  "index": 0,
  "start_call": "2021-01-01",
  "end_call": "2021-01-01",
  "campaign_name": "Campaign Name",
  "add_tag": "Tag",
  "user_id": 0,
  "maxLimit": 0,
  "GHLCampaign": false,
  "NumberlimitCallback": 0,
  "working_hours": [],
  "disposition": []
}
'

Documentation Index

Fetch the complete documentation index at: https://docs.cleartalk.ai/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
x-api-key
string
header
required

API Key for authentication

Body

application/json
​
agent_id
number
required

Agent id

Example:

20

​
agentname
string
required

Agent name

Example:

"Agent Name"

​
batchQuantity
number
required

Batch quantity

Example:

100

​
repeatAfter
number
required

Repeat after

Example:

100

​
active
boolean
required

Active

Example:

true

​
selected_tag
string
required

Tag

Example:

"Tag"

​
index
number
required

Index

Example:

0

​
start_call
string
required

Start call

Example:

"2021-01-01"

​
end_call
string
required

End call

Example:

"2021-01-01"

​
campaign_name
string
required

Campaign name

Example:

"Campaign Name"

​
add_tag
string
required

Add tag

Example:

"Tag"

​
user_id
number
required

User id

Example:

0

​
maxLimit
number
required

Max limit

Example:

0

​
GHLCampaign
boolean
required

GHL campaign

Example:

false

​
NumberlimitCallback
number
required

Number limit callback

Example:

0

​
working_hours
object
required

Working hours

Example:
[]
​
disposition
object
required

Disposition

Example:
[]

Response

201

Campaign created successfully