POST
/
api
/
v1
/
outbound
/
campaigns
import os
from syllable_sdk import SyllableSDK


with SyllableSDK(
    api_key_header=os.getenv("SYLLABLESDK_API_KEY_HEADER", ""),
) as ss_client:

    res = ss_client.outbound.campaigns.create(request={
        "campaign_name": "Outbound Campaign 1",
        "description": "This is a test campaign",
        "label": "test",
        "campaign_variables": {},
        "daily_start_time": "09:00:00",
        "daily_end_time": "17:00:00",
        "timezone": "America/New_York",
        "source": "account@email.com",
        "caller_id": "19995551234",
        "retry_interval": "12h",
        "pause_seconds": 30,
    })

    # Handle response
    print(res)
{
  "campaign_name": "Outbound Campaign 1",
  "description": "This is a test campaign",
  "label": "test",
  "campaign_variables": {
    "key": "value",
    "key2": "value2"
  },
  "daily_start_time": "09:00:00",
  "daily_end_time": "17:00:00",
  "timezone": "America/New_York",
  "source": "+19032900844",
  "caller_id": 19995551234,
  "rate": 5,
  "retry_count": 1,
  "retry_interval": "30m",
  "pause_seconds": 30,
  "id": 1,
  "created_at": "2025-04-09T00:00:00Z",
  "updated_at": "2025-04-09T00:00:00Z",
  "last_updated_by": "user@email.com"
}

Authorizations

​
Syllable-API-Key
string
header
required

Body

application/json
​
campaign_name
string
required

Human readable name of campaign

Example:

"Outbound Campaign 1"

​
campaign_variables
object
required

Variables for campaign

Example:
{ "key": "value", "key2": "value2" }
​
daily_start_time
string
required

Start time of campaign each day

Example:

"09:00:00"

​
daily_end_time
string
required

End time of campaign each day

Example:

"17:00:00"

​
timezone
string
required

Timezone of campaign

Example:

"America/New_York"

​
caller_id
string | null
required

Caller ID for call

Example:

19995551234

​
description
string | null

Description of campaign

Example:

"This is a test campaign"

​
label
string | null

Label for campaign

Example:

"test"

​
source
string | null

Source phone number, email, or SMS number

Example:

"+19032900844"

​
rate
integer
default:1

Target number of outreach calls per minute

Example:

5

​
retry_count
integer
default:0

Number of retries per target

Example:

1

​
retry_interval
string | null

How long to wait before retrying

Example:

"30m"

​
pause_seconds
integer | null

How many seconds to pause between queueing calls. Useful when rate should be less than 1 per minute

Example:

30

Response

200
application/json
Successful Response
​
campaign_name
string
required

Human readable name of campaign

Example:

"Outbound Campaign 1"

​
campaign_variables
object
required

Variables for campaign

Example:
{ "key": "value", "key2": "value2" }
​
daily_start_time
string
required

Start time of campaign each day

Example:

"09:00:00"

​
daily_end_time
string
required

End time of campaign each day

Example:

"17:00:00"

​
timezone
string
required

Timezone of campaign

Example:

"America/New_York"

​
caller_id
string | null
required

Caller ID for call

Example:

19995551234

​
id
integer
required

Unique ID for campaign

Example:

1

​
last_updated_by
string
required

Email of user who last updated campaign

Example:

"user@email.com"

​
description
string | null

Description of campaign

Example:

"This is a test campaign"

​
label
string | null

Label for campaign

Example:

"test"

​
source
string | null

Source phone number, email, or SMS number

Example:

"+19032900844"

​
rate
integer
default:1

Target number of outreach calls per minute

Example:

5

​
retry_count
integer
default:0

Number of retries per target

Example:

1

​
retry_interval
string | null

How long to wait before retrying

Example:

"30m"

​
pause_seconds
integer | null

How many seconds to pause between queueing calls. Useful when rate should be less than 1 per minute

Example:

30

​
created_at
string

Timestamp of campaign creation

Example:

"2025-04-09T00:00:00Z"

​
updated_at
string

Timestamp of campaign update

Example:

"2025-04-09T00:00:00Z"