Skip to content
Vocapable Developers

Stop launching new dials

POST
/v1/campaigns/{campaign_id}/pause
curl --request POST \
  --url https://api.vocapable.com/v1/campaigns/example/pause \
  --header 'Authorization: Bearer <token>'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
campaign_id
required
Campaign Id
string

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
CampaignSummary

A campaign as a list endpoint returns it, counters included.

object
id
required
Id
string
name
required
Name
string
status
required
CampaignStatus
string
Allowed values: draft scrubbing ready running paused completed cancelled
agent_definition_id
required
Agent Definition Id
string
agent_version_id
Any of:
string
target
required
CampaignTarget

V1 campaigns target a contact list; a segment_id target joins at P2.

object
contact_list_id
required
Contact List Id
string
number_pool_id
required
Number Pool Id
string
telephony_account_id
required
Telephony Account Id
string
compliance_profile_id
Any of:
string
scrub_run_id
Any of:
string
max_attempts_per_contact
required
Max Attempts Per Contact
integer
concurrency_cap
Any of:
integer
contacts_total
required
Contacts Total
integer
dialed
required
Dialed
integer
connected
required
Connected
integer
completed_goal
required
Completed Goal
integer
created_at
required
Created At
string format: date-time
updated_at
required
Updated At
string format: date-time
Example
{
  "status": "draft"
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}