Bolna

Delete a batch. via DELETE /batches/{batch_id}

Permanently delete a disposition and remove its link to any associated agents. Regular users can only delete dispositions they own (`created_by` matches their user ID). Admins can delete any disposition. Historical call execution results already containing this disposition's output are not affected — only future calls will stop evaluating it. Deleting a category's last disposition also deletes the category itself. via DELETE /dispositions/{disposition_id}

Delete an extraction category. The category owns its dispositions, so this deletes the category **and all of its dispositions**, and detaches the category from the agent. Historical call execution results that already contain output from this category's dispositions are not affected — only future calls stop evaluating them. via DELETE /extraction-categories/{category_id}

Delete an extraction template (Admin only). via DELETE /extractions/{template_id}

Delete a knowledgebase. via DELETE /knowledgebase/{rag_id}

Delete a batch. Releases a purchased phone number permanently. (Bolna's own description of this operation reads 'Delete a batch'; the path deletes a phone number.) via DELETE /phone-numbers/{phone_number_id}

Remove provider. via DELETE /providers/{provider_key_name}

Permanently delete a SIP trunk and all associated resources (gateways, IP identifiers, phone numbers). via DELETE /sip-trunks/trunks/{trunk_id}

Remove a phone number from a SIP trunk. If the number was mapped to an agent, the mapping is also removed. via DELETE /sip-trunks/trunks/{trunk_id}/numbers/{phone_number_id}

Delete a sub-account. via DELETE /sub-accounts/{sub_account_id}

Delete a custom LLM Model along with its stored key. via DELETE /user/model/custom/{model_id}

Delete an agent. via DELETE /v2/agent/{agent_id}

Deletes a campaign. Only legal on a `draft` campaign with no entries and no executions. via DELETE /workflow-campaigns/{campaign_id}

Soft-deletes a workflow. Existing campaigns and executions are preserved for reporting. via DELETE /workflows/{workflow_id}

Retrieve specific execution by an agent. via GET /agent/{agent_id}/execution/{execution_id}

Retrieve all executions by an agent. via GET /agent/{agent_id}/executions

List the extraction categories attached to an agent. Each category is returned with the dispositions it owns. via GET /agent/{agent_id}/extraction-categories

Returns all TTS providers with their supported models for a given language. Use this to discover available providers and their model IDs before fetching voices. via GET /api/v1/voice-config/tts

Returns a paginated list of voices available for a specific TTS provider and model. Voices include both platform-curated voices and any custom voices created by your account. via GET /api/v1/voice-config/tts/voices

List all batches for agent. via GET /batches/{agent_id}/all

Retrieve a batch. via GET /batches/{batch_id}

Retrieve all executions from a batch. Returns a bare JSON array of execution objects (not wrapped in a `data` key). via GET /batches/{batch_id}/executions

List dispositions accessible to your account. When `agent_id` is provided, only dispositions linked to that agent are returned; otherwise all dispositions you own are returned. via GET /dispositions/

Retrieve a single disposition by ID, optionally scoped to a specific agent. via GET /dispositions/{disposition_id}

Retrieve specific execution by `execution_id`. via GET /executions/{execution_id}

Retrieve raw logs of specific `execution_id`. via GET /executions/{execution_id}/log

List all extraction templates. via GET /extractions/

Get a specific extraction template. via GET /extractions/{template_id}

List all knowledgebases for your account. via GET /knowledgebase/all

Retrieve a knowledgebase. via GET /knowledgebase/{rag_id}

List all phone numbers for your account. via GET /phone-numbers/all

Search available phone numbers by country and pattern. via GET /phone-numbers/search

List all providers. via GET /providers

List all SIP trunks for your account. via GET /sip-trunks/trunks

Get a single SIP trunk with full details including gateways, IP identifiers, and phone numbers. via GET /sip-trunks/trunks/{trunk_id}

List all phone numbers associated with a SIP trunk. via GET /sip-trunks/trunks/{trunk_id}/numbers

List all sub-accounts. via GET /sub-accounts/all

Retrieve usage details for all sub-accounts under the authenticated organization for up to 32 days. via GET /sub-accounts/all/usage

Track usage for the sub-account upto 32 days. via GET /sub-accounts/{sub_account_id}/usage

Get user information. via GET /user/me

List your custom LLM models. via GET /user/model/custom

List all agents. via GET /v2/agent/all

Retrieve an agent. via GET /v2/agent/{agent_id}

Retrieve all executions by an agent. via GET /v2/agent/{agent_id}/executions

Retrieve all executions from a batch with pagination support. via GET /v2/batches/{batch_id}/executions

Retrieve a paginated list of violations, optionally filtered by status. via GET /violations/list

Lists campaigns, newest first by default. via GET /workflow-campaigns

Retrieves a campaign with a count of entries per status and per-code counts of upload validation failures. via GET /workflow-campaigns/{campaign_id}

Lists a campaign's entries, including `failed_validation` rows with their failure code in `validation_error`. via GET /workflow-campaigns/{campaign_id}/entries

Returns a one-line CSV header naming the fields the campaign's pinned version declares, in author order — the exact header an entries upload expects. Falls back to the four system fields when the version declares no schema. The CSV text is returned as {'raw': '<csv>'}. via GET /workflow-campaigns/{campaign_id}/entries/template

Lists a campaign's executions. Poll after starting a campaign to watch contacts progress. via GET /workflow-campaigns/{campaign_id}/executions

Aggregated campaign report — execution counts by status, termination reasons, and a per-node funnel keyed by the node ids in your definition. via GET /workflow-campaigns/{campaign_id}/report

The whole story of one contact's run — status, every node attempt with the edge it took, and the most recent timeline events. Poll until `status` is terminal (`completed`, `failed`, `cancelled` or `aborted`). via GET /workflow-executions/{execution_id}

Lists every node type with its configuration parameters, defaults and bounds, plus the available variable namespaces and effects. Node types without an executor are returned with `available` set to `false` rather than omitted. via GET /workflow-node-types

Lists your workflows, newest first. via GET /workflows

Retrieves a workflow with its draft metadata and the metadata of every published version, including per-version campaign and outcome totals. via GET /workflows/{workflow_id}

Reads the stored draft definition and its current revision. Use it to resync the revision before a save. via GET /workflows/{workflow_id}/draft

Retrieves the frozen definition of a published version. via GET /workflows/{workflow_id}/versions/{version}

Update an extraction category. Both fields are individually optional, but at least one of `name` or `model` must be present — an empty body is rejected. Renaming a category rewrites the `category` label on all of its dispositions in the same transaction, so extraction results and disposition responses stay consistent. Changing `model` switches the LLM used for the category's extraction pass on subsequent calls. via PATCH /extraction-categories/{category_id}

Partially update an existing SIP trunk. Only included fields are changed. Gateways and ip_identifiers arrays are fully replaced when provided. via PATCH /sip-trunks/trunks/{trunk_id}

Patch update a sub-account. via PATCH /sub-accounts/{sub_account_id}

Patch update an agent. via PATCH /v2/agent/{agent_id}

Renames a workflow. `name` is the only patchable field — the definition itself is edited through the draft endpoints. via PATCH /workflows/{workflow_id}

Create an extraction category and attach it to the agent. Attaching a category gives the agent all of the category's dispositions; dispositions are added to the category via the Dispositions API using `category_id`. The category name must be unique among the agent's attached categories. The `model` applies to the category's entire extraction pass — one category is evaluated in one LLM call. via POST /agent/{agent_id}/extraction-categories

Stop a running batch. via POST /batches/{batch_id}/stop

Initiate calls. Places a REAL outbound phone call from the agent to the recipient number and spends Bolna wallet credit (a call fails with status balance-low when the wallet is empty). via POST /call

Stop a queued or scheduled call. via POST /call/{execution_id}/stop

Create a new disposition and link it to an agent. `agent_id` is required and the disposition is automatically linked to that agent upon creation. via POST /dispositions/

Atomically create and link multiple dispositions to an agent in a single request. Either all dispositions are created and linked, or none are. via POST /dispositions/bulk

Create a new extraction template (Admin only). via POST /extractions/

Add agent for inbound calls with optional IVR configuration. Real inbound calls to that number are then answered by the agent. via POST /inbound/setup

Remove agent for inbound calls. via POST /inbound/unlink

Buy a phone number. Purchases a real phone number; the Bolna account is billed for it. via POST /phone-numbers/buy

Add provider. via POST /providers

Create a new SIP trunk and register it with Bolna's media layer. via POST /sip-trunks/trunks

Add a DID phone number to a SIP trunk. via POST /sip-trunks/trunks/{trunk_id}/numbers

Creates a new sub-account. via POST /sub-accounts/create

Add a custom LLM Model. via POST /user/model/custom

Creates a new agent. via POST /v2/agent

Run all dispositions linked to the specified agent against a provided transcript and return the grouped results. Useful for validating your disposition setup before going live. via POST /v2/agent/{agent_id}/dispositions/test

Stop all queued calls for a given agent_id. via POST /v2/agent/{agent_id}/stop

Creates a campaign in `draft` status. A campaign pins one published version of one workflow at creation time — `version` `null` pins the latest published version — and the pin is immutable afterwards. via POST /workflow-campaigns

Aborts a campaign. Terminal — every execution stops before its next external action and cannot be resumed. via POST /workflow-campaigns/{campaign_id}:abort

Bulk-uploads contacts as CSV rows or a JSON array. Columns must be system fields (`reference_id`, `mobile_number`, `name`, `email`) or fields the pinned version's start node declares — an undeclared column rejects the whole upload with `422 unknown_field` before anything is persisted. Rows are then validated individually; per-row failures land in the response's `failures` array while valid rows are accepted. Offered here as the JSON array form (the text/csv upload is not). via POST /workflow-campaigns/{campaign_id}/entries

Pauses a `scheduled` or `running` campaign. No new work starts; an execution already waiting on a timer holds at its next dispatch and resumes with the campaign. via POST /workflow-campaigns/{campaign_id}:pause

Resumes a `paused` campaign. Resumes dialing real contacts. via POST /workflow-campaigns/{campaign_id}:resume

Starts dialing a batch campaign's pending entries. The campaign must be `draft` or `scheduled` and hold at least one pending entry. Idempotent — repeating the call is a no-op. Starts dialing REAL contacts and spends wallet credit. via POST /workflow-campaigns/{campaign_id}:start

Stops one execution before its next external action. Cancelling an already-terminal execution is a no-op that returns its current status. via POST /workflow-executions/{execution_id}:cancel

Creates a new workflow with an empty draft at revision `0`. Save a definition with the [Save Draft API](/api-reference/workflows/save-draft), then validate and publish it. via POST /workflows

Validates the draft and freezes it as an immutable published version, then opens a fresh draft at revision `0`. Campaigns and single runs always execute published versions, never drafts. via POST /workflows/{workflow_id}/publish

Runs one contact through the workflow's latest published version. Returns an execution you can poll with the [Get Execution API](/api-reference/workflow-executions/get). Fields declared by the start node may be passed flat at the top level or nested under `custom_fields`; a flat key wins on collision. Starts a real run: the workflow's nodes can place calls and send messages to the contact, spending wallet credit. via POST /workflows/{workflow_id}/run

Validates the saved draft without mutating anything. Issues with `severity` `error` block publish; warnings do not. via POST /workflows/{workflow_id}/validate

Update an existing disposition. All fields in the request body are optional — only fields you include are changed. When `agent_id` is provided (scoped mode), the API checks whether the disposition is exclusive to that agent: - If exclusive, it is edited in place and `200 OK` is returned. - If shared, a new private copy is created for this agent and the agent is re-linked to the copy; the original disposition is unchanged and `201 Created` is returned with the new ID. via PUT /dispositions/{disposition_id}

Update an extraction template (Admin only). via PUT /extractions/{template_id}

Update an agent. via PUT /v2/agent/{agent_id}

Saves the draft definition. `expected_revision` is a compare-and-set token — send the revision you last read; a stale value returns `409 revision_conflict` with the `current_revision`. Drafts store any well-formed JSON object; graph validation happens at validate and publish. via PUT /workflows/{workflow_id}/draft