Skip to main content
POST
Create a new Quick Campaign

Authorizations

api_key
string
header
required

Headers

Company-Name
string
required

The name of the schema to be used for the request

Body

application/json
name
string
required

Name of the quick campaign

Example:

"Quick Follow-up Campaign"

new_agent
integer
required

ID of the AI agent assigned to the campaign

Example:

123

calling_number
string
required

Phone number used for outbound calls

Example:

"+18446020950"

enable_number_rotation
boolean
required

Whether number rotation is enabled

Example:

false

direction
enum<string>
required

Call direction

Available options:
Outbound,
Inbound
Example:

"Outbound"

number_dict
object

Whether number rotation is enabled

Example:

Response

Quick Campaign created successfully

success
boolean

Indicates whether the quick campaign was created successfully

Example:

true

message
string

A message confirming the status of the quick campaign creation

Example:

"quick campaign created"

data
object