Add campaign bulk data API is used to add data in bulk to any outbound campaign(dialer). data(numbers/leads) consists of a map(headers) sequence listing PhoneNumber, Name, Priority, ExpiryDate while adding to the dialer.

This data MUST be manually entered in the format below

{[["PhoneNumber": "865XXXXXXX"
"Name": "Name1"
"Priority": "1"]]}

To access this API the following parameters MUST be passed.

api_key*CloudAgent admin login
campaign_name*CloudAgent account name
BulkData*Data to be inserted



  • The maximum count of data to be added is 200 per request.
  • Parameters with ‘*’ are mandatory parameters.
  • The timestamp between two requests for passing data is 30 seconds.
  • Following is the format to save bulk numbers (3 sample numbers) with names.
    "data": {[
    ["PhoneNumber": "865XXXXXXX"
    "Name": "Name1"
    "Priority": "1"
    "ExpiryDate": "YYYY-MM-DD HH:MM:SS"]
    ["PhoneNumber": "789XXXXXXX"
    "Name": "Anxxxxx"
    "Priority": "2"
    "ExpiryDate": "YYYY-MM-DD HH:MM:SS"]
    ["PhoneNumber": "824XXXXXX"
    "Name": "Paxxxxx"
    "Priority": "3"
    "ExpiryDate": "YYYY-MM-DD HH:MM:SS"]]}

Possible responses

Success responsemessage: "PhoneNumber": "865XXXXXX",
"Name": "Garxxx",
"Priority": "1",
"ExpiryDate": "YYYY-MM-DD HH:MM:SS",
"status": "SuccessFully Updated"
Invalid api_key"status": "failure"
"message": "no user found"
Invalid campaignName"status": "failure"
"message": "no user found"
Missing PhoneNumber"message": PhoneNumber
"Name": Garxxxx",
"Priority": 1,
"ExpiryDate": YYYY-MM-DD HH:MM:SS,
"Status": "Phone Number is Empty!"
Invalid priority value"status": "error"
"message": "Priority, supports only numeric value or the value is not passed properly"
Invalid date"status": "error"
"message": "ExpiryDate, supports the following
format only 'YYYY-MM-DD HH:MM:SS"
Adding DND phone numbers"status": "FAIL"
"message": "PhoneNumber Added is a DND Number"


Further Insights

By default, the domain name is Please refer here to change based on the need.

Click Try It! to start a request and see the response here!