Skip to main content
POST
/
campaigns
cURL
curl --request POST \
  --url https://my.cald.ai/client/api/v1/campaigns \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "listId": "<string>",
  "agentId": "<string>",
  "schedule": {
    "startHour": 9,
    "startMinute": 0,
    "endHour": 17,
    "endMinute": 0
  }
}
'
{
  "status": "<string>",
  "campaignId": "<string>"
}
Campaigns are specifically designed to faciliate outbound marketing efforts. They take care of automatically following-up with prospects, and can be used to send emails, text messages, and voicemails. Campaigns also ensure prospects are dialed only during business hours, based on their phone number’s area code.

Authorizations

​
Authorization
string
header
required

Your API key, e.g. caldLiveDe39a3accb206dd615f30d118e519df0

Body

application/json
​
name
string
required

The name of the campaign, it must be unique across all campaigns

​
listId
string
required

The list ID of the list to use for the campaign

​
agentId
string
required

The agent ID of the agent to use for the campaign

​
schedule
object

The schedule enables you to choose the times when your prospects will be called. Cald takes care of automatically determining the time zone based of their phone numbers' area codes, so express the times in your own time zone. The default schedule is to call between 9am and 5pm. Our end time is limited to 8 pm, to avoid calling too late in the evening, and to comply with telephone regulations.

Response

Success response with campaign details

​
status
string

Whether the campaign was successfully created, can be either success or failed

​
campaignId
string

Unique identifier for the campaign (only returned if the campaign was successfully created)