Skip to main content
Bolna logo
  • Category: ai agents
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 102
  • Triggers: 0
  • Slug: BOLNA
  • Version: 20261101_00

Tools

Slug: BOLNA_ABORT_WORKFLOW_CAMPAIGNMove 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

string
required
ID of the campaign to terminate permanently.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_ADD_CUSTOM_LLM_MODELRegister an OpenAI-compatible custom LLM endpoint with Bolna.

Input Parameters

string
required
Bearer token for the custom endpoint; Bolna stores it encrypted.
string
required
Public OpenAI-compatible base URL, including its version segment.
string
required
Model ID served by the custom endpoint; Bolna passes it through unchanged.
string
required
Model family, such as qwen, llama, or mistral.
string
Optional comma-separated language codes. Bolna defaults this to en.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_ADD_PROVIDERTool 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

string
User ID to associate the provider with. Optional.
string
required
Name of the telephony or voice service provider to add (e.g., ‘twilio’, ‘deepgram’, ‘elevenlabs’)
boolean
Flag indicating if this is an API request. Defaults to false.
string
required
API key or authentication value for the provider
string
Sub-account ID to associate the provider with. Optional.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_ADD_TRUNK_NUMBERAdd a DID phone number to a SIP trunk.

Input Parameters

string
Optional human-readable label for the phone number.
string
required
Unique identifier of the SIP trunk.
string
required
DID phone number to register on the trunk.
boolean
Whether Bolna should enforce E.164 validation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_BULK_CREATE_DISPOSITIONSAtomically create multiple dispositions linked to one agent.

Input Parameters

string
required
Agent to link every new disposition to.
array
required
One or more dispositions to create atomically.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_BUY_PHONE_NUMBERPurchase an available phone number in the US or India with a recurring account charge.

Input Parameters

string ("US" | "IN")
required
Country in which to purchase the number.
string ("twilio" | "plivo" | "vobiz")
Preferred telephony provider.
string
required
Phone number to purchase in E.164 format.
string
Approved compliance application ID to use for the purchase.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CANCEL_WORKFLOW_EXECUTIONStop one workflow execution before its next external action.

Input Parameters

string
Free-form reason to record on the cancellation.
string
required
ID of the workflow execution to cancel.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_COPY_AGENTTool 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

string
Optional user identifier to associate the copied agent with a specific user
string
required
The unique identifier (UUID) of the existing Bolna agent to copy
string
required
The name for the new copied agent. This will be the display name of the duplicated agent.
boolean
Flag to indicate if this is an API request. Defaults to false if not provided.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_AGENTTool 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

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).
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_BATCHTool 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

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.
string
required
The ID of the agent (UUID format) to use for the batch calling campaign
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_DISPOSITIONCreate a structured transcript extraction disposition linked to an agent.

Input Parameters

string
required
Human-readable disposition name.
string
Model used to evaluate the disposition.
string
required
Agent to link the new disposition to.
string
Legacy category name. Pass either category or category_id, not both.
string
required
Extraction question evaluated against call transcripts.
string
Existing extraction category ID. Pass either category_id or category, not both.
boolean
Whether the disposition selects from objective_options. Set true with objective_options such as [{“value”:“yes”,“condition”:“The caller agreed”}].
boolean
Whether the disposition produces a free-form value.
string
Optional system prompt for this extraction.
string ("text" | "timestamp" | "numeric" | "boolean" | "email" | "regex")
Expected subjective output type.
array
Allowed objective classification options, for example [{“value”:“yes”,“condition”:“The caller agreed”}]; set is_objective=true.
object
Configuration for the subjective output type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_EXTRACTION_CATEGORYCreate an extraction category on an agent.

Input Parameters

string
required
Category name, unique among the agent’s categories.
string
required
Model used for the category’s extraction pass.
string
required
Agent to attach the extraction category to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_KNOWLEDGEBASETool 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

string
URL to ingest as the knowledgebase source (e.g., ‘https://example.com/documentation’). Either ‘url’ or ‘file’ must be provided, but not both. Use this for web-based content.
object
PDF file to upload as the knowledgebase source. Either ‘file’ or ‘url’ must be provided, but not both.
string
Optional user identifier to associate with this knowledgebase
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.
integer
Number of characters to overlap between consecutive chunks. Overlapping helps preserve context across chunk boundaries. Typical values: 50-200.
boolean
Internal flag to indicate if this is an API request. Typically not needed by end users.
string
Optional sub-account identifier for multi-tenant environments
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_SIP_TRUNKCreate a bring-your-own-telephony SIP trunk.

Input Parameters

string
required
Human-readable name for the SIP trunk.
string
Comma-separated codecs to allow.
string
Comma-separated codecs to disallow.
array
required
One or more ordered SIP gateways.
string
required
SIP provider name, such as twilio, telnyx, or custom.
string ("userpass" | "ip-based")
required
Authentication method for the trunk.
string ("transport-udp" | "transport-tcp" | "transport-tls")
SIP transport protocol.
string
Optional internal description of the trunk.
boolean
Whether to force responses to the source port.
boolean
Whether RTP should flow directly between endpoints.
string
SIP password, required for userpass authentication.
string
SIP username, required for userpass authentication.
array
DID phone numbers to register during creation.
boolean
Whether to enable symmetric RTP for NAT traversal.
array
Allowed IP addresses, required for IP-based authentication.
boolean
Whether inbound calls are enabled.
string ("no" | "sdes")
RTP encryption mode; sdes requires TLS transport.
integer
SIP OPTIONS ping interval in seconds; use 0 to disable.
boolean
Whether encrypted media may fall back to clear RTP.
boolean
Whether outbound numbers receive a leading plus sign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_SUB_ACCOUNTCreate an enterprise sub-account with its own concurrency limits and API key.

Input Parameters

string
required
Name of the new sub-account.
string
Database host for a multi-tenant sub-account.
string
Database name for a multi-tenant sub-account.
string
Database port for a multi-tenant sub-account.
string
Database root user for a multi-tenant sub-account.
string
Database root password for a multi-tenant sub-account.
boolean
Whether the sub-account uses a separate database.
integer
Optional hard concurrency cap; 0 pauses the sub-account.
integer
required
Guaranteed concurrency reserved for the sub-account; 0 means no guarantee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
System prompt or instructions that define the agent’s behavior and responses. This guides how the agent interacts with users.
string
Optional user ID to associate with the template agent
string
Name for the template agent being created. This will identify the agent in the system.
string
Type or category of the agent template. Specifies the functional role of the agent (e.g., ‘support’, ‘sales’, ‘other’).
boolean
Flag indicating whether to enable transcript recording for this agent. Set to true to capture conversation transcripts.
string
Name of the business for which the template agent is being created
boolean
Flag indicating whether to return the generated prompt in the response. Set to true to receive the prompt back after agent creation.
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.
string
Description of the business for which the agent template is being created. Provides context about the business domain and purpose.
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.
string
Identifier or name of the base template to use for agent creation. References a predefined agent template.
string
Details about the services offered by the business. Helps the agent understand what services it can discuss with customers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_WORKFLOWCreate an empty, unpublished workflow and return its identifier.

Input Parameters

string
required
Name for the new workflow.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_CREATE_WORKFLOW_CAMPAIGNCreate a draft campaign pinned to a published workflow version.

Input Parameters

string
required
Campaign display name.
object
Per-campaign agent and phone-number mapping overrides.
integer
Published workflow version to pin; omit to pin the latest.
string
required
ID of the workflow to run.
string
Timezone-aware ISO 8601 time at which to start the campaign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_AGENT_BY_IDPermanently delete a Voice AI agent and all associated data including batches, executions, and configurations

Input Parameters

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_BATCH_BY_IDPermanently delete a batch campaign by its ID, removing it from the system. This operation cannot be undone.

Input Parameters

string
required
Unique identifier (UUID format) of the batch to delete. This will permanently remove the batch and cannot be undone.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_CUSTOM_LLM_MODELDelete a custom LLM model and its stored endpoint key from Bolna.

Input Parameters

string
required
Identifier of the custom model to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_DISPOSITIONPermanently delete a disposition without changing past call results.

Input Parameters

string
required
Disposition ID to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_EXTRACTION_CATEGORYPermanently delete an extraction category and every disposition inside it.

Input Parameters

string
required
Extraction category ID to permanently delete with its dispositions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_KNOWLEDGEBASETool 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

string
required
Unique identifier (UUID format) of the knowledgebase to delete. This will permanently remove the knowledgebase and cannot be undone.
string
Optional user identifier to scope the deletion operation to a specific user account
string
Flag indicating whether this is an API request. Typically omitted or set to false for standard operations
string
Optional sub-account identifier for multi-tenant or organization scenarios

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_PHONE_NUMBERPermanently release a purchased phone number and stop recurring billing.

Input Parameters

string
required
ID of the purchased phone number to release.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_SIP_TRUNKPermanently delete a SIP trunk and its gateways, IP identifiers, and numbers.

Input Parameters

string
required
Unique identifier of the SIP trunk to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_SUB_ACCOUNTPermanently delete a sub-account and all of its data.

Input Parameters

string
required
Unique identifier of the sub-account to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_WORKFLOWPermanently delete a workflow, its draft, and all published versions.

Input Parameters

string
required
Unique identifier of the workflow to permanently delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_DELETE_WORKFLOW_CAMPAIGNPermanently 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

string
required
ID of the empty draft campaign to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_FETCH_ALL_BATCHES_BY_AGENT_IDRetrieve 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

string
required
The unique identifier (UUID) of the Bolna Voice AI agent whose batches you want to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
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

string
Optional user identifier to filter agents by user ownership.
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.
string
Flag indicating if this is an API request. Defaults to false if not provided.
string
Optional sub-account identifier for multi-tenant scenarios.
string
Optional version identifier to retrieve a specific version of the agent.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_ALL_AGENTSRetrieve 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_ALL_SUB_ACCOUNTS_USAGERetrieve usage and cost breakdowns for every organization sub-account.

Input Parameters

string
Optional ISO 8601 UTC end timestamp; defaults to the end of the current day.
string
Optional ISO 8601 UTC start timestamp; defaults to the start of the current month.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_DISPOSITIONRetrieve one disposition, optionally requiring an agent link.

Input Parameters

string
Agent ID that the disposition must be linked to, when provided.
string
required
Disposition ID to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_EXECUTION_BY_IDRetrieve 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

string
required
The unique execution identifier (UUID format, e.g., ‘4c06b4d1-4096-4561-919a-4f94539c8d4a’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_EXECUTION_RAW_LOGSRetrieve raw transcriber, LLM, synthesizer, and telephony logs for a call.

Input Parameters

string
required
ID of the call execution whose logs to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_KNOWLEDGEBASETool 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

string
required
The unique identifier (UUID) of the knowledgebase to retrieve
string
Optional user ID for filtering knowledgebase access
boolean
Flag indicating if this is an API request
string
Optional sub-account ID for multi-tenant scenarios

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_SIP_TRUNKRetrieve full details of one SIP trunk.

Input Parameters

string
required
Unique identifier of the SIP trunk to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_SUB_ACCOUNT_USAGERetrieve one sub-account’s usage and cost breakdown for up to 32 days.

Input Parameters

string
Optional ISO 8601 UTC end timestamp; defaults to the end of the current day.
string
Optional ISO 8601 UTC start timestamp; defaults to the start of the current month.
string
required
Unique identifier of the sub-account.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_USER_INFOTool 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

string
Optional user ID to fetch information for a specific user
boolean
Flag to indicate if this is an API request

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOWRetrieve workflow status, live settings, and version history.

Input Parameters

string
required
Unique identifier of the workflow to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_CAMPAIGNRetrieve a campaign with entry-status and validation-error counts.

Input Parameters

string
required
ID of the campaign to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_CAMPAIGN_ENTRIES_TEMPLATEGet the exact CSV header expected by a campaign’s pinned workflow version.

Input Parameters

string
required
ID of the campaign whose CSV header template to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_CAMPAIGN_REPORTGet aggregate statuses, termination reasons, and per-node funnel counts.

Input Parameters

string
required
ID of the campaign to report on.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_DRAFTRetrieve a workflow’s editable draft definition and revision.

Input Parameters

string
required
Unique identifier of the workflow whose draft to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_EXECUTIONRetrieve one contact’s status, node attempts, state, and recent timeline.

Input Parameters

string
required
ID of the workflow execution to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_GET_WORKFLOW_VERSIONRetrieve a specific published workflow version and its full node graph.

Input Parameters

integer
required
Published workflow version number.
string
required
Unique identifier of the workflow to retrieve.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_IMPORT_AGENTTool 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

string
Optional user identifier to associate with the imported agent
string
required
The unique identifier (UUID format) of the agent to import
string
Optional name to assign to the imported agent. If not provided, the original agent name will be used.
boolean
Flag indicating whether this is an API request. Defaults to false if not provided.
string
Optional sub-account identifier for multi-tenant environments
string
Optional version identifier (UUID format) of the specific agent version to import. If not provided, the latest version will be imported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_AGENTS_PAGINATEDRetrieve a paginated list of Bolna agents, optionally filtered by user or sub-account. This action is deprecated.

Input Parameters

string
Filter agents by specific user ID
integer
Number of agents to return per page. Defaults to API default if not specified.
integer
Page number for pagination (1-based). Defaults to 1 if not specified.
string
Flag to indicate if this is an API request. Accepts string representation of boolean.
string
Filter agents by sub-account ID for multi-tenant scenarios

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_CUSTOM_LLM_MODELSList custom LLM models available in the current Bolna account scope.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_DISPOSITIONSList account-owned dispositions or dispositions linked to one agent.

Input Parameters

string
Agent ID used to return dispositions linked to one agent. Omit to list account-owned dispositions.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_EXTRACTION_CATEGORIESList an agent’s extraction categories and the dispositions inside each.

Input Parameters

string
required
Agent whose extraction categories should be listed.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_KNOWLEDGEBASESList knowledgebases in your Bolna account, with optional status filtering and pagination. Results include processing status and other knowledgebase details.

Input Parameters

string ("processing" | "processed")
Status of a knowledgebase
string
Optional user identifier to filter knowledgebases by a specific user account
integer
Number of knowledgebases to return per page. Defaults to API default if not specified.
integer
Page number for pagination (1-based). Defaults to 1 if not specified.
string
Flag indicating whether this is an API request. Typically omitted or set to false for standard operations
string
Optional sub-account identifier for multi-tenant or organization scenarios

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_PHONE_NUMBERSTool 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_PROVIDERSRetrieve 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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_SIP_TRUNKSList SIP trunks, optionally filtered by active status.

Input Parameters

boolean
Optionally filter trunks by active status.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_SUB_ACCOUNTSList all sub-accounts linked to the organization.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_TRUNK_NUMBERSList all phone numbers assigned to a SIP trunk.

Input Parameters

string
required
Unique identifier of the SIP trunk.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_TTS_PROVIDERSList TTS providers and models supported for a language.

Input Parameters

string
required
Language code, such as en, hi, or ta.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_VIOLATIONSList flagged call violations, optionally filtered by status.

Input Parameters

string ("pending" | "accepted" | "rejected" | "submitted")
Only return violations with this status.
integer
Number of violations per page.
integer
Page number, starting at 1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_VOICESList 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

integer
Page number (1-indexed)
string
Deprecated legacy input accepted for compatibility and ignored by the current voice API.
string
BCP-47 language code, such as ‘en’ or ‘hi’. The live API requires this field.
string
Model UUID returned by Bolna’s List TTS providers endpoint
integer
Number of voices per page (maximum 100)
string
Provider UUID returned by Bolna’s List TTS providers endpoint
boolean
Deprecated legacy input accepted for compatibility and ignored by the current voice API.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_WORKFLOW_CAMPAIGN_ENTRIESList a campaign’s uploaded contacts, including row validation failures.

Input Parameters

integer
Maximum entries to return.
string ("asc" | "desc")
Sort direction.
integer
Number of entries to skip.
string ("pending" | "failed_validation" | "dispatched" | "completed")
Only return entries in this status.
string ("created_at" | "reference_id" | "status")
Field by which to sort entries.
string
required
ID of the campaign whose contacts to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_WORKFLOW_CAMPAIGN_EXECUTIONSList and filter the per-contact executions created by a campaign.

Input Parameters

integer
Maximum executions to return.
string ("asc" | "desc")
Sort direction.
integer
Number of executions to skip.
string ("pending" | "running" | "completed" | "failed" | "cancelled" | "aborted")
Only return executions in this status.
string ("success" | "failure" | "neutral" | "none")
Only return executions with this outcome; none selects no outcome.
string ("created_at" | "updated_at" | "status" | "outcome")
Field by which to sort executions.
string
required
ID of the campaign whose executions to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_WORKFLOW_CAMPAIGNSList workflow campaigns with filters, sorting, and offset pagination.

Input Parameters

string ("batch" | "continuous" | "api")
Only return campaigns of this kind.
integer
Maximum campaigns to return.
string ("asc" | "desc")
Sort direction.
integer
Number of campaigns to skip.
string ("draft" | "scheduled" | "running" | "paused" | "completed" | "aborted")
Only return campaigns in this status.
string ("created_at" | "updated_at" | "name" | "entries_count" | "success_count" | "failure_count")
Field by which to sort campaigns.
string
Only return campaigns for this workflow ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_WORKFLOW_NODE_TYPESList workflow node types and their supported configuration fields.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_LIST_WORKFLOWSList account workflows with optional name filtering and offset pagination.

Input Parameters

string
Case-insensitive substring to match against workflow names.
integer
Maximum number of workflows to return.
integer
Zero-based number of workflows to skip.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_MAKE_A_PHONE_CALL_FROM_AGENTInitiate 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

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.
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’}
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.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_PATCH_AGENTPartially update a Bolna v2 agent without replacing its full configuration.

Input Parameters

string
required
ID of the agent to patch.
object
Agent configuration fields to change.
object
Task prompt changes keyed by task name, such as task_1.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_PATCH_AGENT_V1Tool 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

string
User identifier for multi-tenant scenarios
string
required
Unique identifier (UUID) of the agent to update. Also known as agent_id.
object
Schema for agent configuration
object
Schema for agent prompts configuration
boolean
Flag indicating if this is an API request
string
Sub-account identifier for organizational hierarchy

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_PAUSE_WORKFLOW_CAMPAIGNMove a scheduled or running campaign to paused; only paused campaigns can be resumed, while aborted campaigns are terminal.

Input Parameters

string
required
ID of the scheduled or running campaign to pause.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_PUBLISH_WORKFLOWFreeze the current valid draft as a new immutable workflow version.

Input Parameters

string
required
Unique identifier of the workflow whose draft to publish.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_REMOVE_PROVIDERTool 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

string
Optional user ID to scope the provider removal to a specific user
boolean
Flag to indicate if this is an API request. Defaults to false if not specified
string
Optional sub-account ID to scope the provider removal to a specific sub-account
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_REMOVE_TRUNK_NUMBERRemove a phone number and any agent mapping from a SIP trunk.

Input Parameters

string
required
Unique identifier of the SIP trunk.
string
required
Unique identifier of the phone number to remove.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RENAME_WORKFLOWRename an existing workflow.

Input Parameters

string
required
New workflow name.
string
required
Unique identifier of the workflow to rename.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RESEND_WORKFLOW_WEBHOOKQueue redelivery of a finished workflow execution’s original webhook.

Input Parameters

string
required
ID of the finished execution whose webhook to queue again.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RESUME_WORKFLOW_CAMPAIGNMove a paused campaign back to running. Draft or scheduled campaigns must be started, and aborted campaigns cannot be resumed.

Input Parameters

string
required
ID of the paused campaign to resume.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RETRIEVE_AGENT_BY_IDRetrieve 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RETRIEVE_AGENT_EXECUTION_DETAILSRetrieve details of a specific agent execution, including transcript, costs, duration, status, and telephony data when available. This action is deprecated.

Input Parameters

string
required
The unique agent ID (UUID format)
string
required
The unique execution ID for the call/conversation (UUID format)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RETRIEVE_AGENT_EXECUTION_STATUSRetrieve 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

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.
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.
string
Filter by call status (e.g., queued, ringing, completed, failed)
string
required
The unique UUID of the agent whose executions you want to retrieve
string
Filter executions by specific batch ID
string
Filter by conversation provider (e.g., plivo, twilio, websocket, web-call)
string
Filter by call type: ‘inbound’ or ‘outbound’
integer
Number of results per page (maximum: 50, default: 20)
integer
Page number to retrieve (minimum: 1, default: 1)
boolean
Filter by whether the call was answered by voicemail

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RETRIEVE_BATCH_DETAILS_BY_IDRetrieve 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

string
required
Unique identifier of the batch in 32-character hex format (e.g., ‘3c90c3cc0d444b5088888dd25736052a’)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RETRIEVE_BATCH_EXECUTION_LISTRetrieve 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

string
required
The unique identifier of the batch (32-character hex string)
integer
Number of results per page (maximum 1000)
integer
The page number to retrieve (starts at 1)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_RUN_WORKFLOWRun one contact through the workflow’s latest published version.

Input Parameters

object
required
Contact and start-node fields for this execution.
string
required
Unique identifier of the workflow to run.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_SAVE_WORKFLOW_DRAFTOverwrite a workflow draft using revision-based optimistic concurrency.

Input Parameters

object
required
Complete replacement workflow node graph.
string
required
Unique identifier of the workflow whose draft to overwrite.
integer
required
Current draft revision required to prevent conflicting writes.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_SCHEDULE_BATCH_BY_IDSchedule 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

string
required
The unique identifier (UUID) of the batch to schedule
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_SEARCH_PHONE_NUMBERSSearch for available phone numbers to purchase for Bolna Voice agents in the US or India, with an optional prefix pattern.

Input Parameters

string ("US" | "IN")
required
The country code for the phone number. Available options: US or IN
string
A 3-character prefix for filtering phone numbers during the search

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_SETUP_INBOUND_CALL_FOR_AGENTAdd agent for inbound calls

Input Parameters

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
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_START_WORKFLOW_CAMPAIGNMove 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

string
required
ID of the draft or scheduled campaign to start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_STOP_AGENT_CALLSStop queued or scheduled calls for a specific Voice AI agent, optionally filtered by user or sub-account.

Input Parameters

string
Optional user identifier to filter which calls to stop for this agent
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.
boolean
Optional flag to indicate if this is an API request. Defaults to false if not provided.
string
Optional sub-account identifier to filter which calls to stop within a multi-tenant setup

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_STOP_BATCH_BY_IDStop 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

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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_STOP_CALLCancel a queued or scheduled call before it starts.

Input Parameters

string
required
ID of the queued or scheduled call to stop.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_SUBMIT_VIOLATIONSubmit evidence for a Bolna violation and move it to submitted state.

Input Parameters

string
required
Unique identifier of the violation to submit.
object
required
Evidence image or document to attach to the violation.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_TEST_DISPOSITIONSRun every linked disposition against a transcript. Bolna invokes an LLM, so this can take tens of seconds.

Input Parameters

string
required
Agent whose linked dispositions should be tested.
string
Optional ISO 8601 timestamp representing the call date.
string
required
Transcript to evaluate, up to 50,000 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_TEST_WORKFLOW_WEBHOOKSend a sample terminal execution event to a workflow’s saved webhook.

Input Parameters

string
required
Unique identifier of the workflow whose webhook to test.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_AGENTTool 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

string
Optional user ID parameter for multi-user environments
string
required
The unique identifier (UUID) of the agent to update
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.).
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.
boolean
Flag to indicate if this is an API request. Defaults to false
string
Optional sub-account ID for multi-tenant scenarios

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_DISPOSITIONPartially update a disposition, with optional agent-scoped copy-on-write.

Input Parameters

string
New disposition name.
string
New extraction model.
string
Agent ID used for Bolna’s copy-on-write behavior on shared dispositions.
string
Legacy destination category name. Pass either category or category_id, not both.
string
New extraction question.
string
Destination extraction category ID. Pass either category_id or category, not both.
boolean
Whether the disposition selects from objective_options.
boolean
Whether the disposition produces a free-form value.
string
New system prompt.
string
required
Disposition ID to update.
string ("text" | "timestamp" | "numeric" | "boolean" | "email" | "regex")
New subjective output type.
array
New objective classification options.
object
Configuration for the subjective output type.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_EXTRACTION_CATEGORYRename an extraction category and/or change its extraction model.

Input Parameters

string
New category name.
string
New model for the category’s extraction pass.
string
required
Extraction category ID to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_SIP_TRUNKPartially update a SIP trunk; supplied gateway arrays replace existing arrays.

Input Parameters

string
Updated human-readable trunk name.
string
Comma-separated codecs to allow.
string
Comma-separated codecs to disallow.
array
Complete replacement list of SIP gateways.
string
required
Unique identifier of the SIP trunk to update.
boolean
Whether the trunk is active.
string ("transport-udp" | "transport-tcp" | "transport-tls")
Updated SIP transport protocol.
string
Updated internal trunk description.
string
Updated SIP password for a userpass trunk.
string
Updated SIP username for a userpass trunk.
array
Complete replacement list of allowed IP ranges.
boolean
Whether inbound calls are enabled.
string ("no" | "sdes")
Updated RTP encryption mode; sdes requires TLS transport.
integer
SIP OPTIONS ping interval in seconds; use 0 to disable.
boolean
Whether encrypted media may fall back to clear RTP.
boolean
Whether outbound numbers receive a leading plus sign.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_SUB_ACCOUNTPartially update an enterprise sub-account’s name or concurrency limits.

Input Parameters

string
Updated sub-account name.
string
required
Unique identifier of the sub-account to update.
integer
Updated hard concurrency cap; 0 pauses the sub-account.
integer
Updated guaranteed concurrency; 0 means no guarantee.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPDATE_WORKFLOW_SETTINGSApply an RFC 7396 merge patch to a workflow’s live settings.

Input Parameters

object
required
RFC 7396 merge patch for live workflow settings, for example {“webhook”:{“url”:“https://example.com/bolna”&#125;&#125;.
string
required
Unique identifier of the workflow to update.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_UPLOAD_WORKFLOW_CAMPAIGN_ENTRIESUpload 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

array
required
Contacts to add to the campaign.
string
required
ID of the campaign receiving contacts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: BOLNA_VALIDATE_WORKFLOWCheck a saved workflow draft for errors and warnings before publishing.

Input Parameters

string
required
Unique identifier of the workflow whose saved draft to validate.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not