Resume a paused campaign

POST

/v1/campaigns/{campaign_id}/resume

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

Authorizations

• HTTPBearer

Parameters

Path Parameters

campaign_id

required

Campaign Id

string

Responses

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

string

null

null

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

string

null

null

scrub_run_id

Any of:

string

string

null

null

max_attempts_per_contact

required

Max Attempts Per Contact

integer

concurrency_cap

Any of:

integer

integer

null

null

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

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

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example",
      "input": "example",
      "ctx": {}
    }
  ]
}