Sign in

v1

latestOpenAPI 3.0.02026-07-2449050.9 KB
Campaign

Add Campaign Data (Token Authentication)

Adds campaign data, including campaign details and associated metadata.

post/ca_apis/AddCampaignData

Headers

Content-Typestring required

Should be set to application/json.

Request body

campaignNamestring required

Name of the campaign where the data is to be added.

phoneNumberstring required

The phone number to be added.

namestring

Optional name of the lead. Could be any of your choice.

actionstring

The action to be performed. Pass 'start' to start campaign after data is added.

skillstring

Associated skill name.

priorityinteger

Priority of the number. Higher values are dialed sooner (1-99).

agentIdstring

Agent ID, if agent-wise campaign.

expiryDatestring date-time

Expiry date of the lead in YYYY-MM-DD HH:MM:SS format.

checkDuplicateboolean

Pass true to check for duplicate phone numbers.

userNamestring required

Your CloudAgent account username.

skipNameFieldValidationboolean

Pass true, to skip name field validation.

CustomFields1string

Custom field 1 for additional data.

CustomFields2string

Custom field 2 for additional data.

CustomFields3string

Custom field 3 for additional data.

Example request

{
  "campaignName": "PromoCampaign",
  "phoneNumber": "830xxxxxxx",
  "name": "John Doe",
  "action": "start",
  "skill": "Sales",
  "priority": 10,
  "agentId": "Agent001",
  "expiryDate": "2025-01-01 12:00:00",
  "checkDuplicate": true,
  "userName": "xxxx",
  "CustomFields1": "xxxx",
  "CustomFields2": "xxxx",
  "CustomFields3": "xxxx"
}

Response

Successful response