Chatvolt
API integration

chatvolt_agents_query

Send a query to a specific agent in Chatvolt using id. Returns answer, conversationId, visitorId, messageId, sources (with text, score, and datasource info), and metadata. Requires query in the request body.

get_single_chatvolt_agent_by_id

Get a Chatvolt agent by its id or handle. Returns the agent object including id, name, modelName, visibility, tools, and timestamps. Required: id.

create_a_chatvolt_agent

Create a new Chatvolt agent. Returns the created agent object including id, name, modelName, visibility, and tools.

update_a_chatvolt_agent_by_id

Update a Chatvolt agent. Replaces the provided fields and the full tools array. Returns the updated agent object including id, name, modelName, and tools. Required: id.

delete_a_chatvolt_agent_by_id

Delete a Chatvolt agent by id. Returns the deleted agent object including id, name, modelName, and visibility. Required: id.

list_all_chatvolt_agent_blacklist

List all Chatvolt agent blacklist entries. Returns: id, agentId, userIdentify, organizationId, agent.

delete_a_chatvolt_agent_blacklist_by_id

Delete a Chatvolt agent blacklist entry by id. Returns an empty 204 response on success. Required: id.

create_a_chatvolt_agent_blacklist

Add one or more user identifiers to a Chatvolt agent blacklist. Returns the created blacklist entries, each with id, agentId, userIdentify, organizationId, and agent. Required: agentId, userIdentify.

chatvolt_agent_blacklist_get_by_agent_id

Get Chatvolt agent blacklist entries for a specific agent. Returns: id, agentId, userIdentify, organizationId, agent. Required: agent_blacklist_id.

get_single_chatvolt_conversation_by_id

Get a chatvolt conversation by id. Returns: id, title, unreadMessagesCount, isAiEnabled, channel, status, blocked, metadata, channelExternalId, channelCredentialsId, organizationId, mailInboxId, priority, formId, agentId, userId, visitorId, isGroup, frustration, aiUserIdentifier, whatsappChatLid, npsStep, npsRating, npsComment, npsStartedAt, npsCompletedAt, createdAt, updatedAt,…

chatvolt_conversations_assign

Assign a chatvolt conversation to a user or membership. Returns: success, message. Required: conversation_id. Provide one of email, id, or membershipId.

chatvolt_conversations_set_ai_enabled

Enable or disable AI for a chatvolt conversation. Returns: success, message. Required: conversation_id, enabled.

chatvolt_conversations_set_priority

Set the priority of a chatvolt conversation. Returns: success, message. Required: conversation_id, priority.

list_all_chatvolt_conversations

List chatvolt conversations with optional filters for agent, status, priority, channel, and date range. Returns: id, createdAt, updatedAt, success, message, newStepId, messageSent, sendMessageError, sentMessageId, initialMessage, stepAgentId, blockedBy24hRule, zapiAgentId, zapiPhoneNumber, zapiMessage.

delete_a_chatvolt_conversation_by_id

Delete a conversation in Chatvolt. Returns: success, message. Required: id.

chatvolt_conversations_set_status

Set the status of a Chatvolt conversation. Returns: success, message. Required: conversation_id, status.

chatvolt_conversation_messages_send

Send a message to a Chatvolt conversation by identifier type. Returns: success, message. Required: type, value, message.

chatvolt_conversation_messages_register

Register a message in a Chatvolt conversation context. Returns: success, message. Required: conversation_id, message.

list_all_chatvolt_conversation_messages

List messages from a Chatvolt conversation. Returns: status, isAiEnabled, userId, organizationId, messages. Required: conversation_id, count.

list_all_chatvolt_conversation_variables

List custom variables for a Chatvolt conversation. Returns: conversationId, varName, varValue, createdAt, updatedAt, success, message. Required: conversation_id.

get_single_chatvolt_conversation_variable_by_id

Get a single custom variable for a Chatvolt conversation by name. Returns: conversationId, varName, varValue, createdAt, updatedAt. Required: conversation_id, var_name.

create_a_chatvolt_conversation_variable

Create or update a Chatvolt conversation custom variable. Returns: conversationId, varName, varValue, createdAt, updatedAt. Required: conversationId, varName, varValue.

chatvolt_conversation_variables_bulk_delete

Delete a custom variable for a Chatvolt conversation. Returns: message, deleted. Required: conversation_id, var_name.

create_a_chatvolt_dispatch

Create or update a Chatvolt dispatch. Returns: id, name, createdAt, updatedAt. Required: name, status, agentId, crmScenarioId, crmStepId, contactListIds.

chatvolt_dispatches_populate_queue

Populate the queue for a Chatvolt dispatch. Clears existing entries and re-queues contacts using inclusion and exclusion rules. Returns: id, name, createdAt, updatedAt. Required: dispatche_id.

list_all_chatvolt_dispatches

List Chatvolt dispatches with optional filters. Returns: id, name, status, agentId, crmScenarioId, crmStepId, scheduledAt, templateMessage, interval, createdAt, updatedAt, totalCount, sentCount, errorCount, latestErrorMessage, defaultAssigneeId, defaultStatus.

chatvolt_dispatches_bulk_delete

Delete a Chatvolt dispatch by id. Returns: id, name, createdAt, updatedAt. Required: id.

chatvolt_whatsapp_templates_send

Send a WhatsApp template message to a contact through the registered WhatsApp Business account in Chatvolt. Returns the created conversation with id, channel, status, createdAt, updatedAt, and messages. Required: phone_number_id, to, text, agentId, templateName, templateLangCode.

create_a_chatvolt_whatsapp_template

Create a new WhatsApp message template in the associated WhatsApp Business Account (WABA). Returns the created template with id, name, language, status, category, and components. Required: agentId, name, category, language, components.

list_all_chatvolt_whatsapp_templates

List WhatsApp message templates from the associated WhatsApp Business Account (WABA). Returns: id, name, language, status, category, components. Required: agentId.

chatvolt_interactive_messages_send_location

Send a location map message to a chatvolt conversation. Returns the sent interactive message including agentId, conversationId, latitude, longitude, name, and address. Required: agentId, conversationId, latitude, longitude, name, address. Supported on WhatsApp, Z-API, and ZapperHUB.

chatvolt_interactive_messages_send_cta

Send a call-to-action message with a URL button to a chatvolt conversation. Returns the sent interactive message including agentId, conversationId, body_text, button_display_text, and button_url. Required: agentId, conversationId, body_text, button_display_text, button_url. Supported on WhatsApp and Z-API.

chatvolt_interactive_messages_request_location

Send a location request to a chatvolt conversation. Returns the sent interactive message including agentId, conversationId, and body_text. Required: agentId, conversationId, body_text. WhatsApp only.

chatvolt_interactive_messages_send_buttons

Send an interactive button message via Chatvolt. Supports up to 3 reply buttons on WhatsApp, Z-API, and ZapperHUB. Returns an empty 204 response on success. Required: agentId, conversationId, body_text, button_1_id, button_1_title. Button titles should be 20 characters max.

chatvolt_interactive_messages_send_list

Send an interactive list message via Chatvolt. The API reconstructs up to 10 sections and 10 rows from the flat request body. Returns an empty 204 response on success. Required: agentId, conversationId, body_text, button_text, section_1_title, section_1_row_1_id, section_1_row_1_title.

chatvolt_interactive_messages_send_contact

Send a WhatsApp contact card (vCard) through Chatvolt. Returns the Meta API delivery response including success, messaging_product, contacts, and message ids. Required: agent_id, conversation_id, name_formatted_name, name_first_name, and phone_1_phone. Supports optional name, phone, email, address, organization, URL, and birthday fields.

chatvolt_zapi_messages_send

Send a WhatsApp message via Chatvolt's Z-API integration. Returns the created message object including id, text, from, conversationId, createdAt, and updatedAt. Required: instance_id, contact_phone.

delete_a_chatvolt_crm_conversation_log_by_id

Delete a CRM conversation log in Chatvolt by id. Returns: message. Required: id.

update_a_chatvolt_crm_conversation_log_by_id

Update a CRM conversation log in Chatvolt by id. Returns the log including id, status, conversationId, scenarioId, stepId, createdAt, and updatedAt. Required: id, status.

list_all_chatvolt_crm_conversation_logs

List CRM conversation logs in Chatvolt. Returns logs including id, status, conversationId, scenarioId, stepId, createdAt, and updatedAt.

get_single_chatvolt_crm_conversation_log_by_id

Get a CRM conversation log in Chatvolt by id. Returns the log including id, status, conversationId, scenarioId, stepId, createdAt, and updatedAt. Required: id.

create_a_chatvolt_artifact_category

Create a new artifact category in chatvolt. Returns the created category including id, name, description, parentId, isActive, and children. Required: name.

delete_a_chatvolt_artifact_category_by_id

Delete an artifact category in chatvolt by id. Returns a confirmation message. Required: id.

update_a_chatvolt_artifact_category_by_id

Update an artifact category in chatvolt by id. Returns the updated category including id, name, description, parentId, isActive, and children. Required: id.

list_all_chatvolt_artifact_categories

List artifact categories in chatvolt. Returns a collection of categories with id, name, description, parentId, isActive, and children.

get_single_chatvolt_artifact_category_by_id

Get a single artifact category in chatvolt by id. Returns the category with id, name, description, parentId, isActive, and children. Required: id.

create_a_chatvolt_artifact

Create a new artifact in Chatvolt. Returns the created artifact including id, name, categoryId, isActive, createdAt, updatedAt, media, and category. Required: name, categoryId.

list_all_chatvolt_artifacts

List artifacts in Chatvolt. Returns each artifact with id, name, categoryId, isActive, createdAt, updatedAt, media, and category. Optional filters: categoryId, name, search.

get_single_chatvolt_artifact_by_id

Get a single Chatvolt artifact by id. Returns the artifact with id, name, categoryId, isActive, createdAt, updatedAt, media, and category. Required: id.

update_a_chatvolt_artifact_by_id

Update an existing Chatvolt artifact by id. Returns the updated artifact with id, name, categoryId, isActive, createdAt, updatedAt, media, and category. Required: id.

delete_a_chatvolt_artifact_by_id

Delete or toggle the active status of a Chatvolt artifact by id. Returns the affected artifact with id, name, categoryId, isActive, createdAt, updatedAt, media, and category. Required: id. Optional: action (delete or toggle, defaults to delete).

chatvolt_artifacts_bulk_delete

Bulk delete Chatvolt artifacts by IDs. Returns: count, message. Required: ids.

list_all_chatvolt_dispatch_contact_lists

List all contact lists in Chatvolt. Returns: id, name, createdAt, updatedAt. Optional: search.

create_a_chatvolt_dispatch_contact_list

Create or update a contact list in Chatvolt. Returns: id, name, createdAt, updatedAt. Required: name.

chatvolt_dispatch_contact_lists_bulk_delete

Delete one or more contact lists in Chatvolt. Returns: message. Required: id.

chatvolt_dispatch_contact_lists_bulk_update

Edit an existing contact list in Chatvolt. Returns: id, name, createdAt, updatedAt. Required: id, name.

delete_a_chatvolt_agent_whatsapp_whitelist_by_id

Remove a WhatsApp number from a chatvolt agent's whitelist. Returns: message. Required: id, whatsappNumber.

update_a_chatvolt_agent_whatsapp_whitelist_by_id

Update a whitelisted WhatsApp number for a chatvolt agent. Returns the updated entry with agentId and whatsappNumber. Required: id, oldWhatsappNumber, newWhatsappNumber.

create_a_chatvolt_agent_whatsapp_whitelist

Add a WhatsApp number to a chatvolt agent's whitelist. Returns an array of whitelist entries with agentId and whatsappNumber. Required: agentId, whatsappNumber.

get_single_chatvolt_agent_whatsapp_whitelist_by_id

Get the WhatsApp whitelist numbers for a chatvolt agent. Returns an array of entries with agentId and whatsappNumber. Required: id.

chatvolt_zapper_messages_send

Send a message through a Chatvolt Zapper instance. Returns the sent message including id, text, conversationId, from, createdAt, and updatedAt. Required: instance_id, message, contactPhone.

get_single_chatvolt_message_by_id

Get a single Chatvolt message by id. Returns the message including id, text, from, conversationId, sources, createdAt, and updatedAt. Required: id.

list_all_chatvolt_conversation_notes

List notes attached to a Chatvolt conversation. Returns: id, note, isPrivate, isJustification, conversationId, organizationId, userId, userEmail, notificationDateTime, sendDesktopNotification, createdAt, updatedAt. Required: conversation_id.

create_a_chatvolt_conversation_note

Create a note on a Chatvolt conversation. Returns the created note including id, note, isPrivate, isJustification, conversationId, organizationId, userId, userEmail, createdAt, and updatedAt. Required: conversation_id, note.

update_a_chatvolt_conversation_note_by_id

Update a note on a Chatvolt conversation. Returns: id, note, isPrivate, isJustification, conversationId, organizationId, userId, userEmail, notificationDateTime, sendDesktopNotification, createdAt, updatedAt. Required: conversation_id, id.

delete_a_chatvolt_conversation_note_by_id

Delete a note from a Chatvolt conversation. Returns an empty 204 response on success. Required: conversation_id, id.

create_a_chatvolt_dispatch_contact_link

Link a contact list to a dispatch in Chatvolt. Returns the created link with dispatchId, contactListId, and isExcluded. Required: dispatchId, contactListId.

chatvolt_dispatch_contact_links_bulk_delete

Unlink a contact list from a dispatch in Chatvolt. Returns: message, id, organizationId, email, phoneNumber, firstName, lastName, externalId, picture, metadata, createdAt, updatedAt. Required: dispatchId, contactListId. Endpoint not yet implemented.

list_all_chatvolt_crm_scenarios

List CRM scenarios in Chatvolt. Returns: id, name, description, organizationId, createdAt, updatedAt, message, scenario, user. Optional filter: agentId.

create_a_chatvolt_crm_scenario

Create a new CRM scenario in Chatvolt. Returns: id, name, description, organizationId, createdAt, updatedAt. Required: name.

update_a_chatvolt_crm_scenario_by_id

Update a CRM scenario in Chatvolt by id. Returns: message, scenario. Required: id, name.

delete_a_chatvolt_crm_scenario_by_id

Delete a CRM scenario in Chatvolt by id. Returns: message, scenario, user. Required: id.

chatvolt_crm_scenarios_delete_by_body

Delete a CRM scenario in Chatvolt. Returns: message, scenario, user. Required: id.

chatvolt_crm_scenarios_bulk_update

Update a CRM scenario in Chatvolt. Returns: message, scenario. Required: id, name.

list_all_chatvolt_crm_scenario_conversations

List conversations linked to a Chatvolt CRM scenario. Returns: id, scenarioId, conversationId, stepId, organizationId, createdAt, updatedAt, available, conversation, step. Required: scenario_id.

chatvolt_crm_scenario_conversations_bulk_delete

Remove a conversation from a Chatvolt CRM scenario. Returns: message. Required: scenario_id, conversationId.

list_all_chatvolt_crm_steps

List CRM steps in a Chatvolt scenario. Returns: id, name, index, prompt, trigger, initialMessage, autoNextStepId, autoNextTime, autoNextTimeUnit, defaultStatus, defaultPriority, defaultAiControl, assigneeLogicType, selectedMembershipIdsForAssignee, isRequired, isConversationRemovalStep, defaultTags, defaultTagsToRemove, requestContact, organizationId, agentId, scenarioId, zapi, whatsapp,…

create_a_chatvolt_crm_step

Create a CRM step in Chatvolt. Returns the created step with id, name, index, scenario, and trigger settings. Required: name, scenarioId, trigger.

update_a_chatvolt_crm_step_by_id

Update a CRM step in Chatvolt by id. Returns the updated step with id, name, index, scenario, and trigger settings. Required: id, name.

delete_a_chatvolt_crm_step_by_id

Delete a CRM step in Chatvolt by id. Returns the deleted step with id, name, index, and scenario. Required: id.

chatvolt_crm_steps_add_conversation

Add a conversation to a CRM step in Chatvolt. Returns success, newStepId, messageSent, and message-sending details. Required: conversationId plus either stepId or scenarioId.

chatvolt_crm_steps_move_conversation

Move a Chatvolt conversation to a specific CRM step. Returns the operation result including success, message, newStepId, messageSent, and sendMessageError. Required: conversationId.

chatvolt_twilio_send

Send an SMS message to a contact via the Chatvolt Twilio integration. Returns the sent message object including id, text, from, conversationId, createdAt, and updatedAt. Required: owner_phone, contact_phone, message.

list_all_chatvolt_mercadolivre

List Mercado Livre products from Chatvolt with optional fuzzy search filters. Returns: id, success, messaging_product, contacts, messages. Required: agentId.

delete_a_chatvolt_media_by_id

Delete a media item in Chatvolt by id. Returns: success. Required: id.

list_all_chatvolt_media

List media for a Chatvolt artifact. Returns: id, mediaType, s3Url, name, altDescription, isActive, createdAt. Required: artifact_id.

update_a_chatvolt_media_by_id

Update a media item in Chatvolt by id. Returns: id, mediaType, s3Url, name, altDescription, isActive, createdAt. Required: id.

create_a_chatvolt_media

Upload a media file to a Chatvolt artifact. Returns: s3Key, fileUrl, artifactMedia. Required: file, artifact_id, name.

get_single_chatvolt_dispatch_contact_by_id

Get a single Chatvolt dispatch contact by id. Returns: id, name, phoneNumber, contactListId, createdAt, updatedAt. Required: id.

create_a_chatvolt_dispatch_contact

Create a new dispatch contact in Chatvolt. Returns the created contact with id, name, phoneNumber, contactListId, createdAt, and updatedAt.

chatvolt_dispatch_contacts_bulk_delete

Bulk delete dispatch contacts in Chatvolt. Returns an empty 204 response on success.

chatvolt_agent_integrations_bulk_update

Enable or disable a Chatvolt agent integration webhook. Returns a string confirmation message such as "whatsapp webhook enabled". Required: agent_id, type, enabled.

list_all_chatvolt_datastores

List Chatvolt AI datastores. Returns: id, name, description, type, isPublic, pluginName, pluginDescriptionForHumans.

create_a_chatvolt_datastore

Create a Chatvolt AI datastore. Returns the new datastore with id, name, type, isPublic, and plugin metadata. Required: type.

delete_a_chatvolt_datastore_by_id

Delete a Chatvolt AI datastore by id. Returns the deleted datastore with id, name, type, isPublic, and plugin metadata. Required: id.

update_a_chatvolt_datastore_by_id

Update a Chatvolt AI datastore by id. Returns the updated datastore with id, name, type, isPublic, and plugin metadata. Required: id.

get_single_chatvolt_datastore_by_id

Get a Chatvolt AI datastore by id. Returns the datastore with id, name, type, isPublic, and plugin metadata. Required: id.

chatvolt_datastores_query

Query a Chatvolt datastore to retrieve relevant chunks matching the query. Returns an array of matching chunks, each with text, score, source, datasource_id, datasource_name, and tags. Required: datastore_id, query.

list_all_chatvolt_datasources

List datasources in a Chatvolt datastore. Returns: id, type, name, status, groupId, updatedAt, createdAt, lastSynch, config. Required: datastoreId.

get_single_chatvolt_datasource_by_id

Get a Chatvolt datasource by id. Returns: id, type, name, status, groupId, updatedAt, createdAt, lastSynch, config. Required: id, idstore.

delete_a_chatvolt_datasource_by_id

Delete a Chatvolt datasource by id. Returns: id, type, name, status, groupId, updatedAt, createdAt, lastSynch, config. Required: id.

create_a_chatvolt_datasource

Create a Chatvolt datasource from a file, web page, web site, or QA set. Returns: id, type, name, status, groupId, updatedAt, createdAt, lastSynch, config. Required: file, type, datastoreId.

list_all_chatvolt_agent_tools

List tools configured for a Chatvolt agent. Returns: id, type, datastoreId, config. Required: agent_id.

update_a_chatvolt_agent_tool_by_id

Update an existing tool for a Chatvolt agent. Returns: id, type, success. Required: agent_id, id, type.

create_a_chatvolt_agent_tool

Create a new tool for a Chatvolt agent. Returns: id, type, datastoreId, config. Required: agent_id, type.

delete_a_chatvolt_agent_tool_by_id

Delete a tool from a Chatvolt agent. Returns: success. Required: agent_id, id.

list_all_chatvolt_contacts

List Chatvolt contacts. Returns: id, organizationId, email, phoneNumber, firstName, lastName, externalId, picture, metadata, createdAt, updatedAt. Filter by search, crm_scenario, crm_step, conversation_status, priority, start_date, end_date, has_email, has_phone, channel, or tags.

create_a_chatvolt_contact

Create or update a Chatvolt contact by email or phone number. Returns the contact object including id, email, organizationId, createdAt, and updatedAt.

list_all_chatvolt_contact_variables

List contact variables for a chatvolt contact or conversation. Returns the variables key-value store and a formatted variableList with varName, varValue, and source. Required: id (unless the `conversationid` header is set).

create_a_chatvolt_contact_variable

Create or update a contact variable for a chatvolt contact. Returns the contact variables key-value store under the `variables` key. Required: key, value, source.

chatvolt_contact_variables_bulk_delete

Delete a contact variable in chatvolt. Returns the remaining contact variables object. Required: id. Optional: key (omit to delete all variables).

chatvolt_contact_variables_bulk_update

Update a contact variable for a chatvolt contact. Returns the updated contact variables key-value store under the `variables` key. Required: key, value, source.

list_all_chatvolt_artifacts_search

Search Chatvolt artifacts by keyword, price range, category, or media type. Returns matching artifacts including id, name, description, price, category, media, and timestamps.