Accounts
- Create an Account
- Get an account details
- Update an account
- Delete an Account
Account Users
- List all Account Users
- Create an Account User
- Delete an Account User
AgentBots
- List all AgentBots
- Create an Agent Bot
- Get an agent bot details
- Update an agent bot
- Delete an AgentBot
Users
- Create a User
- Get an user details
- Update a user
- Delete a User
- Get User SSO Link
Inbox API
- Inbox details
Contacts API
- Create a contact
- Get a contact
- Update a contact
Conversations API
- Create a conversation
- List all conversations
- Get a single conversation
- Resolve a conversation
- Toggle typing status
- Update last seen
Messages API
- Create a message
- List all messages
- Update a message
Contact Labels
- List Labels
- Add Labels
CSAT Survey Page
- Get CSAT survey page
Account AgentBots
- List all AgentBots
- Create an Agent Bot
- Get an agent bot details
- Update an agent bot
- Delete an AgentBot
Agents
- List Agents in Account
- Add a New Agent
- Update Agent in Account
- Remove an Agent from Account
Canned Responses
- List all Canned Responses in an Account
- Add a New Canned Response
- Remove a Canned Response from Account
Canned Response
- Update Canned Response in Account
Custom Attributes
- List all custom attributes in an account
- Add a new custom attribute
- Get a custom attribute details
- Update custom attribute in Account
- Remove a custom attribute from account
Contacts
- List Contacts
- Create Contact
- Show Contact
- Update Contact
- Delete Contact
- Contact Conversations
- Search Contacts
- Contact Filter
Contact
- Create contact inbox
- Get Contactable Inboxes
Automation Rule
- List all automation rules in an account
- Add a new automation rule
- Get a automation rule details
- Update automation rule in Account
- Remove a automation rule from account
Help Center
- Add a new portal
- List all portals in an account
- update a new portal
- Add a new category
- Add a new article
Conversations
- Get Conversation Counts
- Conversations List
- Create New Conversation
- Conversations Filter
- Conversation Details
- Update Conversation
- Toggle Status
- Toggle Priority
- Resolve conversation by session ID
- Switch conversation handler
- Update Custom Attributes
Conversation Assignment
- Assign Conversation
Conversation Labels
- List Labels
- Add Labels
Inboxes
- List all inboxes
- Get an inbox
- Create an inbox
- Update Inbox
- Show Inbox Agent Bot
- Add or remove agent bot
- List Agents in Inbox
- Get paths assigned to inbox
- Add a New Agent
- Assign paths to inbox
- Update Agents in Inbox
- Remove paths from inbox
- Remove an Agent from Inbox
- Update all paths for inbox
Messages
- Get messages
- Create New Message
- Delete a message
Integrations
- List all the Integrations
- Create an integration hook
- Update an Integration Hook
- Delete an Integration Hook
Profile
- Fetch user profile
Teams
- List all teams
- Create a team
- Get a team details
- Update a team
- Delete a team
- List Agents in Team
- Add a New Agent
- Update Agents in Team
- Remove an Agent from Team
Custom Filters
- List all custom filters
- Create a custom filter
- Get a custom filter details
- Update a custom filter
- Delete a custom filter
Webhooks
- List all webhooks
- Add a webhook
- Update a webhook object
- Delete a webhook
Reports
- Get Account reports
- Get Account reports summary
- Account Conversation Metrics
- Agent Conversation Metrics
Platform - Conversations
- Create a new conversation
Platform Documents
- List all documents
- Create a new document
- Show a specific document
- Update an existing document
- Delete a document
Macros
- List all Macros
- Create a Macro
- Get a Macro
- Update a Macro
- Delete a Macro
- Execute a Macro
Paths
- Get all available paths
- Get specific path with workflow
Ticketing Issue Types
- List all Issue Types
- Create an Issue Type
- Get an Issue Type
- Update an Issue Type
- Delete an Issue Type
Ticketing Custom Fields
- List all Custom Fields
- Create a Custom Field
- Get a Custom Field
- Update a Custom Field
- Delete a Custom Field
Ticketing Status Workflows
- List all Status Workflows
- Create a Status Workflow
- Reorder Status Workflows
- Get a Status Workflow
- Update a Status Workflow
- Delete a Status Workflow
Ticketing Issues
- List all Issues
- Create an Issue
- Search Issues for Assignment
- Get an Issue
- Update an Issue
- Delete an Issue
- Associate Conversation to Issue
- Remove Conversation from Issue
Ticketing Comments
- Create a Comment
- Update a Comment
- Delete a Comment
Aily Assistants
- List all Assistants
- Create an Assistant
- Get an Assistant
- Update an Assistant
- Delete an Assistant
- Test Assistant in Playground
Aily Assistant Inboxes
- List Inboxes for Assistant
- Associate Inbox to Assistant
- Remove Inbox from Assistant
Aily Assistant Responses
- List Assistant Responses
- Create Assistant Response
- Get Assistant Response
- Update Assistant Response
- Delete Assistant Response
Aily Bulk Actions
- Perform Bulk Action
Aily Copilot Threads
- List Copilot Threads
- Create Copilot Thread
Aily Copilot Messages
- List Copilot Messages
- Create Copilot Message
Aily Documents
- List Documents
- Create Document
- Get Document
- Delete Document
- Generate FAQ from Document
- Delete Documents by Keys
- Get Assistants for Document Keys
- Get Document Filter Options
- Get Document Groups
- Get Documents by Group
- Resync URL Group
- Resync Knowledgebase Group
- Delete Document Group
Aily Collections
- List Collections
- Get Knowledgebases by Collection
SLA Policies
- List all SLA Policies
- Create an SLA Policy
- Get an SLA Policy
- Update an SLA Policy
- Delete an SLA Policy
Custom Roles
- List all Custom Roles
- Create a Custom Role
- Get a Custom Role
- Update a Custom Role
- Delete a Custom Role
Meetings
- List all Meetings
- Create a Meeting
- Get Available Slots
- Get a Meeting
- Update a Meeting
- Delete a Meeting
Campaigns
- List all Campaigns
- Create a Campaign
- Get a Campaign
- Update a Campaign
- Delete a Campaign
MCP Servers
- List all MCP Servers
- Create an MCP Server
- Get an MCP Server
- Update an MCP Server
- Delete an MCP Server
- Test MCP Server Connection
- Refresh MCP Server Capabilities
Assistant MCP Servers
- List Assistant MCP Server Associations
- Create Assistant MCP Server Association
- Bulk Update Assistant MCP Server Associations
- Update Assistant MCP Server Association
- Delete Assistant MCP Server Association
Dashboard Apps
- List all Dashboard Apps
- Create a Dashboard App
- Get a Dashboard App
- Update a Dashboard App
- Delete a Dashboard App
Schemas
- Schemas
- data
- request_error
- generic_id
- canned_response
- custom_attribute
- automation_rule
- portal
- category
- article
- contact
- conversation
- message
- user
- agent
- inbox
- agent_bot
- contact_inboxes
- macro
- contactable_inboxes
- custom_filter
- webhook
- account
- platform_account
- team
- integrations_app
- integrations_hook
- public_contact
- public_conversation
- path
- public_message
- public_inbox
- account_create_update_payload
- agent_bot_create_update_payload
- user_create_update_payload
- canned_response_create_update_payload
- custom_attribute_create_update_payload
- macro_create_update_payload
- contact_create
- contact_update
- conversation_message_create
- team_create_update_payload
- custom_filter_create_update_payload
- webhook_create_update_payload
- integrations_hook_create_payload
- integrations_hook_update_payload
- automation_rule_create_update_payload
- portal_create_update_payload
- category_create_update_payload
- article_create_update_payload
- public_contact_create_update_payload
- public_message_create_payload
- public_message_update_payload
- public_conversation_create_payload
- extended_contact
- contact_base
- contact_list
- contact_conversations
- contact_labels
- conversation_list
- conversation_show
- conversation_status_toggle
- conversation_labels
- account_summary
- agent_conversation_metrics
- platform_documents_create_payload
- platform_documents_create_response
- platform_documents_list_response
- platform_documents_show_response
- platform_documents_update_payload
- platform_documents_update_response
- platform_documents_delete_payload
- platform_documents_delete_response

platform_documents_delete_response

{
    "success": true,
    "message": "Document deleted successfully along with its FAQ and embeddings",
    "faqs_deleted": 5
}