> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Bolna

> Create conversational voice agents using Bolna AI to enhance interactions, streamline operations and automate support.

![Bolna logo](https://mintcdn.com/composio-preview/6S5R4NszqpnVIZRD/images/toolkits/bolna.svg?fit=max\&auto=format\&n=6S5R4NszqpnVIZRD\&q=85\&s=5808773cfcde06a71e0bf93170fd5ec6)

* **Category:** ai agents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 102
* **Triggers:** 0
* **Slug:** `BOLNA`
* **Version:** 20261101\_00

## Tools

> [accordion] Abort workflow campaign
>
> **Slug:** `BOLNA_ABORT_WORKFLOW_CAMPAIGN`
>
> Move a running or paused campaign to the terminal aborted state and stop its executions. Campaign flow is draft -> running \<-> paused -> aborted; aborted campaigns cannot resume or be deleted.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to terminate permanently.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add custom LLM model
>
> **Slug:** `BOLNA_ADD_CUSTOM_LLM_MODEL`
>
> Register an OpenAI-compatible custom LLM endpoint with Bolna.
>
> #### Input Parameters
>
> **custom\_model\_key** `string` *required*
>
> Bearer token for the custom endpoint; Bolna stores it encrypted.
>
> **custom\_model\_url** `string` *required*
>
> Public OpenAI-compatible base URL, including its version segment.
>
> **custom\_model\_name** `string` *required*
>
> Model ID served by the custom endpoint; Bolna passes it through unchanged.
>
> **custom\_model\_family** `string` *required*
>
> Model family, such as qwen, llama, or mistral.
>
> **custom\_model\_languages** `string`
>
> Optional comma-separated language codes. Bolna defaults this to en.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Provider to Bolna
>
> **Slug:** `BOLNA_ADD_PROVIDER`
>
> Tool to add a new telephony or voice service provider to your Bolna account. Use when you need to configure API keys for providers like Twilio, Deepgram, or ElevenLabs before creating agents.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User ID to associate the provider with. Optional.
>
> **provider\_name** `string` *required*
>
> Name of the telephony or voice service provider to add (e.g., 'twilio', 'deepgram', 'elevenlabs')
>
> **is\_api\_request** `boolean`
>
> Flag indicating if this is an API request. Defaults to false.
>
> **provider\_value** `string` *required*
>
> API key or authentication value for the provider
>
> **sub\_account\_id** `string`
>
> Sub-account ID to associate the provider with. Optional.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add number to SIP trunk
>
> **Slug:** `BOLNA_ADD_TRUNK_NUMBER`
>
> Add a DID phone number to a SIP trunk.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional human-readable label for the phone number.
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk.
>
> **phone\_number** `string` *required*
>
> DID phone number to register on the trunk.
>
> **e164\_check\_enabled** `boolean`
>
> Whether Bolna should enforce E.164 validation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Bulk create dispositions
>
> **Slug:** `BOLNA_BULK_CREATE_DISPOSITIONS`
>
> Atomically create multiple dispositions linked to one agent.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Agent to link every new disposition to.
>
> **dispositions** `array` *required*
>
> One or more dispositions to create atomically.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Buy phone number
>
> **Slug:** `BOLNA_BUY_PHONE_NUMBER`
>
> Purchase an available phone number in the US or India with a recurring account charge.
>
> #### Input Parameters
>
> **country** `string ("US" | "IN")` *required*
>
> Country in which to purchase the number.
>
> **provider** `string ("twilio" | "plivo" | "vobiz")`
>
> Preferred telephony provider.
>
> **phone\_number** `string` *required*
>
> Phone number to purchase in E.164 format.
>
> **compliance\_application\_id** `string`
>
> Approved compliance application ID to use for the purchase.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Cancel workflow execution
>
> **Slug:** `BOLNA_CANCEL_WORKFLOW_EXECUTION`
>
> Stop one workflow execution before its next external action.
>
> #### Input Parameters
>
> **reason** `string`
>
> Free-form reason to record on the cancellation.
>
> **execution\_id** `string` *required*
>
> ID of the workflow execution to cancel.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Copy Bolna Agent
>
> **Slug:** `BOLNA_COPY_AGENT`
>
> Tool to create a duplicate copy of an existing Bolna voice AI agent. Use when you need to replicate an agent's complete configuration (tasks, prompts, LLM settings, etc.) with a new name.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user identifier to associate the copied agent with a specific user
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID) of the existing Bolna agent to copy
>
> **agent\_name** `string` *required*
>
> The name for the new copied agent. This will be the display name of the duplicated agent.
>
> **is\_api\_request** `boolean`
>
> Flag to indicate if this is an API request. Defaults to false if not provided.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bolna Voice AI Agent (v2)
>
> **Slug:** `BOLNA_CREATE_AGENT`
>
> Tool to create a new Bolna Voice AI agent using the v2 API. Use when you need to set up a new conversational agent from scratch with custom LLM, synthesizer, transcriber, and task configurations. This fills the gap for end-to-end agent setup in workflows starting from an empty account state.
>
> #### Input Parameters
>
> **agent\_config** `object` *required*
>
> Complete agent configuration object. Required fields: agent\_name (string), agent\_type (string: 'other', 'sales', 'support', etc.), agent\_welcome\_message (string), webhook\_url (string URL for callbacks), and tasks (array). Each task must include task\_type ('conversation', 'extraction', or 'summarization'), toolchain (with execution mode and pipelines), tools\_config (defining input/output providers, transcriber, llm\_agent, and synthesizer), and task\_config (with settings like hangup\_after\_silence).
>
> **agent\_prompts** `object` *required*
>
> Object containing prompt configurations for each task. Each task key (e.g., 'task\_1', 'task\_2') maps to an object with a 'system\_prompt' string that defines behavioral instructions for that task.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bolna Batch
>
> **Slug:** `BOLNA_CREATE_BATCH`
>
> Tool to create a new outbound calling batch by uploading a CSV of contacts to obtain a batch\_id. Use real, allocatable E.164 numbers; trial accounts can call only phone numbers verified with Bolna. Follow with BOLNA\_SCHEDULE\_BATCH\_BY\_ID to schedule execution.
>
> #### Input Parameters
>
> **file** `object` *required*
>
> CSV file containing real, allocatable E.164 contact numbers and prompt variables. Reserved or fictional ranges such as 555 numbers are rejected; trial accounts may call only verified phone numbers.
>
> **agent\_id** `string` *required*
>
> The ID of the agent (UUID format) to use for the batch calling campaign
>
> **from\_phone\_number** `string`
>
> Phone number in E.164 format (e.g., '+19876543007') to use as the caller ID when initiating batch calls. If not provided, system defaults will be used.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create disposition
>
> **Slug:** `BOLNA_CREATE_DISPOSITION`
>
> Create a structured transcript extraction disposition linked to an agent.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable disposition name.
>
> **model** `string`
>
> Model used to evaluate the disposition.
>
> **agent\_id** `string` *required*
>
> Agent to link the new disposition to.
>
> **category** `string`
>
> Legacy category name. Pass either category or category\_id, not both.
>
> **question** `string` *required*
>
> Extraction question evaluated against call transcripts.
>
> **category\_id** `string`
>
> Existing extraction category ID. Pass either category\_id or category, not both.
>
> **is\_objective** `boolean`
>
> Whether the disposition selects from objective\_options. Set true with objective\_options such as \[\{"value":"yes","condition":"The caller agreed"}].
>
> **is\_subjective** `boolean`
>
> Whether the disposition produces a free-form value.
>
> **system\_prompt** `string`
>
> Optional system prompt for this extraction.
>
> **subjective\_type** `string ("text" | "timestamp" | "numeric" | "boolean" | "email" | "regex")`
>
> Expected subjective output type.
>
> **objective\_options** `array`
>
> Allowed objective classification options, for example \[\{"value":"yes","condition":"The caller agreed"}]; set is\_objective=true.
>
> **subjective\_type\_config** `object`
>
> Configuration for the subjective output type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create extraction category
>
> **Slug:** `BOLNA_CREATE_EXTRACTION_CATEGORY`
>
> Create an extraction category on an agent.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Category name, unique among the agent's categories.
>
> **model** `string` *required*
>
> Model used for the category's extraction pass.
>
> **agent\_id** `string` *required*
>
> Agent to attach the extraction category to.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Bolna Knowledgebase
>
> **Slug:** `BOLNA_CREATE_KNOWLEDGEBASE`
>
> Tool to create a new knowledgebase for Voice AI agents to reference during conversations. Use when you need to provide agents with domain-specific knowledge from PDFs or web URLs. Note: Initially returns status 'processing'; poll or wait for status to become 'processed' before use.
>
> #### Input Parameters
>
> **url** `string`
>
> URL to ingest as the knowledgebase source (e.g., '[https://example.com/documentation](https://example.com/documentation)'). Either 'url' or 'file' must be provided, but not both. Use this for web-based content.
>
> **file** `object`
>
> PDF file to upload as the knowledgebase source. Either 'file' or 'url' must be provided, but not both.
>
> **user\_id** `string`
>
> Optional user identifier to associate with this knowledgebase
>
> **chunk\_size** `integer`
>
> Size of text chunks to split the content into for vector embeddings. Larger chunks preserve more context but may reduce retrieval precision. Typical values: 200-1000.
>
> **overlapping** `integer`
>
> Number of characters to overlap between consecutive chunks. Overlapping helps preserve context across chunk boundaries. Typical values: 50-200.
>
> **is\_api\_request** `boolean`
>
> Internal flag to indicate if this is an API request. Typically not needed by end users.
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier for multi-tenant environments
>
> **similarity\_top\_k** `integer`
>
> Number of most similar chunks to retrieve during agent queries. Higher values provide more context but may include less relevant information. Typical values: 1-10.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create SIP trunk
>
> **Slug:** `BOLNA_CREATE_SIP_TRUNK`
>
> Create a bring-your-own-telephony SIP trunk.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Human-readable name for the SIP trunk.
>
> **allow** `string`
>
> Comma-separated codecs to allow.
>
> **disallow** `string`
>
> Comma-separated codecs to disallow.
>
> **gateways** `array` *required*
>
> One or more ordered SIP gateways.
>
> **provider** `string` *required*
>
> SIP provider name, such as twilio, telnyx, or custom.
>
> **auth\_type** `string ("userpass" | "ip-based")` *required*
>
> Authentication method for the trunk.
>
> **transport** `string ("transport-udp" | "transport-tcp" | "transport-tls")`
>
> SIP transport protocol.
>
> **description** `string`
>
> Optional internal description of the trunk.
>
> **force\_rport** `boolean`
>
> Whether to force responses to the source port.
>
> **direct\_media** `boolean`
>
> Whether RTP should flow directly between endpoints.
>
> **auth\_password** `string`
>
> SIP password, required for userpass authentication.
>
> **auth\_username** `string`
>
> SIP username, required for userpass authentication.
>
> **phone\_numbers** `array`
>
> DID phone numbers to register during creation.
>
> **rtp\_symmetric** `boolean`
>
> Whether to enable symmetric RTP for NAT traversal.
>
> **ip\_identifiers** `array`
>
> Allowed IP addresses, required for IP-based authentication.
>
> **inbound\_enabled** `boolean`
>
> Whether inbound calls are enabled.
>
> **media\_encryption** `string ("no" | "sdes")`
>
> RTP encryption mode; sdes requires TLS transport.
>
> **qualify\_frequency** `integer`
>
> SIP OPTIONS ping interval in seconds; use 0 to disable.
>
> **media\_encryption\_optimistic** `boolean`
>
> Whether encrypted media may fall back to clear RTP.
>
> **outbound\_leading\_plus\_enabled** `boolean`
>
> Whether outbound numbers receive a leading plus sign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create sub-account
>
> **Slug:** `BOLNA_CREATE_SUB_ACCOUNT`
>
> Create an enterprise sub-account with its own concurrency limits and API key.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name of the new sub-account.
>
> **db\_host** `string`
>
> Database host for a multi-tenant sub-account.
>
> **db\_name** `string`
>
> Database name for a multi-tenant sub-account.
>
> **db\_port** `string`
>
> Database port for a multi-tenant sub-account.
>
> **db\_user** `string`
>
> Database root user for a multi-tenant sub-account.
>
> **db\_password** `string`
>
> Database root password for a multi-tenant sub-account.
>
> **multi\_tenant** `boolean`
>
> Whether the sub-account uses a separate database.
>
> **max\_concurrency** `integer`
>
> Optional hard concurrency cap; 0 pauses the sub-account.
>
> **min\_concurrency** `integer` *required*
>
> Guaranteed concurrency reserved for the sub-account; 0 means no guarantee.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create Template Agent
>
> **Slug:** `BOLNA_CREATE_TEMPLATE_AGENT`
>
> \[DEPRECATED] Attempt to create an agent through Bolna's undocumented template endpoint. Use BOLNA\_CREATE\_AGENT for current integrations.
>
> #### Input Parameters
>
> **prompt** `string`
>
> System prompt or instructions that define the agent's behavior and responses. This guides how the agent interacts with users.
>
> **user\_id** `string`
>
> Optional user ID to associate with the template agent
>
> **agent\_name** `string`
>
> Name for the template agent being created. This will identify the agent in the system.
>
> **agent\_type** `string`
>
> Type or category of the agent template. Specifies the functional role of the agent (e.g., 'support', 'sales', 'other').
>
> **transcript** `boolean`
>
> Flag indicating whether to enable transcript recording for this agent. Set to true to capture conversation transcripts.
>
> **business\_name** `string`
>
> Name of the business for which the template agent is being created
>
> **return\_prompt** `boolean`
>
> Flag indicating whether to return the generated prompt in the response. Set to true to receive the prompt back after agent creation.
>
> **variable\_dict** `object`
>
> Dictionary of custom variables that can be used in the agent template. Allows dynamic substitution of values in prompts and configurations. Keys and values should be strings.
>
> **about\_business** `string`
>
> Description of the business for which the agent template is being created. Provides context about the business domain and purpose.
>
> **is\_api\_request** `string`
>
> Optional flag indicating if this is an API request. Accepts string representation of boolean (e.g., 'true', 'false'). Default is 'false' if not provided.
>
> **template\_agent** `string`
>
> Identifier or name of the base template to use for agent creation. References a predefined agent template.
>
> **service\_details** `string`
>
> Details about the services offered by the business. Helps the agent understand what services it can discuss with customers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create workflow
>
> **Slug:** `BOLNA_CREATE_WORKFLOW`
>
> Create an empty, unpublished workflow and return its identifier.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Name for the new workflow.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Create workflow campaign
>
> **Slug:** `BOLNA_CREATE_WORKFLOW_CAMPAIGN`
>
> Create a draft campaign pinned to a published workflow version.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> Campaign display name.
>
> **binding** `object`
>
> Per-campaign agent and phone-number mapping overrides.
>
> **version** `integer`
>
> Published workflow version to pin; omit to pin the latest.
>
> **workflow\_id** `string` *required*
>
> ID of the workflow to run.
>
> **scheduled\_at** `string`
>
> Timezone-aware ISO 8601 time at which to start the campaign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete agent by id
>
> **Slug:** `BOLNA_DELETE_AGENT_BY_ID`
>
> Permanently delete a Voice AI agent and all associated data including batches, executions, and configurations
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Unique identifier (UUID) of the agent to delete. WARNING: This will permanently delete ALL agent data including all batches, executions, and configurations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete batch by id
>
> **Slug:** `BOLNA_DELETE_BATCH_BY_ID`
>
> Permanently delete a batch campaign by its ID, removing it from the system. This operation cannot be undone.
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> Unique identifier (UUID format) of the batch to delete. This will permanently remove the batch and cannot be undone.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete custom LLM model
>
> **Slug:** `BOLNA_DELETE_CUSTOM_LLM_MODEL`
>
> Delete a custom LLM model and its stored endpoint key from Bolna.
>
> #### Input Parameters
>
> **model\_id** `string` *required*
>
> Identifier of the custom model to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete disposition
>
> **Slug:** `BOLNA_DELETE_DISPOSITION`
>
> Permanently delete a disposition without changing past call results.
>
> #### Input Parameters
>
> **disposition\_id** `string` *required*
>
> Disposition ID to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete extraction category
>
> **Slug:** `BOLNA_DELETE_EXTRACTION_CATEGORY`
>
> Permanently delete an extraction category and every disposition inside it.
>
> #### Input Parameters
>
> **category\_id** `string` *required*
>
> Extraction category ID to permanently delete with its dispositions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete Knowledgebase
>
> **Slug:** `BOLNA_DELETE_KNOWLEDGEBASE`
>
> Tool to permanently delete a knowledgebase from your Bolna account. Use when you need to remove an existing RAG knowledgebase that is no longer needed. This operation cannot be undone.
>
> #### Input Parameters
>
> **rag\_id** `string` *required*
>
> Unique identifier (UUID format) of the knowledgebase to delete. This will permanently remove the knowledgebase and cannot be undone.
>
> **user\_id** `string`
>
> Optional user identifier to scope the deletion operation to a specific user account
>
> **is\_api\_request** `string`
>
> Flag indicating whether this is an API request. Typically omitted or set to false for standard operations
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier for multi-tenant or organization scenarios
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete phone number
>
> **Slug:** `BOLNA_DELETE_PHONE_NUMBER`
>
> Permanently release a purchased phone number and stop recurring billing.
>
> #### Input Parameters
>
> **phone\_number\_id** `string` *required*
>
> ID of the purchased phone number to release.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete SIP trunk
>
> **Slug:** `BOLNA_DELETE_SIP_TRUNK`
>
> Permanently delete a SIP trunk and its gateways, IP identifiers, and numbers.
>
> #### Input Parameters
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete sub-account
>
> **Slug:** `BOLNA_DELETE_SUB_ACCOUNT`
>
> Permanently delete a sub-account and all of its data.
>
> #### Input Parameters
>
> **sub\_account\_id** `string` *required*
>
> Unique identifier of the sub-account to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete workflow
>
> **Slug:** `BOLNA_DELETE_WORKFLOW`
>
> Permanently delete a workflow, its draft, and all published versions.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to permanently delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete workflow campaign
>
> **Slug:** `BOLNA_DELETE_WORKFLOW_CAMPAIGN`
>
> Permanently delete an empty campaign only while it is draft or scheduled. Running, paused, aborted, and implicit campaigns created by RUN\_WORKFLOW cannot be deleted.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the empty draft campaign to delete.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Fetch all batches by agent id
>
> **Slug:** `BOLNA_FETCH_ALL_BATCHES_BY_AGENT_ID`
>
> Retrieve all batches associated with a specific Bolna Voice AI agent. Returns a comprehensive list of batches with details including batch status (scheduled, created, queued, executed), creation and scheduled times, contact counts, file names, and execution status breakdown. Use this to monitor batch campaigns, track their progress, and manage outbound calling operations for the agent.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID) of the Bolna Voice AI agent whose batches you want to retrieve
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Agent (v1 - Deprecated)
>
> **Slug:** `BOLNA_GET_AGENT_V1`
>
> \[DEPRECATED] Retrieve Voice AI agent details using the v1 API endpoint. Use GET /v2/agent/\{agent\_id} (retrieve\_agent\_by\_id) instead for current implementations. This action returns agent configuration including name, type, status, tasks, and prompts.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user identifier to filter agents by user ownership.
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID) of the Bolna voice agent to retrieve. You can get valid agent IDs from the get\_all\_agents action.
>
> **is\_api\_request** `string`
>
> Flag indicating if this is an API request. Defaults to false if not provided.
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier for multi-tenant scenarios.
>
> **agent\_version\_id** `string`
>
> Optional version identifier to retrieve a specific version of the agent.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all agents
>
> **Slug:** `BOLNA_GET_ALL_AGENTS`
>
> Retrieve all agents configured in your Bolna account Returns a comprehensive list of all voice agents with their configurations including: - Agent metadata (ID, name, type, status) - Task configurations (conversation settings, toolchains) - AI model settings (LLM, transcriber, synthesizer) - Webhook and phone number assignments - System prompts and guardrails This is useful for listing available agents, checking agent configurations, or finding specific agents by their properties.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get all sub-accounts usage
>
> **Slug:** `BOLNA_GET_ALL_SUB_ACCOUNTS_USAGE`
>
> Retrieve usage and cost breakdowns for every organization sub-account.
>
> #### Input Parameters
>
> **to** `string`
>
> Optional ISO 8601 UTC end timestamp; defaults to the end of the current day.
>
> **from** `string`
>
> Optional ISO 8601 UTC start timestamp; defaults to the start of the current month.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get disposition
>
> **Slug:** `BOLNA_GET_DISPOSITION`
>
> Retrieve one disposition, optionally requiring an agent link.
>
> #### Input Parameters
>
> **agent\_id** `string`
>
> Agent ID that the disposition must be linked to, when provided.
>
> **disposition\_id** `string` *required*
>
> Disposition ID to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get execution by id
>
> **Slug:** `BOLNA_GET_EXECUTION_BY_ID`
>
> Retrieve detailed information about a specific phone call execution by its ID. Returns comprehensive execution data including conversation transcript, duration, costs (LLM, TTS, STT, network, platform), telephony details (phone numbers, recording URL, provider info), usage metrics (tokens, characters, duration), and extracted structured data. Use this to: - Analyze individual call performance and outcomes - Access conversation transcripts and recordings - Review cost breakdowns and resource usage - Monitor call status and error messages - Retrieve extracted structured data from conversations
>
> #### Input Parameters
>
> **execution\_id** `string` *required*
>
> The unique execution identifier (UUID format, e.g., '4c06b4d1-4096-4561-919a-4f94539c8d4a')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get execution raw logs
>
> **Slug:** `BOLNA_GET_EXECUTION_RAW_LOGS`
>
> Retrieve raw transcriber, LLM, synthesizer, and telephony logs for a call.
>
> #### Input Parameters
>
> **execution\_id** `string` *required*
>
> ID of the call execution whose logs to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get knowledgebase by ID
>
> **Slug:** `BOLNA_GET_KNOWLEDGEBASE`
>
> Tool to retrieve details of a specific knowledgebase by its ID. Returns complete configuration including processing status, file information, vector ID, and embedding parameters (chunk size, similarity top k, overlapping). Use when you need to check if a knowledgebase has finished processing or to inspect its configuration before using it with an agent.
>
> #### Input Parameters
>
> **rag\_id** `string` *required*
>
> The unique identifier (UUID) of the knowledgebase to retrieve
>
> **user\_id** `string`
>
> Optional user ID for filtering knowledgebase access
>
> **is\_api\_request** `boolean`
>
> Flag indicating if this is an API request
>
> **sub\_account\_id** `string`
>
> Optional sub-account ID for multi-tenant scenarios
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get SIP trunk
>
> **Slug:** `BOLNA_GET_SIP_TRUNK`
>
> Retrieve full details of one SIP trunk.
>
> #### Input Parameters
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get sub-account usage
>
> **Slug:** `BOLNA_GET_SUB_ACCOUNT_USAGE`
>
> Retrieve one sub-account's usage and cost breakdown for up to 32 days.
>
> #### Input Parameters
>
> **to** `string`
>
> Optional ISO 8601 UTC end timestamp; defaults to the end of the current day.
>
> **from** `string`
>
> Optional ISO 8601 UTC start timestamp; defaults to the start of the current month.
>
> **sub\_account\_id** `string` *required*
>
> Unique identifier of the sub-account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get User Information
>
> **Slug:** `BOLNA_GET_USER_INFO`
>
> Tool to retrieve information about the authenticated user. Use when you need details like name, email, wallet balance, or concurrency limits for the current user.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user ID to fetch information for a specific user
>
> **is\_api\_request** `boolean`
>
> Flag to indicate if this is an API request
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow
>
> **Slug:** `BOLNA_GET_WORKFLOW`
>
> Retrieve workflow status, live settings, and version history.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow campaign
>
> **Slug:** `BOLNA_GET_WORKFLOW_CAMPAIGN`
>
> Retrieve a campaign with entry-status and validation-error counts.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow campaign entries template
>
> **Slug:** `BOLNA_GET_WORKFLOW_CAMPAIGN_ENTRIES_TEMPLATE`
>
> Get the exact CSV header expected by a campaign's pinned workflow version.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the campaign whose CSV header template to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow campaign report
>
> **Slug:** `BOLNA_GET_WORKFLOW_CAMPAIGN_REPORT`
>
> Get aggregate statuses, termination reasons, and per-node funnel counts.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the campaign to report on.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow draft
>
> **Slug:** `BOLNA_GET_WORKFLOW_DRAFT`
>
> Retrieve a workflow's editable draft definition and revision.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow whose draft to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow execution
>
> **Slug:** `BOLNA_GET_WORKFLOW_EXECUTION`
>
> Retrieve one contact's status, node attempts, state, and recent timeline.
>
> #### Input Parameters
>
> **execution\_id** `string` *required*
>
> ID of the workflow execution to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get workflow version
>
> **Slug:** `BOLNA_GET_WORKFLOW_VERSION`
>
> Retrieve a specific published workflow version and its full node graph.
>
> #### Input Parameters
>
> **version** `integer` *required*
>
> Published workflow version number.
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to retrieve.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Import Bolna Agent
>
> **Slug:** `BOLNA_IMPORT_AGENT`
>
> Tool to import an existing Bolna voice AI agent by its ID. Use when you need to copy or duplicate an agent configuration, create a new agent from a template, or migrate an agent from another environment.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user identifier to associate with the imported agent
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID format) of the agent to import
>
> **agent\_name** `string`
>
> Optional name to assign to the imported agent. If not provided, the original agent name will be used.
>
> **is\_api\_request** `boolean`
>
> Flag indicating whether this is an API request. Defaults to false if not provided.
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier for multi-tenant environments
>
> **agent\_version\_id** `string`
>
> Optional version identifier (UUID format) of the specific agent version to import. If not provided, the latest version will be imported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List agents (paginated)
>
> **Slug:** `BOLNA_LIST_AGENTS_PAGINATED`
>
> Retrieve a paginated list of Bolna agents, optionally filtered by user or sub-account. This action is deprecated.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Filter agents by specific user ID
>
> **page\_size** `integer`
>
> Number of agents to return per page. Defaults to API default if not specified.
>
> **page\_number** `integer`
>
> Page number for pagination (1-based). Defaults to 1 if not specified.
>
> **is\_api\_request** `string`
>
> Flag to indicate if this is an API request. Accepts string representation of boolean.
>
> **sub\_account\_id** `string`
>
> Filter agents by sub-account ID for multi-tenant scenarios
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List custom LLM models
>
> **Slug:** `BOLNA_LIST_CUSTOM_LLM_MODELS`
>
> List custom LLM models available in the current Bolna account scope.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List dispositions
>
> **Slug:** `BOLNA_LIST_DISPOSITIONS`
>
> List account-owned dispositions or dispositions linked to one agent.
>
> #### Input Parameters
>
> **agent\_id** `string`
>
> Agent ID used to return dispositions linked to one agent. Omit to list account-owned dispositions.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List extraction categories
>
> **Slug:** `BOLNA_LIST_EXTRACTION_CATEGORIES`
>
> List an agent's extraction categories and the dispositions inside each.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Agent whose extraction categories should be listed.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Knowledgebases
>
> **Slug:** `BOLNA_LIST_KNOWLEDGEBASES`
>
> List knowledgebases in your Bolna account, with optional status filtering and pagination. Results include processing status and other knowledgebase details.
>
> #### Input Parameters
>
> **status** `string ("processing" | "processed")`
>
> Status of a knowledgebase
>
> **user\_id** `string`
>
> Optional user identifier to filter knowledgebases by a specific user account
>
> **page\_size** `integer`
>
> Number of knowledgebases to return per page. Defaults to API default if not specified.
>
> **page\_number** `integer`
>
> Page number for pagination (1-based). Defaults to 1 if not specified.
>
> **is\_api\_request** `string`
>
> Flag indicating whether this is an API request. Typically omitted or set to false for standard operations
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier for multi-tenant or organization scenarios
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all phone numbers
>
> **Slug:** `BOLNA_LIST_PHONE_NUMBERS`
>
> Tool to list all phone numbers associated with your Bolna account. Use when you need to retrieve details of all phone numbers including provider, associated agent, pricing, and rental status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List all providers
>
> **Slug:** `BOLNA_LIST_PROVIDERS`
>
> Retrieve all providers associated with your Bolna account Returns a list of all configured providers including: - Provider IDs (unique identifiers) - Provider names (e.g., API key types) - Masked provider values (secrets) - Creation timestamps (both absolute and human-readable) Use this when you need to view all configured API providers, check provider details, or verify provider setup in your Bolna account.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List SIP trunks
>
> **Slug:** `BOLNA_LIST_SIP_TRUNKS`
>
> List SIP trunks, optionally filtered by active status.
>
> #### Input Parameters
>
> **is\_active** `boolean`
>
> Optionally filter trunks by active status.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List sub-accounts
>
> **Slug:** `BOLNA_LIST_SUB_ACCOUNTS`
>
> List all sub-accounts linked to the organization.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List numbers on SIP trunk
>
> **Slug:** `BOLNA_LIST_TRUNK_NUMBERS`
>
> List all phone numbers assigned to a SIP trunk.
>
> #### Input Parameters
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List TTS providers and models
>
> **Slug:** `BOLNA_LIST_TTS_PROVIDERS`
>
> List TTS providers and models supported for a language.
>
> #### Input Parameters
>
> **language** `string` *required*
>
> Language code, such as en, hi, or ta.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List violations
>
> **Slug:** `BOLNA_LIST_VIOLATIONS`
>
> List flagged call violations, optionally filtered by status.
>
> #### Input Parameters
>
> **status** `string ("pending" | "accepted" | "rejected" | "submitted")`
>
> Only return violations with this status.
>
> **page\_size** `integer`
>
> Number of violations per page.
>
> **page\_number** `integer`
>
> Page number, starting at 1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List available voices
>
> **Slug:** `BOLNA_LIST_VOICES`
>
> List available voices for a TTS provider, model, and language, with pagination. The API requires provider\_id, model\_id, and language; page sizes are limited to 100. Legacy user\_id and is\_api\_request inputs are accepted but ignored.
>
> #### Input Parameters
>
> **page** `integer`
>
> Page number (1-indexed)
>
> **user\_id** `string`
>
> Deprecated legacy input accepted for compatibility and ignored by the current voice API.
>
> **language** `string`
>
> BCP-47 language code, such as 'en' or 'hi'. The live API requires this field.
>
> **model\_id** `string`
>
> Model UUID returned by Bolna's List TTS providers endpoint
>
> **page\_size** `integer`
>
> Number of voices per page (maximum 100)
>
> **provider\_id** `string`
>
> Provider UUID returned by Bolna's List TTS providers endpoint
>
> **is\_api\_request** `boolean`
>
> Deprecated legacy input accepted for compatibility and ignored by the current voice API.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflow campaign entries
>
> **Slug:** `BOLNA_LIST_WORKFLOW_CAMPAIGN_ENTRIES`
>
> List a campaign's uploaded contacts, including row validation failures.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum entries to return.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction.
>
> **offset** `integer`
>
> Number of entries to skip.
>
> **status** `string ("pending" | "failed_validation" | "dispatched" | "completed")`
>
> Only return entries in this status.
>
> **sort\_by** `string ("created_at" | "reference_id" | "status")`
>
> Field by which to sort entries.
>
> **campaign\_id** `string` *required*
>
> ID of the campaign whose contacts to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflow campaign executions
>
> **Slug:** `BOLNA_LIST_WORKFLOW_CAMPAIGN_EXECUTIONS`
>
> List and filter the per-contact executions created by a campaign.
>
> #### Input Parameters
>
> **limit** `integer`
>
> Maximum executions to return.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction.
>
> **offset** `integer`
>
> Number of executions to skip.
>
> **status** `string ("pending" | "running" | "completed" | "failed" | "cancelled" | "aborted")`
>
> Only return executions in this status.
>
> **outcome** `string ("success" | "failure" | "neutral" | "none")`
>
> Only return executions with this outcome; `none` selects no outcome.
>
> **sort\_by** `string ("created_at" | "updated_at" | "status" | "outcome")`
>
> Field by which to sort executions.
>
> **campaign\_id** `string` *required*
>
> ID of the campaign whose executions to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflow campaigns
>
> **Slug:** `BOLNA_LIST_WORKFLOW_CAMPAIGNS`
>
> List workflow campaigns with filters, sorting, and offset pagination.
>
> #### Input Parameters
>
> **kind** `string ("batch" | "continuous" | "api")`
>
> Only return campaigns of this kind.
>
> **limit** `integer`
>
> Maximum campaigns to return.
>
> **order** `string ("asc" | "desc")`
>
> Sort direction.
>
> **offset** `integer`
>
> Number of campaigns to skip.
>
> **status** `string ("draft" | "scheduled" | "running" | "paused" | "completed" | "aborted")`
>
> Only return campaigns in this status.
>
> **sort\_by** `string ("created_at" | "updated_at" | "name" | "entries_count" | "success_count" | "failure_count")`
>
> Field by which to sort campaigns.
>
> **workflow\_id** `string`
>
> Only return campaigns for this workflow ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflow node types
>
> **Slug:** `BOLNA_LIST_WORKFLOW_NODE_TYPES`
>
> List workflow node types and their supported configuration fields.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List workflows
>
> **Slug:** `BOLNA_LIST_WORKFLOWS`
>
> List account workflows with optional name filtering and offset pagination.
>
> #### Input Parameters
>
> **name** `string`
>
> Case-insensitive substring to match against workflow names.
>
> **limit** `integer`
>
> Maximum number of workflows to return.
>
> **offset** `integer`
>
> Zero-based number of workflows to skip.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Make an outbound phone call from agent
>
> **Slug:** `BOLNA_MAKE_A_PHONE_CALL_FROM_AGENT`
>
> Initiate an outbound phone call using a configured Bolna Voice AI agent. The agent will call the specified recipient and engage in a conversation based on its configured prompt and capabilities.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> The UUID of the Bolna agent that will initiate and handle the outbound call. Use get\_all\_agents to retrieve available agent IDs.
>
> **user\_data** `object`
>
> Optional dictionary of custom variables that can be referenced in the agent's prompt template. Keys should match variable names in your agent configuration. Example: \{'customer\_name': 'John', 'order\_id': '12345'}
>
> **from\_phone\_number** `string`
>
> Optional caller ID phone number in E.164 format (e.g., +14155559999). If not provided, Bolna will use a default shared number. Required only when using dedicated or connected phone numbers.
>
> **recipient\_phone\_number** `string` *required*
>
> The recipient's phone number in E.164 international format (e.g., +14155552671 for US, +919876543210 for India). Must include the + prefix and country code.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Patch Bolna Voice AI agent (v2)
>
> **Slug:** `BOLNA_PATCH_AGENT`
>
> Partially update a Bolna v2 agent without replacing its full configuration.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> ID of the agent to patch.
>
> **agent\_config** `object`
>
> Agent configuration fields to change.
>
> **agent\_prompts** `object`
>
> Task prompt changes keyed by task name, such as task\_1.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Partially Update Bolna Voice AI Agent (v1)
>
> **Slug:** `BOLNA_PATCH_AGENT_V1`
>
> Tool to partially update a Voice AI agent using the v1 API endpoint. Use when you need to modify specific agent properties like name, welcome message, webhook URL, synthesizer settings, or system prompts without providing the full configuration. Note: This is a deprecated v1 endpoint; prefer using PATCH /v2/agent/\{agent\_id} for new implementations.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> User identifier for multi-tenant scenarios
>
> **agent\_id** `string` *required*
>
> Unique identifier (UUID) of the agent to update. Also known as agent\_id.
>
> **agent\_config** `object`
>
> Schema for agent configuration
>
> **agent\_prompts** `object`
>
> Schema for agent prompts configuration
>
> **is\_api\_request** `boolean`
>
> Flag indicating if this is an API request
>
> **sub\_account\_id** `string`
>
> Sub-account identifier for organizational hierarchy
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Pause workflow campaign
>
> **Slug:** `BOLNA_PAUSE_WORKFLOW_CAMPAIGN`
>
> Move a scheduled or running campaign to paused; only paused campaigns can be resumed, while aborted campaigns are terminal.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the scheduled or running campaign to pause.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Publish workflow
>
> **Slug:** `BOLNA_PUBLISH_WORKFLOW`
>
> Freeze the current valid draft as a new immutable workflow version.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow whose draft to publish.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove Provider from Bolna Account
>
> **Slug:** `BOLNA_REMOVE_PROVIDER`
>
> Tool to remove a provider from your Bolna account by its key name. Use when you need to delete a provider configuration that is no longer needed or needs to be replaced.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user ID to scope the provider removal to a specific user
>
> **is\_api\_request** `boolean`
>
> Flag to indicate if this is an API request. Defaults to false if not specified
>
> **sub\_account\_id** `string`
>
> Optional sub-account ID to scope the provider removal to a specific sub-account
>
> **provider\_key\_name** `string` *required*
>
> Upper-case provider\_name exactly as returned by BOLNA\_LIST\_PROVIDERS, e.g. DEEPGRAM. Matching is case-sensitive; an unknown name returns success without removing anything.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove number from SIP trunk
>
> **Slug:** `BOLNA_REMOVE_TRUNK_NUMBER`
>
> Remove a phone number and any agent mapping from a SIP trunk.
>
> #### Input Parameters
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk.
>
> **phone\_number\_id** `string` *required*
>
> Unique identifier of the phone number to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rename workflow
>
> **Slug:** `BOLNA_RENAME_WORKFLOW`
>
> Rename an existing workflow.
>
> #### Input Parameters
>
> **name** `string` *required*
>
> New workflow name.
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to rename.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resend workflow execution webhook
>
> **Slug:** `BOLNA_RESEND_WORKFLOW_WEBHOOK`
>
> Queue redelivery of a finished workflow execution's original webhook.
>
> #### Input Parameters
>
> **execution\_id** `string` *required*
>
> ID of the finished execution whose webhook to queue again.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Resume workflow campaign
>
> **Slug:** `BOLNA_RESUME_WORKFLOW_CAMPAIGN`
>
> Move a paused campaign back to running. Draft or scheduled campaigns must be started, and aborted campaigns cannot be resumed.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the paused campaign to resume.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve agent by id
>
> **Slug:** `BOLNA_RETRIEVE_AGENT_BY_ID`
>
> Retrieve details for a specific Bolna voice AI agent by ID, including name, type, status, tasks, timestamps, and the first task's prompt when available.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID) of the Bolna voice agent to retrieve. You can get valid agent IDs from the get\_all\_agents action.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve agent execution details
>
> **Slug:** `BOLNA_RETRIEVE_AGENT_EXECUTION_DETAILS`
>
> Retrieve details of a specific agent execution, including transcript, costs, duration, status, and telephony data when available. This action is deprecated.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> The unique agent ID (UUID format)
>
> **execution\_id** `string` *required*
>
> The unique execution ID for the call/conversation (UUID format)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve agent execution status
>
> **Slug:** `BOLNA_RETRIEVE_AGENT_EXECUTION_STATUS`
>
> Retrieve a paginated, filterable list of executions for a specific agent, including call status, costs, transcripts, and telephony data when available. When both date bounds are supplied, their range cannot exceed seven days.
>
> #### Input Parameters
>
> **to** `string`
>
> Filter executions where created\_at is less than or equal to this UTC datetime (ISO 8601 format). The from/to range cannot exceed 7 days.
>
> **from** `string`
>
> Filter executions where created\_at is greater than or equal to this UTC datetime (ISO 8601 format). The from/to range cannot exceed 7 days.
>
> **status** `string`
>
> Filter by call status (e.g., queued, ringing, completed, failed)
>
> **agent\_id** `string` *required*
>
> The unique UUID of the agent whose executions you want to retrieve
>
> **batch\_id** `string`
>
> Filter executions by specific batch ID
>
> **provider** `string`
>
> Filter by conversation provider (e.g., plivo, twilio, websocket, web-call)
>
> **call\_type** `string`
>
> Filter by call type: 'inbound' or 'outbound'
>
> **page\_size** `integer`
>
> Number of results per page (maximum: 50, default: 20)
>
> **page\_number** `integer`
>
> Page number to retrieve (minimum: 1, default: 1)
>
> **answered\_by\_voice\_mail** `boolean`
>
> Filter by whether the call was answered by voicemail
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve Batch Details by ID
>
> **Slug:** `BOLNA_RETRIEVE_BATCH_DETAILS_BY_ID`
>
> Retrieve comprehensive details about a specific Bolna batch by its ID. Returns batch metadata including creation time, execution status, scheduled time, contact statistics, and call status breakdown. Use this to monitor batch progress or retrieve information about previously created batch calling campaigns.
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> Unique identifier of the batch in 32-character hex format (e.g., '3c90c3cc0d444b5088888dd25736052a')
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Retrieve batch execution list
>
> **Slug:** `BOLNA_RETRIEVE_BATCH_EXECUTION_LIST`
>
> Retrieve a page of executions from a specific batch. Results may include conversation metrics, transcripts, costs, and resource usage breakdowns, along with pagination information.
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> The unique identifier of the batch (32-character hex string)
>
> **page\_size** `integer`
>
> Number of results per page (maximum 1000)
>
> **page\_number** `integer`
>
> The page number to retrieve (starts at 1)
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Run workflow
>
> **Slug:** `BOLNA_RUN_WORKFLOW`
>
> Run one contact through the workflow's latest published version.
>
> #### Input Parameters
>
> **contact** `object` *required*
>
> Contact and start-node fields for this execution.
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to run.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Save workflow draft
>
> **Slug:** `BOLNA_SAVE_WORKFLOW_DRAFT`
>
> Overwrite a workflow draft using revision-based optimistic concurrency.
>
> #### Input Parameters
>
> **definition** `object` *required*
>
> Complete replacement workflow node graph.
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow whose draft to overwrite.
>
> **expected\_revision** `integer` *required*
>
> Current draft revision required to prevent conflicting writes.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Schedule Batch by ID
>
> **Slug:** `BOLNA_SCHEDULE_BATCH_BY_ID`
>
> Schedule a batch to execute at a specific time. After creating a batch with BOLNA\_CREATE\_BATCH, use this action to set when the batch calls should begin. The batch must exist and be in a schedulable state (e.g., 'created' or 'stopped').
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> The unique identifier (UUID) of the batch to schedule
>
> **scheduled\_at** `string` *required*
>
> The scheduled execution time in ISO 8601 format with timezone. Must be a future timestamp specifying when the batch calls should begin.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search available phone numbers
>
> **Slug:** `BOLNA_SEARCH_PHONE_NUMBERS`
>
> Search for available phone numbers to purchase for Bolna Voice agents in the US or India, with an optional prefix pattern.
>
> #### Input Parameters
>
> **country** `string ("US" | "IN")` *required*
>
> The country code for the phone number. Available options: US or IN
>
> **pattern** `string`
>
> A 3-character prefix for filtering phone numbers during the search
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Setup inbound call for agent
>
> **Slug:** `BOLNA_SETUP_INBOUND_CALL_FOR_AGENT`
>
> Add agent for inbound calls
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Agent `id` which will handle inbound calls. Used as default if no IVR option-level agent is set. Please make sure that the agent"s Telephony provider is set as Twilio
>
> **phone\_number\_id** `string` *required*
>
> Telephone number `id` from Phone number list API. This is required to associate a phone number with the agent for inbound calls.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Start workflow campaign
>
> **Slug:** `BOLNA_START_WORKFLOW_CAMPAIGN`
>
> Move a draft or scheduled campaign to running. It must contain at least one valid pending entry; a campaign whose entries all failed validation cannot start.
>
> #### Input Parameters
>
> **campaign\_id** `string` *required*
>
> ID of the draft or scheduled campaign to start.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop Agent Calls
>
> **Slug:** `BOLNA_STOP_AGENT_CALLS`
>
> Stop queued or scheduled calls for a specific Voice AI agent, optionally filtered by user or sub-account.
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user identifier to filter which calls to stop for this agent
>
> **agent\_id** `string` *required*
>
> Unique identifier (UUID) of the agent whose queued or scheduled calls should be stopped. Obtain this from BOLNA\_CREATE\_AGENT or BOLNA\_GET\_ALL\_AGENTS.
>
> **is\_api\_request** `boolean`
>
> Optional flag to indicate if this is an API request. Defaults to false if not provided.
>
> **sub\_account\_id** `string`
>
> Optional sub-account identifier to filter which calls to stop within a multi-tenant setup
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop batch by id
>
> **Slug:** `BOLNA_STOP_BATCH_BY_ID`
>
> Stop a running batch by its ID. This halts all queued calls in the batch. Any calls currently in the queue waiting to be executed will be cancelled and will not be processed. Use this when you need to immediately halt a batch campaign that's in progress.
>
> #### Input Parameters
>
> **batch\_id** `string` *required*
>
> The unique identifier (UUID or 32-character hex string) of the batch to stop. Obtain this from BOLNA\_CREATE\_BATCH or BOLNA\_FETCH\_ALL\_BATCHES\_BY\_AGENT\_ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Stop queued or scheduled call
>
> **Slug:** `BOLNA_STOP_CALL`
>
> Cancel a queued or scheduled call before it starts.
>
> #### Input Parameters
>
> **execution\_id** `string` *required*
>
> ID of the queued or scheduled call to stop.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Submit violation
>
> **Slug:** `BOLNA_SUBMIT_VIOLATION`
>
> Submit evidence for a Bolna violation and move it to submitted state.
>
> #### Input Parameters
>
> **violation\_id** `string` *required*
>
> Unique identifier of the violation to submit.
>
> **violation\_file** `object` *required*
>
> Evidence image or document to attach to the violation.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Test dispositions against a transcript
>
> **Slug:** `BOLNA_TEST_DISPOSITIONS`
>
> Run every linked disposition against a transcript. Bolna invokes an LLM, so this can take tens of seconds.
>
> #### Input Parameters
>
> **agent\_id** `string` *required*
>
> Agent whose linked dispositions should be tested.
>
> **call\_date** `string`
>
> Optional ISO 8601 timestamp representing the call date.
>
> **transcript** `string` *required*
>
> Transcript to evaluate, up to 50,000 characters.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Test workflow webhook
>
> **Slug:** `BOLNA_TEST_WORKFLOW_WEBHOOK`
>
> Send a sample terminal execution event to a workflow's saved webhook.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow whose webhook to test.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Unlink inbound agent
>
> **Slug:** `BOLNA_UNLINK_INBOUND_AGENT`
>
> Remove automatic inbound agent routing from a phone number.
>
> #### Input Parameters
>
> **phone\_number\_id** `string` *required*
>
> ID of the phone number whose inbound agent routing to remove.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update Bolna Voice AI Agent (v2)
>
> **Slug:** `BOLNA_UPDATE_AGENT`
>
> Tool to update all settings and configuration of an existing Bolna Voice AI agent using the v2 API. Use when you need to modify an agent's full configuration including LLM settings, synthesizer, transcriber, tasks, prompts, or any other agent property. This performs a complete update (PUT operation).
>
> #### Input Parameters
>
> **user\_id** `string`
>
> Optional user ID parameter for multi-user environments
>
> **agent\_id** `string` *required*
>
> The unique identifier (UUID) of the agent to update
>
> **agent\_config** `object` *required*
>
> Complete agent configuration object. Required fields: agent\_name (string), agent\_type (string: 'other', 'sales', 'support', etc.), agent\_welcome\_message (string), webhook\_url (string URL for callbacks or null), and tasks (array). Each task must include task\_type ('conversation', 'extraction', or 'summarization'), toolchain (with execution mode and pipelines), tools\_config (defining input/output providers, transcriber, llm\_agent, and synthesizer), and task\_config (with settings like hangup\_after\_silence, optimize\_latency, etc.).
>
> **agent\_prompts** `object` *required*
>
> Object containing prompt configurations for each task. Each task key (e.g., 'task\_1', 'task\_2') maps to an object with a 'system\_prompt' string that defines behavioral instructions for that task.
>
> **is\_api\_request** `boolean`
>
> Flag to indicate if this is an API request. Defaults to false
>
> **sub\_account\_id** `string`
>
> Optional sub-account ID for multi-tenant scenarios
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update disposition
>
> **Slug:** `BOLNA_UPDATE_DISPOSITION`
>
> Partially update a disposition, with optional agent-scoped copy-on-write.
>
> #### Input Parameters
>
> **name** `string`
>
> New disposition name.
>
> **model** `string`
>
> New extraction model.
>
> **agent\_id** `string`
>
> Agent ID used for Bolna's copy-on-write behavior on shared dispositions.
>
> **category** `string`
>
> Legacy destination category name. Pass either category or category\_id, not both.
>
> **question** `string`
>
> New extraction question.
>
> **category\_id** `string`
>
> Destination extraction category ID. Pass either category\_id or category, not both.
>
> **is\_objective** `boolean`
>
> Whether the disposition selects from objective\_options.
>
> **is\_subjective** `boolean`
>
> Whether the disposition produces a free-form value.
>
> **system\_prompt** `string`
>
> New system prompt.
>
> **disposition\_id** `string` *required*
>
> Disposition ID to update.
>
> **subjective\_type** `string ("text" | "timestamp" | "numeric" | "boolean" | "email" | "regex")`
>
> New subjective output type.
>
> **objective\_options** `array`
>
> New objective classification options.
>
> **subjective\_type\_config** `object`
>
> Configuration for the subjective output type.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update extraction category
>
> **Slug:** `BOLNA_UPDATE_EXTRACTION_CATEGORY`
>
> Rename an extraction category and/or change its extraction model.
>
> #### Input Parameters
>
> **name** `string`
>
> New category name.
>
> **model** `string`
>
> New model for the category's extraction pass.
>
> **category\_id** `string` *required*
>
> Extraction category ID to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update SIP trunk
>
> **Slug:** `BOLNA_UPDATE_SIP_TRUNK`
>
> Partially update a SIP trunk; supplied gateway arrays replace existing arrays.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated human-readable trunk name.
>
> **allow** `string`
>
> Comma-separated codecs to allow.
>
> **disallow** `string`
>
> Comma-separated codecs to disallow.
>
> **gateways** `array`
>
> Complete replacement list of SIP gateways.
>
> **trunk\_id** `string` *required*
>
> Unique identifier of the SIP trunk to update.
>
> **is\_active** `boolean`
>
> Whether the trunk is active.
>
> **transport** `string ("transport-udp" | "transport-tcp" | "transport-tls")`
>
> Updated SIP transport protocol.
>
> **description** `string`
>
> Updated internal trunk description.
>
> **auth\_password** `string`
>
> Updated SIP password for a userpass trunk.
>
> **auth\_username** `string`
>
> Updated SIP username for a userpass trunk.
>
> **ip\_identifiers** `array`
>
> Complete replacement list of allowed IP ranges.
>
> **inbound\_enabled** `boolean`
>
> Whether inbound calls are enabled.
>
> **media\_encryption** `string ("no" | "sdes")`
>
> Updated RTP encryption mode; sdes requires TLS transport.
>
> **qualify\_frequency** `integer`
>
> SIP OPTIONS ping interval in seconds; use 0 to disable.
>
> **media\_encryption\_optimistic** `boolean`
>
> Whether encrypted media may fall back to clear RTP.
>
> **outbound\_leading\_plus\_enabled** `boolean`
>
> Whether outbound numbers receive a leading plus sign.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update sub-account
>
> **Slug:** `BOLNA_UPDATE_SUB_ACCOUNT`
>
> Partially update an enterprise sub-account's name or concurrency limits.
>
> #### Input Parameters
>
> **name** `string`
>
> Updated sub-account name.
>
> **sub\_account\_id** `string` *required*
>
> Unique identifier of the sub-account to update.
>
> **max\_concurrency** `integer`
>
> Updated hard concurrency cap; 0 pauses the sub-account.
>
> **min\_concurrency** `integer`
>
> Updated guaranteed concurrency; 0 means no guarantee.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Update workflow settings
>
> **Slug:** `BOLNA_UPDATE_WORKFLOW_SETTINGS`
>
> Apply an RFC 7396 merge patch to a workflow's live settings.
>
> #### Input Parameters
>
> **settings** `object` *required*
>
> RFC 7396 merge patch for live workflow settings, for example \{"webhook":\{"url":"[https://example.com/bolna"\&#125;\&#125](https://example.com/bolna"\&#125;\&#125);.
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow to update.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload workflow campaign entries
>
> **Slug:** `BOLNA_UPLOAD_WORKFLOW_CAMPAIGN_ENTRIES`
>
> Upload JSON contacts to a draft, scheduled, or running workflow campaign. The result reports accepted and failed rows, including per-row failures and warnings.
>
> #### Input Parameters
>
> **entries** `array` *required*
>
> Contacts to add to the campaign.
>
> **campaign\_id** `string` *required*
>
> ID of the campaign receiving contacts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Validate workflow
>
> **Slug:** `BOLNA_VALIDATE_WORKFLOW`
>
> Check a saved workflow draft for errors and warnings before publishing.
>
> #### Input Parameters
>
> **workflow\_id** `string` *required*
>
> Unique identifier of the workflow whose saved draft to validate.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
