Create campaign

POST

/api/v1/campaigns

curl --request POST \
  --url https://api.pitch2sale.com/api/v1/campaigns \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "voice_agent_id": "example", "from_number_id": "example", "target_type": "smart_view", "smart_view_id": "example", "lead_ids": [ "example" ], "max_concurrent_calls": 1, "calls_per_minute": 1, "quiet_hours": { "start_hour": 1, "end_hour": 1 }, "respect_dnc": true, "purpose": "marketing", "adaptive_pacing": true, "abandonment_warning_threshold": 1, "abandonment_pause_threshold": 1 }'

Authorizations

• bearerJwt
• personalAccessToken
• oauthAccessToken

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 200 characters

voice_agent_id

required

string

/^[0-9a-fA-F]{24}$/

from_number_id

required

string

/^[0-9a-fA-F]{24}$/

target_type

required

string

Allowed values: smart_view static

smart_view_id

Any of:

string

string

/^[0-9a-fA-F]{24}$/

null

null

lead_ids

Array<string>

max_concurrent_calls

integer

>= 1 <= 50

calls_per_minute

integer

>= 1 <= 120

quiet_hours

object

start_hour

required

integer

<= 23

end_hour

required

integer

<= 24

respect_dnc

boolean

purpose

string

default: marketing

Allowed values: marketing informational transactional

adaptive_pacing

boolean

abandonment_warning_threshold

number

<= 0.03

abandonment_pause_threshold

number

<= 0.03

Responses

201

Created

400

Validation failed

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

401

Authentication required or token invalid

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

402

Feature not available on the organization plan

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

403

Role permission or token scope missing

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}

429

Rate limit exceeded

Media typeapplication/json

object

error

required

string

code

string

message

string

details

Array<object>

object

field

required

string

message

required

string

code

required

string

Example^generated

{
  "error": "example",
  "code": "example",
  "message": "example",
  "details": [
    {
      "field": "example",
      "message": "example",
      "code": "example"
    }
  ]
}