Create Campaign - Tabbly Docs

Request

integer

required

Your organization ID

string

required

Your organization API key

string

required

Name for the campaign

integer

required

ID of the agent to use for the campaign

string

required

Source phone number in E.164 format

array

required

Array of contact objects with phone numbers and optional custom data

string

Scheduled start time for the campaign (ISO 8601 format). If not provided, starts immediately.

integer

default:"60"

Maximum number of calls to make per hour

integer

default:"2"

Number of retry attempts for failed calls

integer

default:"3600"

Delay between retry attempts in seconds

Contact Object

string

required

Destination phone number in E.164 format

string

Custom first line for this specific contact

string

Custom instructions for this specific contact

string

Custom identifier for mapping back to your system

Examples

curl -X POST 'https://www.tabbly.io/dashboard/agents/endpoints/create-campaign' \
-H 'Content-Type: application/json' \
-d '{
    "organization_id": 244,
    "api_key": "your_api_key",
    "campaign_name": "January Follow-up Campaign",
    "agent_id": 33,
    "call_from": "+14156801215",
    "contacts": [
        {
            "phone_number": "+917359056097",
            "custom_first_line": "Hello, I am calling from Company XYZ",
            "custom_instruction": "John'\''s Order ID is 12345",
            "custom_identifiers": "user_12345"
        },
        {
            "phone_number": "+917359056098",
            "custom_first_line": "Hello, I am calling from Company XYZ",
            "custom_instruction": "Jane'\''s Order ID is 12346",
            "custom_identifiers": "user_12346"
        }
    ],
    "calls_per_hour": 60,
    "retry_attempts": 2
}'

import requests

data = {
    'organization_id': 244,
    'api_key': 'your_api_key',
    'campaign_name': 'January Follow-up Campaign',
    'agent_id': 33,
    'call_from': '+14156801215',
    'contacts': [
        {
            'phone_number': '+917359056097',
            'custom_first_line': 'Hello, I am calling from Company XYZ',
            'custom_instruction': 'John\'s Order ID is 12345',
            'custom_identifiers': 'user_12345'
        },
        {
            'phone_number': '+917359056098',
            'custom_first_line': 'Hello, I am calling from Company XYZ',
            'custom_instruction': 'Jane\'s Order ID is 12346',
            'custom_identifiers': 'user_12346'
        }
    ],
    'calls_per_hour': 60,
    'retry_attempts': 2
}

response = requests.post(
    'https://www.tabbly.io/dashboard/agents/endpoints/create-campaign',
    json=data
)

print(response.json())

const axios = require('axios');

const data = {
    organization_id: 244,
    api_key: 'your_api_key',
    campaign_name: 'January Follow-up Campaign',
    agent_id: 33,
    call_from: '+14156801215',
    contacts: [
        {
            phone_number: '+917359056097',
            custom_first_line: 'Hello, I am calling from Company XYZ',
            custom_instruction: 'John\'s Order ID is 12345',
            custom_identifiers: 'user_12345'
        },
        {
            phone_number: '+917359056098',
            custom_first_line: 'Hello, I am calling from Company XYZ',
            custom_instruction: 'Jane\'s Order ID is 12346',
            custom_identifiers: 'user_12346'
        }
    ],
    calls_per_hour: 60,
    retry_attempts: 2
};

axios.post('https://www.tabbly.io/dashboard/agents/endpoints/create-campaign', data)
    .then(response => console.log(response.data))
    .catch(error => console.error(error));

Response

boolean

Indicates if the campaign was successfully created

integer

ID of the newly created campaign

string

Name of the created campaign

string

Status of the campaign (scheduled, running, paused, completed)

integer

Total number of contacts in the campaign

Success Response (200 OK)

{
    "success": true,
    "campaign_id": 12,
    "campaign_name": "January Follow-up Campaign",
    "status": "scheduled",
    "total_contacts": 2
}

Error Responses

object

Missing required fields or invalid parameters

object

Insufficient wallet balance

object

Organization/Agent not found or invalid call_from number

object

Server error

​Request

​Contact Object

​Examples

​Response

​Success Response (200 OK)

​Error Responses

Request

Contact Object

Examples

Response

Success Response (200 OK)

Error Responses