Add Campaign Data (Token Authentication)

post

https://{domainname}/ca_apis/AddCampaignData

Adds campaign data, including campaign details and associated metadata.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

campaignName

string

required

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

phoneNumber

string

required

The phone number to be added.

name

string

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

action

string

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

skill

string

Associated skill name.

priority

integer

1 to 99

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

agentId

string

Agent ID, if agent-wise campaign.

expiryDate

date-time

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

checkDuplicate

boolean

Pass true to check for duplicate phone numbers.

userName

string

required

Your CloudAgent account username.

skipNameFieldValidation

boolean

Pass true, to skip name field validation.

CustomFields1

string

Custom field 1 for additional data.

CustomFields2

string

Custom field 2 for additional data.

CustomFields3

string

Custom field 3 for additional data.

Headers

Content-Type

string

required

Should be set to application/json.

Response

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response