Launch a campaign, pinning the agent version it dials under

POST

/v1/campaigns/{campaign_id}/launch

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

Authorizations

• HTTPBearer

Parameters

Path Parameters

campaign_id

required

Campaign Id

string

Header Parameters

Idempotency-Key

required

string

<= 255 characters

Unique key for this request, so a retry replays the original result instead of repeating the work. Stored for 24 hours; a replayed response carries Idempotent-Replay: true. A UUID is the documented shape. Required on this endpoint: a retry without one would dial a human twice or spend money twice.

Responses

200

Successful Response

Media typeapplication/json

CampaignLaunchResponse

What a launch accepted, and how many contacts it may dial.

object

status

required

CampaignStatus

string

Allowed values: draft scrubbing ready running paused completed cancelled

dialable_contacts

required

Dialable Contacts

integer

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": {}
    }
  ]
}