# Voxys Connect Developer Docs

> Official developer documentation for Voxys Connect - the omnichannel CPaaS platform for MENA businesses. Learn about our APIs and integrations.

## Docs

- [Create an Agent Bot](https://developers.voxys.ai/api-reference/account-agentbots/create-an-agent-bot.md): Create an agent bot in the account
- [Delete an AgentBot](https://developers.voxys.ai/api-reference/account-agentbots/delete-an-agentbot.md): Delete an AgentBot from the account
- [Get an agent bot details](https://developers.voxys.ai/api-reference/account-agentbots/get-an-agent-bot-details.md): Get the details of an agent bot in the account
- [List all AgentBots](https://developers.voxys.ai/api-reference/account-agentbots/list-all-agentbots.md): List all agent bots available for the current account
- [Update an agent bot](https://developers.voxys.ai/api-reference/account-agentbots/update-an-agent-bot.md): Update an agent bot's attributes
- [Get account details](https://developers.voxys.ai/api-reference/account/get-account-details.md): Get the details of the current account
- [Update account](https://developers.voxys.ai/api-reference/account/update-account.md): Update account details, settings, and custom attributes
- [Add a New Agent](https://developers.voxys.ai/api-reference/agents/add-a-new-agent.md): Add a new Agent to Account
- [List Agents in Account](https://developers.voxys.ai/api-reference/agents/list-agents-in-account.md): Get Details of Agents in an Account
- [Remove an Agent from Account](https://developers.voxys.ai/api-reference/agents/remove-an-agent-from-account.md): Remove an Agent from Account
- [Update Agent in Account](https://developers.voxys.ai/api-reference/agents/update-agent-in-account.md): Update an Agent in Account
- [Create appointment service](https://developers.voxys.ai/api-reference/appointment-services/create-appointment-service.md): Creates a new bookable service.
- [List appointment services](https://developers.voxys.ai/api-reference/appointment-services/list-appointment-services.md): Returns all bookable services for the account.
- [Update appointment service](https://developers.voxys.ai/api-reference/appointment-services/update-appointment-service.md): Updates an existing appointment service.
- [Cancel appointment](https://developers.voxys.ai/api-reference/appointments/cancel-appointment.md): Cancels an appointment with an optional reason.
- [Check availability](https://developers.voxys.ai/api-reference/appointments/check-availability.md): Returns available time slots for a provider and service on a given date.
- [Complete appointment](https://developers.voxys.ai/api-reference/appointments/complete-appointment.md): Marks an appointment as completed.
- [Confirm appointment](https://developers.voxys.ai/api-reference/appointments/confirm-appointment.md): Confirms a pending appointment.
- [Create appointment](https://developers.voxys.ai/api-reference/appointments/create-appointment.md): Creates a new appointment.
- [List appointments](https://developers.voxys.ai/api-reference/appointments/list-appointments.md): Returns appointments with optional filters.
- [Reschedule appointment](https://developers.voxys.ai/api-reference/appointments/reschedule-appointment.md): Reschedules an existing appointment to a new time.
- [List Audit Logs in Account](https://developers.voxys.ai/api-reference/audit-logs/list-audit-logs-in-account.md): Get Details of Audit Log entries for an Account. This endpoint is only available in Enterprise editions and requires the audit_logs feature to be enabled.
- [Add a new automation rule](https://developers.voxys.ai/api-reference/automation-rule/add-a-new-automation-rule.md): Add a new automation rule to account
- [Get a automation rule details](https://developers.voxys.ai/api-reference/automation-rule/get-a-automation-rule-details.md): Get the details of a automation rule in the account
- [List all automation rules in an account](https://developers.voxys.ai/api-reference/automation-rule/list-all-automation-rules-in-an-account.md): Get details of automation rules in an Account
- [Remove a automation rule from account](https://developers.voxys.ai/api-reference/automation-rule/remove-a-automation-rule-from-account.md): Remove a automation rule from account
- [Update automation rule in Account](https://developers.voxys.ai/api-reference/automation-rule/update-automation-rule-in-account.md): Update a automation rule in account
- [Create campaign schedule](https://developers.voxys.ai/api-reference/campaigns-extended/create-campaign-schedule.md): Creates a scheduler entry for a campaign.
- [Create contact list](https://developers.voxys.ai/api-reference/campaigns-extended/create-contact-list.md): Creates a new campaign contact list.
- [Execution details](https://developers.voxys.ai/api-reference/campaigns-extended/execution-details.md): Returns paginated execution-level details for a campaign, optionally filtered by status.
- [List contact lists](https://developers.voxys.ai/api-reference/campaigns-extended/list-contact-lists.md): Returns all campaign contact lists for the account.
- [Pause execution](https://developers.voxys.ai/api-reference/campaigns-extended/pause-execution.md): Pauses an in-progress campaign execution.
- [Real-time progress](https://developers.voxys.ai/api-reference/campaigns-extended/real-time-progress.md): Returns live progress data for a running campaign execution.
- [Resume execution](https://developers.voxys.ai/api-reference/campaigns-extended/resume-execution.md): Resumes a paused campaign execution.
- [Show campaign analytics](https://developers.voxys.ai/api-reference/campaigns-extended/show-campaign-analytics.md): Returns aggregate analytics for the specified campaign.
- [Show campaign schedule](https://developers.voxys.ai/api-reference/campaigns-extended/show-campaign-schedule.md): Returns the scheduler configuration for a campaign.
- [Trigger a campaign](https://developers.voxys.ai/api-reference/campaigns-extended/trigger-a-campaign.md): Manually trigger execution of a campaign.
- [Upload contact list CSV](https://developers.voxys.ai/api-reference/campaigns-extended/upload-contact-list-csv.md): Upload a CSV file to bulk-create a contact list.
- [Upload CSV audience](https://developers.voxys.ai/api-reference/campaigns-extended/upload-csv-audience.md): Upload a CSV file to set the audience for a campaign.
- [Add a New Canned Response](https://developers.voxys.ai/api-reference/canned-responses/add-a-new-canned-response.md): Add a new Canned Response to Account
- [List all Canned Responses in an Account](https://developers.voxys.ai/api-reference/canned-responses/list-all-canned-responses-in-an-account.md): Get Details of Canned Responses in an Account
- [Remove a Canned Response from Account](https://developers.voxys.ai/api-reference/canned-responses/remove-a-canned-response-from-account.md): Remove a Canned Response from Account
- [Update Canned Response in Account](https://developers.voxys.ai/api-reference/canned-responses/update-canned-response-in-account.md): Update a Canned Response in Account
- [Add a contact to a company](https://developers.voxys.ai/api-reference/companies/add-a-contact-to-a-company.md): Associates an existing contact with the company.
- [Create a company](https://developers.voxys.ai/api-reference/companies/create-a-company.md): Creates a new company.
- [Delete a company](https://developers.voxys.ai/api-reference/companies/delete-a-company.md): Permanently deletes a company.
- [Find company duplicates](https://developers.voxys.ai/api-reference/companies/find-company-duplicates.md): Returns a list of companies that may be duplicates of the given company, based on name or domain similarity.
- [Get a company](https://developers.voxys.ai/api-reference/companies/get-a-company.md): Returns details for a single company.
- [Get company timeline](https://developers.voxys.ai/api-reference/companies/get-company-timeline.md): Returns chronological activity events associated with a company.
- [List companies](https://developers.voxys.ai/api-reference/companies/list-companies.md): Returns a paginated list of companies.
- [List company contacts](https://developers.voxys.ai/api-reference/companies/list-company-contacts.md): Returns all contacts associated with the company.
- [Merge companies](https://developers.voxys.ai/api-reference/companies/merge-companies.md): Merges the source company into a target company. All contacts and data are moved to the target; the source is deleted.
- [Remove a contact from a company](https://developers.voxys.ai/api-reference/companies/remove-a-contact-from-a-company.md): Disassociates a contact from the company (does not delete the contact).
- [Search companies](https://developers.voxys.ai/api-reference/companies/search-companies.md): Full-text search across company names and domains.
- [Update a company](https://developers.voxys.ai/api-reference/companies/update-a-company.md): Updates fields of an existing company.
- [Add Labels](https://developers.voxys.ai/api-reference/contact-labels/add-labels.md): Add labels to a contact. Note that this API would overwrite the existing list of labels associated to the conversation.
- [List Labels](https://developers.voxys.ai/api-reference/contact-labels/list-labels.md): Lists all the labels of a contact
- [Create a contact](https://developers.voxys.ai/api-reference/contacts-api/create-a-contact.md): Create a contact
- [Get a contact](https://developers.voxys.ai/api-reference/contacts-api/get-a-contact.md): Get the details of a contact
- [Update a contact](https://developers.voxys.ai/api-reference/contacts-api/update-a-contact.md): Update a contact's attributes
- [Contact Conversations](https://developers.voxys.ai/api-reference/contacts/contact-conversations.md): Get conversations associated with that contact
- [Contact Filter](https://developers.voxys.ai/api-reference/contacts/contact-filter.md): Filter contacts with custom filter options and pagination
- [Create Contact](https://developers.voxys.ai/api-reference/contacts/create-contact.md): Create a new Contact
- [Create contact inbox](https://developers.voxys.ai/api-reference/contacts/create-contact-inbox.md): Create a contact inbox record for an inbox
- [Delete Contact](https://developers.voxys.ai/api-reference/contacts/delete-contact.md): Delete a contact belonging to the account using ID
- [Get Contactable Inboxes](https://developers.voxys.ai/api-reference/contacts/get-contactable-inboxes.md): Get List of contactable Inboxes
- [List Contacts](https://developers.voxys.ai/api-reference/contacts/list-contacts.md): Listing all the resolved contacts with pagination (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
- [Merge Contacts](https://developers.voxys.ai/api-reference/contacts/merge-contacts.md): Merge two contacts into a single contact. The base contact remains and receives all data from the mergee contact. After the merge, the mergee contact is permanently deleted.
- [Search Contacts](https://developers.voxys.ai/api-reference/contacts/search-contacts.md): Search the resolved contacts using a search key, currently supports email search (Page size = 15). Resolved contacts are the ones with a value for identifier, email or phone number
- [Show Contact](https://developers.voxys.ai/api-reference/contacts/show-contact.md): Get a contact belonging to the account using ID
- [Update Contact](https://developers.voxys.ai/api-reference/contacts/update-contact.md): Update a contact belonging to the account using ID
- [Assign Conversation](https://developers.voxys.ai/api-reference/conversation-assignments/assign-conversation.md): Assign a conversation to an agent or a team
- [Convert conversation to deal](https://developers.voxys.ai/api-reference/conversation-crm/convert-conversation-to-deal.md): Converts a lead linked to the conversation into a pipeline card (deal) in the specified funnel and stage.
- [Get conversation CRM sidebar](https://developers.voxys.ai/api-reference/conversation-crm/get-conversation-crm-sidebar.md): Returns CRM data associated with a conversation, including linked lead, pipeline card, and follow-up tasks.
- [Link lead to conversation](https://developers.voxys.ai/api-reference/conversation-crm/link-lead-to-conversation.md): Associates an existing lead with the conversation.
- [Link pipeline to conversation](https://developers.voxys.ai/api-reference/conversation-crm/link-pipeline-to-conversation.md): Associates an existing pipeline card (deal) with the conversation.
- [Unlink pipeline from conversation](https://developers.voxys.ai/api-reference/conversation-crm/unlink-pipeline-from-conversation.md): Removes the pipeline card association from the conversation. The card is not deleted.
- [Create a conversation](https://developers.voxys.ai/api-reference/conversations-api/create-a-conversation.md): Create a conversation
- [Get a single conversation](https://developers.voxys.ai/api-reference/conversations-api/get-a-single-conversation.md): Retrieves the details of a specific conversation
- [List all conversations](https://developers.voxys.ai/api-reference/conversations-api/list-all-conversations.md): List all conversations for the contact
- [Resolve a conversation](https://developers.voxys.ai/api-reference/conversations-api/resolve-a-conversation.md): Marks a conversation as resolved
- [Toggle typing status](https://developers.voxys.ai/api-reference/conversations-api/toggle-typing-status.md): Toggles the typing status in a conversation
- [Update last seen](https://developers.voxys.ai/api-reference/conversations-api/update-last-seen.md): Updates the last seen time of the contact in a conversation
- [Add Labels](https://developers.voxys.ai/api-reference/conversations/add-labels.md): Add labels to a conversation. Note that this API would overwrite the existing list of labels associated to the conversation.
- [Conversation Details](https://developers.voxys.ai/api-reference/conversations/conversation-details.md): Get all details regarding a conversation with all messages in the conversation
- [Conversation Reporting Events](https://developers.voxys.ai/api-reference/conversations/conversation-reporting-events.md): Get reporting events for a specific conversation. This endpoint returns events such as first response time, resolution time, and other metrics for the conversation, sorted by creation time in ascending order.
- [Conversations Filter](https://developers.voxys.ai/api-reference/conversations/conversations-filter.md): Filter conversations with custom filter options and pagination
- [Conversations List](https://developers.voxys.ai/api-reference/conversations/conversations-list.md): List all the conversations with pagination
- [Create New Conversation](https://developers.voxys.ai/api-reference/conversations/create-new-conversation.md): Creating a conversation in chatwoot requires a source id.
- [Get Conversation Counts](https://developers.voxys.ai/api-reference/conversations/get-conversation-counts.md): Get open, unassigned and all Conversation counts
- [List Labels](https://developers.voxys.ai/api-reference/conversations/list-labels.md): Lists all the labels of a conversation
- [Toggle Priority](https://developers.voxys.ai/api-reference/conversations/toggle-priority.md): Toggles the priority of conversation
- [Toggle Status](https://developers.voxys.ai/api-reference/conversations/toggle-status.md): Toggle the status of a conversation. Pass `status` to explicitly set the conversation state. Use `snoozed` along with `snoozed_until` to snooze a conversation until a specific time. If `snoozed_until` is omitted, the conversation is snoozed until the next reply from the contact. Regardless of the va…
- [Toggle Typing Status](https://developers.voxys.ai/api-reference/conversations/toggle-typing-status.md): Toggles the typing status for a conversation.
- [Update Conversation](https://developers.voxys.ai/api-reference/conversations/update-conversation.md): Update Conversation Attributes
- [Update Custom Attributes](https://developers.voxys.ai/api-reference/conversations/update-custom-attributes.md): Updates the custom attributes of a conversation
- [Get CSAT survey page](https://developers.voxys.ai/api-reference/csat-survey-page/get-csat-survey-page.md): You can redirect the client to this URL, instead of implementing the CSAT survey component yourself.
- [Add a new custom attribute](https://developers.voxys.ai/api-reference/custom-attributes/add-a-new-custom-attribute.md): Add a new custom attribute to account
- [Get a custom attribute details](https://developers.voxys.ai/api-reference/custom-attributes/get-a-custom-attribute-details.md): Get the details of a custom attribute in the account
- [List all custom attributes in an account](https://developers.voxys.ai/api-reference/custom-attributes/list-all-custom-attributes-in-an-account.md): Get details of custom attributes in an Account
- [Remove a custom attribute from account](https://developers.voxys.ai/api-reference/custom-attributes/remove-a-custom-attribute-from-account.md): Remove a custom attribute from account
- [Update custom attribute in Account](https://developers.voxys.ai/api-reference/custom-attributes/update-custom-attribute-in-account.md): Update a custom attribute in account
- [Create a custom filter](https://developers.voxys.ai/api-reference/custom-filters/create-a-custom-filter.md): Create a custom filter in the account
- [Delete a custom filter](https://developers.voxys.ai/api-reference/custom-filters/delete-a-custom-filter.md): Delete a custom filter from the account
- [Get a custom filter details](https://developers.voxys.ai/api-reference/custom-filters/get-a-custom-filter-details.md): Get the details of a custom filter in the account
- [List all custom filters](https://developers.voxys.ai/api-reference/custom-filters/list-all-custom-filters.md): List all custom filters in a category of a user
- [Update a custom filter](https://developers.voxys.ai/api-reference/custom-filters/update-a-custom-filter.md): Update a custom filter's attributes
- [Agent performance](https://developers.voxys.ai/api-reference/customer-pulse/agent-performance.md): Returns sentiment-based performance metrics per agent.
- [Bulk analyze conversations](https://developers.voxys.ai/api-reference/customer-pulse/bulk-analyze-conversations.md): Triggers bulk sentiment analysis for past conversations.
- [List sentiment data](https://developers.voxys.ai/api-reference/customer-pulse/list-sentiment-data.md): Returns sentiment data for conversations with optional filters and grouping.
- [Pulse metrics](https://developers.voxys.ai/api-reference/customer-pulse/pulse-metrics.md): Returns detailed Customer Pulse metrics including trend data.
- [Sentiment summary](https://developers.voxys.ai/api-reference/customer-pulse/sentiment-summary.md): Returns aggregate sentiment summary counts and percentages.
- [Update pulse settings](https://developers.voxys.ai/api-reference/customer-pulse/update-pulse-settings.md): Updates Customer Pulse configuration such as escalation thresholds.
- [Calendar view of tasks](https://developers.voxys.ai/api-reference/follow-up-tasks/calendar-view-of-tasks.md): Returns follow-up tasks within a date range, suitable for rendering in a calendar view.
- [Complete a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/complete-a-follow-up-task.md): Marks a follow-up task as completed and records the completion timestamp.
- [Create a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/create-a-follow-up-task.md): Creates a new follow-up task, optionally attached to a lead, deal, conversation, or contact.
- [Delete a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/delete-a-follow-up-task.md): Permanently deletes a follow-up task.
- [Get a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/get-a-follow-up-task.md): Returns details for a single follow-up task.
- [List follow-up tasks](https://developers.voxys.ai/api-reference/follow-up-tasks/list-follow-up-tasks.md): Returns a paginated list of follow-up tasks, with optional filtering.
- [Snooze a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/snooze-a-follow-up-task.md): Snoozes a task for the specified duration, updating its due_at and setting status to snoozed.
- [Update a follow-up task](https://developers.voxys.ai/api-reference/follow-up-tasks/update-a-follow-up-task.md): Updates fields of an existing follow-up task.
- [Add a new article](https://developers.voxys.ai/api-reference/help-center/add-a-new-article.md): Add a new article to portal
- [Add a new category](https://developers.voxys.ai/api-reference/help-center/add-a-new-category.md): Add a new category to portal
- [Add a new portal](https://developers.voxys.ai/api-reference/help-center/add-a-new-portal.md): Add a new portal to account
- [List all portals in an account](https://developers.voxys.ai/api-reference/help-center/list-all-portals-in-an-account.md): Get details of portals in an Account
- [Update a portal](https://developers.voxys.ai/api-reference/help-center/update-a-portal.md): Update a portal to account
- [Add a New Agent](https://developers.voxys.ai/api-reference/inboxes/add-a-new-agent.md): Add a new Agent to Inbox
- [Add or remove agent bot](https://developers.voxys.ai/api-reference/inboxes/add-or-remove-agent-bot.md): To add an agent bot pass agent_bot id, to remove agent bot from an inbox pass null
- [Create an inbox](https://developers.voxys.ai/api-reference/inboxes/create-an-inbox.md): You can create more than one website inbox in each account
- [Get an inbox](https://developers.voxys.ai/api-reference/inboxes/get-an-inbox.md): Get an inbox available in the current account
- [List Agents in Inbox](https://developers.voxys.ai/api-reference/inboxes/list-agents-in-inbox.md): Get Details of Agents in an Inbox
- [List all inboxes](https://developers.voxys.ai/api-reference/inboxes/list-all-inboxes.md): List all inboxes available in the current account
- [Remove an Agent from Inbox](https://developers.voxys.ai/api-reference/inboxes/remove-an-agent-from-inbox.md): Remove an Agent from Inbox
- [Show Inbox Agent Bot](https://developers.voxys.ai/api-reference/inboxes/show-inbox-agent-bot.md): See if an agent bot is associated to the Inbox
- [Update Agents in Inbox](https://developers.voxys.ai/api-reference/inboxes/update-agents-in-inbox.md): All agents except the one passed in params will be removed
- [Update Inbox](https://developers.voxys.ai/api-reference/inboxes/update-inbox.md): Update an existing inbox
- [Create an integration hook](https://developers.voxys.ai/api-reference/integrations/create-an-integration-hook.md): Create an integration hook
- [Delete an Integration Hook](https://developers.voxys.ai/api-reference/integrations/delete-an-integration-hook.md): Delete an Integration Hook
- [List all the Integrations](https://developers.voxys.ai/api-reference/integrations/list-all-the-integrations.md): Get the details of all Integrations available for the account
- [Update an Integration Hook](https://developers.voxys.ai/api-reference/integrations/update-an-integration-hook.md): Update an Integration Hook
- [Create internal channel](https://developers.voxys.ai/api-reference/internal-channels/create-internal-channel.md): Creates a new internal team channel.
- [List channel messages](https://developers.voxys.ai/api-reference/internal-channels/list-channel-messages.md): Returns messages in an internal channel.
- [List internal channels](https://developers.voxys.ai/api-reference/internal-channels/list-internal-channels.md): Returns all internal team channels for the account.
- [Pin message](https://developers.voxys.ai/api-reference/internal-channels/pin-message.md): Pins a message in an internal channel.
- [Send message to channel](https://developers.voxys.ai/api-reference/internal-channels/send-message-to-channel.md): Sends a message to an internal channel.
- [Introduction to Voxys Connect APIs](https://developers.voxys.ai/api-reference/introduction.md): Learn how to use Voxys Connect APIs to build integrations, customize chat experiences, and automate workflows.
- [Create a label](https://developers.voxys.ai/api-reference/labels/create-a-label.md): Create a label in the account
- [Delete a label](https://developers.voxys.ai/api-reference/labels/delete-a-label.md): Delete a label from the account
- [Get a label](https://developers.voxys.ai/api-reference/labels/get-a-label.md): Get the details of a label in the account
- [List all labels](https://developers.voxys.ai/api-reference/labels/list-all-labels.md): List all labels available in the current account
- [Update a label](https://developers.voxys.ai/api-reference/labels/update-a-label.md): Update a label's attributes
- [Export leads CSV](https://developers.voxys.ai/api-reference/leads-reports/export-leads-csv.md): Downloads a CSV file with detailed leads pipeline data.
- [Leads summary](https://developers.voxys.ai/api-reference/leads-reports/leads-summary.md): Returns aggregate leads pipeline summary metrics.
- [Leads timeseries](https://developers.voxys.ai/api-reference/leads-reports/leads-timeseries.md): Returns time-series data for leads pipeline activity.
- [Bulk action on leads](https://developers.voxys.ai/api-reference/leads/bulk-action-on-leads.md): Perform a bulk action (assign, change status, delete) on multiple leads at once.
- [Change lead status](https://developers.voxys.ai/api-reference/leads/change-lead-status.md): Changes the status of a lead (e.g., open, won, lost, snoozed) with optional notes.
- [Convert lead to deal](https://developers.voxys.ai/api-reference/leads/convert-lead-to-deal.md): Converts a lead into a pipeline card (deal) in the specified funnel and optional stage.
- [Create a lead](https://developers.voxys.ai/api-reference/leads/create-a-lead.md): Creates a new lead in the account.
- [Create a lead note](https://developers.voxys.ai/api-reference/leads/create-a-lead-note.md): Adds a new note to a lead.
- [Delete a lead](https://developers.voxys.ai/api-reference/leads/delete-a-lead.md): Permanently deletes a lead.
- [Get a lead](https://developers.voxys.ai/api-reference/leads/get-a-lead.md): Returns details for a single lead.
- [Get lead stats](https://developers.voxys.ai/api-reference/leads/get-lead-stats.md): Returns aggregate statistics for leads in the account.
- [List lead notes](https://developers.voxys.ai/api-reference/leads/list-lead-notes.md): Returns all notes attached to a lead.
- [List leads](https://developers.voxys.ai/api-reference/leads/list-leads.md): Returns a paginated list of leads for the account, with optional filtering and sorting.
- [Update a lead](https://developers.voxys.ai/api-reference/leads/update-a-lead.md): Updates fields of an existing lead.
- [Create a message](https://developers.voxys.ai/api-reference/messages-api/create-a-message.md): Create a message
- [List all messages](https://developers.voxys.ai/api-reference/messages-api/list-all-messages.md): List all messages in the conversation
- [Update a message](https://developers.voxys.ai/api-reference/messages-api/update-a-message.md): Update a message
- [Create New Message](https://developers.voxys.ai/api-reference/messages/create-new-message.md): Create a new message in the conversation.
- [Delete a message](https://developers.voxys.ai/api-reference/messages/delete-a-message.md): Delete a message and it's attachments from the conversation.
- [Get messages](https://developers.voxys.ai/api-reference/messages/get-messages.md): List all messages of a conversation
- [By-template breakdown](https://developers.voxys.ai/api-reference/outbound-reports/by-template-breakdown.md): Returns per-template performance breakdown with delivery and read rates.
- [Export CSV](https://developers.voxys.ai/api-reference/outbound-reports/export-csv.md): Downloads a CSV file with detailed outbound message data including phone number, contact name, status, timestamps, campaign name, template name, language, and category.
- [Outbound message timeseries](https://developers.voxys.ai/api-reference/outbound-reports/outbound-message-timeseries.md): Returns time-series data for outbound messages (campaigns and manual template sends).
- [Outbound reports summary](https://developers.voxys.ai/api-reference/outbound-reports/outbound-reports-summary.md): Returns aggregate totals for sent, delivered, read, and failed outbound messages.
- [Create a pipeline](https://developers.voxys.ai/api-reference/pipelines/create-a-pipeline.md): Creates a new pipeline (funnel).
- [Create a pipeline card](https://developers.voxys.ai/api-reference/pipelines/create-a-pipeline-card.md): Creates a new card (deal) in a pipeline. You may link an existing lead or provide lead fields to create one inline.
- [Create a pipeline stage](https://developers.voxys.ai/api-reference/pipelines/create-a-pipeline-stage.md): Adds a new stage to a pipeline.
- [Delete a pipeline](https://developers.voxys.ai/api-reference/pipelines/delete-a-pipeline.md): Permanently deletes a pipeline and all its stages and cards.
- [Delete a pipeline card](https://developers.voxys.ai/api-reference/pipelines/delete-a-pipeline-card.md): Permanently deletes a pipeline card.
- [Delete a pipeline stage](https://developers.voxys.ai/api-reference/pipelines/delete-a-pipeline-stage.md): Deletes a pipeline stage. Cards in the stage must be moved or deleted beforehand.
- [Get a pipeline](https://developers.voxys.ai/api-reference/pipelines/get-a-pipeline.md): Returns details for a single pipeline.
- [Get card history](https://developers.voxys.ai/api-reference/pipelines/get-card-history.md): Returns the full activity history for a pipeline card (stage moves, field changes, etc.).
- [Get pipeline analytics](https://developers.voxys.ai/api-reference/pipelines/get-pipeline-analytics.md): Returns detailed analytics for a pipeline within a date range, optionally grouped.
- [Get pipeline stats](https://developers.voxys.ai/api-reference/pipelines/get-pipeline-stats.md): Returns aggregate statistics for a pipeline.
- [List pipeline cards](https://developers.voxys.ai/api-reference/pipelines/list-pipeline-cards.md): Returns all cards (deals) in a pipeline, with optional filtering by stage or lead status.
- [List pipeline stages](https://developers.voxys.ai/api-reference/pipelines/list-pipeline-stages.md): Returns all stages for a pipeline, ordered by position.
- [List pipelines](https://developers.voxys.ai/api-reference/pipelines/list-pipelines.md): Returns all pipelines (funnels) for the account.
- [Move a pipeline card](https://developers.voxys.ai/api-reference/pipelines/move-a-pipeline-card.md): Moves a card to a different stage and/or position within the pipeline.
- [Reorder pipeline stages](https://developers.voxys.ai/api-reference/pipelines/reorder-pipeline-stages.md): Updates the display order of stages within a pipeline.
- [Update a pipeline](https://developers.voxys.ai/api-reference/pipelines/update-a-pipeline.md): Updates fields of an existing pipeline.
- [Update a pipeline card](https://developers.voxys.ai/api-reference/pipelines/update-a-pipeline-card.md): Updates fields of an existing pipeline card.
- [Update a pipeline stage](https://developers.voxys.ai/api-reference/pipelines/update-a-pipeline-stage.md): Updates fields of an existing pipeline stage.
- [Fetch user profile](https://developers.voxys.ai/api-reference/profile/fetch-user-profile.md): Get the user profile details
- [Update user profile](https://developers.voxys.ai/api-reference/profile/update-user-profile.md): Update the user profile details
- [Create project](https://developers.voxys.ai/api-reference/projects/create-project.md): Creates a new project.
- [Create project from template](https://developers.voxys.ai/api-reference/projects/create-project-from-template.md): Creates a new project pre-populated from a project template.
- [Create project task](https://developers.voxys.ai/api-reference/projects/create-project-task.md): Creates a new task within a project.
- [List project tasks](https://developers.voxys.ai/api-reference/projects/list-project-tasks.md): Returns all tasks for a project.
- [List projects](https://developers.voxys.ai/api-reference/projects/list-projects.md): Returns projects for the account with optional filters.
- [Update project](https://developers.voxys.ai/api-reference/projects/update-project.md): Updates an existing project.
- [Create provider](https://developers.voxys.ai/api-reference/providers/create-provider.md): Creates a new service provider.
- [List providers](https://developers.voxys.ai/api-reference/providers/list-providers.md): Returns all service providers for the account.
- [Update provider](https://developers.voxys.ai/api-reference/providers/update-provider.md): Updates an existing service provider.
- [Account Conversation Metrics](https://developers.voxys.ai/api-reference/reports/account-conversation-metrics.md): Get conversation metrics for Account
- [Account Reporting Events](https://developers.voxys.ai/api-reference/reports/account-reporting-events.md): Get paginated reporting events for the account. This endpoint returns reporting events such as first response time, resolution time, and other metrics. Only administrators can access this endpoint. Results are paginated with 25 items per page.
- [Agent Conversation Metrics](https://developers.voxys.ai/api-reference/reports/agent-conversation-metrics.md): Get conversation metrics for Agent
- [Get Account reports](https://developers.voxys.ai/api-reference/reports/get-account-reports.md): Get Account reports for a specific type, metric and date range
- [Get Account reports summary](https://developers.voxys.ai/api-reference/reports/get-account-reports-summary.md): Get Account reports summary for a specific type and date range
- [Get conversation statistics grouped by agent](https://developers.voxys.ai/api-reference/reports/get-conversation-statistics-grouped-by-agent.md): Get conversation statistics grouped by agent for a given date range. Returns metrics for each agent including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get conversation statistics grouped by channel type](https://developers.voxys.ai/api-reference/reports/get-conversation-statistics-grouped-by-channel-type.md): Get conversation counts grouped by channel type and status for a given date range. Returns statistics for each channel type including open, resolved, pending, snoozed, and total conversation counts.
- [Get conversation statistics grouped by inbox](https://developers.voxys.ai/api-reference/reports/get-conversation-statistics-grouped-by-inbox.md): Get conversation statistics grouped by inbox for a given date range. Returns metrics for each inbox including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get conversation statistics grouped by team](https://developers.voxys.ai/api-reference/reports/get-conversation-statistics-grouped-by-team.md): Get conversation statistics grouped by team for a given date range. Returns metrics for each team including conversation counts, resolution counts, average first response time, average resolution time, and average reply time.
- [Get first response time distribution by channel](https://developers.voxys.ai/api-reference/reports/get-first-response-time-distribution-by-channel.md): Get the distribution of first response times grouped by channel type. Returns conversation counts in different time buckets (0-1h, 1-4h, 4-8h, 8-24h, 24h+) for each channel type.
- [Get inbox-label matrix report](https://developers.voxys.ai/api-reference/reports/get-inbox-label-matrix-report.md): Get a matrix showing the count of conversations for each inbox-label combination. Returns a list of inboxes, labels, and a 2D matrix where each cell contains the count of conversations in a specific inbox that have a specific label applied.
- [Get outgoing messages count grouped by entity](https://developers.voxys.ai/api-reference/reports/get-outgoing-messages-count-grouped-by-entity.md): Get the count of outgoing messages grouped by a specified entity (agent, team, inbox, or label). When grouped by agent, messages sent by bots (AgentBot, Captain::Assistant) are excluded.
- [Cancel scheduled message](https://developers.voxys.ai/api-reference/scheduled-messages/cancel-scheduled-message.md): Cancels a pending scheduled message.
- [Create scheduled message](https://developers.voxys.ai/api-reference/scheduled-messages/create-scheduled-message.md): Schedules a message for future delivery.
- [List scheduled messages](https://developers.voxys.ai/api-reference/scheduled-messages/list-scheduled-messages.md): Returns scheduled messages with optional filters.
- [Add a New Agent](https://developers.voxys.ai/api-reference/teams/add-a-new-agent.md): Add a new Agent to Team
- [Create a team](https://developers.voxys.ai/api-reference/teams/create-a-team.md): Create a team in the account
- [Delete a team](https://developers.voxys.ai/api-reference/teams/delete-a-team.md): Delete a team from the account
- [Get a team details](https://developers.voxys.ai/api-reference/teams/get-a-team-details.md): Get the details of a team in the account
- [List Agents in Team](https://developers.voxys.ai/api-reference/teams/list-agents-in-team.md): Get Details of Agents in an Team
- [List all teams](https://developers.voxys.ai/api-reference/teams/list-all-teams.md): List all teams available in the current account
- [Remove an Agent from Team](https://developers.voxys.ai/api-reference/teams/remove-an-agent-from-team.md): Remove an Agent from Team
- [Update a team](https://developers.voxys.ai/api-reference/teams/update-a-team.md): Update a team's attributes
- [Update Agents in Team](https://developers.voxys.ai/api-reference/teams/update-agents-in-team.md): All agents except the one passed in params will be removed
- [Add a webhook](https://developers.voxys.ai/api-reference/webhooks/add-a-webhook.md): Add a webhook subscription to the account
- [Delete a webhook](https://developers.voxys.ai/api-reference/webhooks/delete-a-webhook.md): Delete a webhook from the account
- [List all webhooks](https://developers.voxys.ai/api-reference/webhooks/list-all-webhooks.md): List all webhooks in the account
- [Update a webhook object](https://developers.voxys.ai/api-reference/webhooks/update-a-webhook-object.md): Update a webhook object in the account
- [Create WhatsApp Flow](https://developers.voxys.ai/api-reference/whatsapp-flows/create-whatsapp-flow.md): Creates a new WhatsApp Flow.
- [List WhatsApp Flows](https://developers.voxys.ai/api-reference/whatsapp-flows/list-whatsapp-flows.md): Returns all WhatsApp Flows for the account.
- [Publish WhatsApp Flow](https://developers.voxys.ai/api-reference/whatsapp-flows/publish-whatsapp-flow.md): Publishes a draft WhatsApp Flow to Meta.
- [Sync flows from Meta](https://developers.voxys.ai/api-reference/whatsapp-flows/sync-flows-from-meta.md): Imports WhatsApp Flows from Meta for the given inbox.
- [Clone template](https://developers.voxys.ai/api-reference/whatsapp-templates/clone-template.md): Creates a duplicate of an existing template with a new name.
- [Create WhatsApp template](https://developers.voxys.ai/api-reference/whatsapp-templates/create-whatsapp-template.md): Creates a new WhatsApp message template.
- [Delete WhatsApp template](https://developers.voxys.ai/api-reference/whatsapp-templates/delete-whatsapp-template.md): Soft-deletes a WhatsApp template.
- [List WhatsApp templates](https://developers.voxys.ai/api-reference/whatsapp-templates/list-whatsapp-templates.md): Returns a paginated list of WhatsApp templates, with optional filters.
- [Show WhatsApp template](https://developers.voxys.ai/api-reference/whatsapp-templates/show-whatsapp-template.md): Returns a single WhatsApp template.
- [Submit template to Meta](https://developers.voxys.ai/api-reference/whatsapp-templates/submit-template-to-meta.md): Submits a draft template to Meta for review and approval.
- [Template analytics](https://developers.voxys.ai/api-reference/whatsapp-templates/template-analytics.md): Returns aggregate performance analytics across all WhatsApp templates.
- [Update WhatsApp template](https://developers.voxys.ai/api-reference/whatsapp-templates/update-whatsapp-template.md): Updates a draft WhatsApp template.
- [Upload template media](https://developers.voxys.ai/api-reference/whatsapp-templates/upload-template-media.md): Uploads a media file for use in a WhatsApp template header.
- [Welcome to Voxys Connect Developer Docs](https://developers.voxys.ai/introduction.md): Your comprehensive guide to integrating with Voxys Connect - the omnichannel CPaaS platform for MENA businesses.

## OpenAPI Specs

- [voxys_whatsapp_swagger](https://developers.voxys.ai/api-reference/voxys_whatsapp_swagger.json)
- [voxys_projects_swagger](https://developers.voxys.ai/api-reference/voxys_projects_swagger.json)
- [voxys_campaigns_swagger](https://developers.voxys.ai/api-reference/voxys_campaigns_swagger.json)
- [voxys_appointments_swagger](https://developers.voxys.ai/api-reference/voxys_appointments_swagger.json)
- [voxys_analytics_swagger](https://developers.voxys.ai/api-reference/voxys_analytics_swagger.json)
- [voxys_crm_swagger](https://developers.voxys.ai/api-reference/voxys_crm_swagger.json)
- [other_swagger](https://developers.voxys.ai/api-reference/other_swagger.json)
- [client_swagger](https://developers.voxys.ai/api-reference/client_swagger.json)
- [application_swagger](https://developers.voxys.ai/api-reference/application_swagger.json)