# Delete Agent
Source: https://docs.chat-dash.com/api-reference/agents/pages/delete-agents

delete /agents/{agentId}
Delete a agent



# Fetch Agent
Source: https://docs.chat-dash.com/api-reference/agents/pages/get-agent

get /agents/{agentId}
Fetch a specific agent



# Fetch Agents
Source: https://docs.chat-dash.com/api-reference/agents/pages/get-agents

get /agents
Fetch all agents in your agency



# Fetch Client Agents
Source: https://docs.chat-dash.com/api-reference/agents/pages/get-client-agents

get /clients/{clientId}/agents
Fetch all agents for a specific client



# Create Agent
Source: https://docs.chat-dash.com/api-reference/agents/pages/post-agents

post /agents
Create a new agent



# Update Agent
Source: https://docs.chat-dash.com/api-reference/agents/pages/put-agents

put /agents/{agentId}
Update a agent



# Assign Agents to Client
Source: https://docs.chat-dash.com/api-reference/agents/pages/put-agents-assign

put /agents/assign
Assign existing agents to a specific client



# Unassign Agent from Client
Source: https://docs.chat-dash.com/api-reference/agents/pages/put-agents-unassign

put /agents/{agentId}/unassign
Unassign an existing agent from a specific client



# Trigger AI Analysis
Source: https://docs.chat-dash.com/api-reference/ai-analysis/pages/post-ai-analysis

post /agents/{agentId}/conversations/{conversationId}/{endpoint}
Programmatically trigger various AI Analysis endpoints for a specific conversation in a agent. Ensure your account has sufficient credits to use this feature.



# Query Agent Analytics
Source: https://docs.chat-dash.com/api-reference/analytics/pages/get-analytics

post /agents/{agentId}/analytics/query
Query various metrics about a agent, such as the number of conversations, the number of users, and the number of messages



# Fetch Agent Audit Logs
Source: https://docs.chat-dash.com/api-reference/audit-logs/pages/get-agents-audit-logs

GET /agents/{agentId}/audit-logs
Fetch audit logs for a specific agent. Supports filtering by event type, date range, and conversation.



# Fetch Conversation Audit Logs
Source: https://docs.chat-dash.com/api-reference/audit-logs/pages/get-conversations-audit-logs

GET /conversations/{conversationId}/audit-logs
Fetch audit logs for a specific conversation.



# Remove Client Member
Source: https://docs.chat-dash.com/api-reference/clients/pages/delete-client-members

delete /clients/{clientId}/members/{memberId}
Remove a member from a specific client



# Delete Client
Source: https://docs.chat-dash.com/api-reference/clients/pages/delete-clients

delete /clients/{clientId}
Delete a client



# Fetch Client
Source: https://docs.chat-dash.com/api-reference/clients/pages/get-client

get /clients/{clientId}
Fetch a specific client



# Fetch Client Members
Source: https://docs.chat-dash.com/api-reference/clients/pages/get-client-members

get /clients/{clientId}/members
Fetch all members associated with a specific client



# Fetch Clients
Source: https://docs.chat-dash.com/api-reference/clients/pages/get-clients

get /clients
Fetch all clients in your agency



# Add Client Member
Source: https://docs.chat-dash.com/api-reference/clients/pages/post-client-members

post /clients/{clientId}/members
Add a new member to a specific client



# Create Client
Source: https://docs.chat-dash.com/api-reference/clients/pages/post-clients

post /clients
Create a new client with its first member



# Update Client Member
Source: https://docs.chat-dash.com/api-reference/clients/pages/put-client-members

put /clients/{clientId}/members/{memberId}
Update a client member



# Update Client
Source: https://docs.chat-dash.com/api-reference/clients/pages/put-clients

put /clients/{clientId}
Update a client



# Delete Conversation
Source: https://docs.chat-dash.com/api-reference/conversations/pages/delete-agents-conversations

delete /agents/{agentId}/conversations/{conversationId}
Delete a conversation and its associated messages



# Fetch Agent Conversations
Source: https://docs.chat-dash.com/api-reference/conversations/pages/get-agents-conversations

get /agents/{agentId}/conversations
Fetch conversations for a agent with optional filtering. By default, conversations that have the 'record' and 'interacted' fields set to true will be returned (i.e. conversations that are being recorded and have user interaction).



# Fetch Single Conversation
Source: https://docs.chat-dash.com/api-reference/conversations/pages/get-conversation

get /agents/{agentId}/conversations/{conversationId}
Fetch a single conversation by its ID for a specific agent



# Create Conversation
Source: https://docs.chat-dash.com/api-reference/conversations/pages/post-agents-conversations

post /agents/{agentId}/conversations
Create a new conversation for a agent. For best results, fill in as many of the fields as possible when creating a conversation object.



# Update Conversation
Source: https://docs.chat-dash.com/api-reference/conversations/pages/put-agents-conversations

put /agents/{agentId}/conversations/{conversationId}
Update a conversation's read, endedAt, record, interacted, and isLive fields



# ChatDash API Introduction
Source: https://docs.chat-dash.com/api-reference/introduction

Leverage ChatDash's API for your custom applications and workflows.

## Overview

The ChatDash API empowers developers to seamlessly integrate ChatDash's powerful management and analytics capabilities into their own applications and workflows.
With this API, you can programmatically create and manage agents, handle conversations, and access analytics data, enabling you to build custom solutions that leverage ChatDash's robust features.

See some [examples](https://docs.chat-dash.com/api-reference/use-case-examples) to get you started.

## Authentication

All API endpoints are authenticated using the ChatDash API Key found in your [agency profile](https://chat-dash.com/agency/profile).


# Delete Lead
Source: https://docs.chat-dash.com/api-reference/leads/pages/delete-leads

delete /agents/{agentId}/leads/{leadId}
Delete a lead for a agent



# Delete Tag
Source: https://docs.chat-dash.com/api-reference/leads/pages/delete-leads-tags

delete /agents/{agentId}/leads/tags/{tagId}
Delete a tag for leads in a agent



# Fetch Agent Leads
Source: https://docs.chat-dash.com/api-reference/leads/pages/get-leads

get /agents/{agentId}/leads
Fetch all leads for a specific agent



# Fetch Tags
Source: https://docs.chat-dash.com/api-reference/leads/pages/get-leads-tags

get /agents/{agentId}/leads/tags
Fetch all tags used for leads in a specific agent



# Create Leads
Source: https://docs.chat-dash.com/api-reference/leads/pages/post-leads

post /agents/{agentId}/leads
Create one or more new leads for a agent



# Create Tag
Source: https://docs.chat-dash.com/api-reference/leads/pages/post-leads-tags

post /agents/{agentId}/leads/tags
Create a new tag for leads in a agent



# Update Lead
Source: https://docs.chat-dash.com/api-reference/leads/pages/put-leads

put /agents/{agentId}/leads/{leadId}
Update a lead for a agent



# Update Tag
Source: https://docs.chat-dash.com/api-reference/leads/pages/put-leads-tags

put /agents/{agentId}/leads/tags/{tagId}
Update a tag for leads in a agent



# Delete Conversation Messages
Source: https://docs.chat-dash.com/api-reference/messages/pages/delete-conversations-messages

delete /agents/{agentId}/conversations/{conversationId}/messages
Delete all messages for a conversation



# Get Conversation Messages
Source: https://docs.chat-dash.com/api-reference/messages/pages/get-conversations-messages

get /agents/{agentId}/conversations/{conversationId}/messages
Get all messages for a conversation



# Push Conversation Messages
Source: https://docs.chat-dash.com/api-reference/messages/pages/post-conversations-messages

post /agents/{agentId}/conversations/{conversationId}/messages
Push one or more new messages to a conversation



# Overwrite Conversation Messages
Source: https://docs.chat-dash.com/api-reference/messages/pages/put-conversations-messages

put /agents/{agentId}/conversations/{conversationId}/messages
Overwrite all messages for a conversation with a new array of messages



# Get Phone Numbers
Source: https://docs.chat-dash.com/api-reference/phone-numbers/pages/get-phone-numbers

get /clients/{clientId}/phone-numbers
Retrieve a list of phone numbers for the specified client



# Send Outbound Call
Source: https://docs.chat-dash.com/api-reference/phone-numbers/pages/post-outbound-call

post /clients/{clientId}/agents/{agentId}/outbound-call
Send an outbound call using the specified agent



# Delete Coupon
Source: https://docs.chat-dash.com/api-reference/stripe/pages/delete-stripe-connect-coupon

delete /stripe/connect/accounts/{accountId}/coupons/{couponId}
Delete a coupon for a connected account.



# Delete Product
Source: https://docs.chat-dash.com/api-reference/stripe/pages/delete-stripe-connect-product

delete /stripe/connect/accounts/{accountId}/products/{productId}
Delete a product for a connected account.



# Delete Subscription
Source: https://docs.chat-dash.com/api-reference/stripe/pages/delete-stripe-connect-subscription

delete /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}
Delete a subscription for a connected account.



# Get Coupon
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-coupon

get /stripe/connect/accounts/{accountId}/coupons/{couponId}
Retrieve a single coupon for a connected account.



# List Coupons
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-coupons

get /stripe/connect/accounts/{accountId}/coupons
Retrieve a list of coupons for a connected account.



# Get Invoice
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-invoice

get /stripe/connect/accounts/{accountId}/invoices/{invoiceId}
Retrieve a single invoice for a connected account.



# List Invoices
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-invoices

get /stripe/connect/accounts/{accountId}/invoices
Retrieve a list of invoices for a connected account.



# Get Product
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-product

get /stripe/connect/accounts/{accountId}/products/{productId}
Retrieve a single product for a connected account.



# List Products
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-products

get /stripe/connect/accounts/{accountId}/products
Retrieve a list of products for a connected account.



# List Promotion Codes by Coupon
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-promotion-codes-by-coupon

get /stripe/connect/accounts/{accountId}/coupons/{couponId}/promotion-codes
Retrieve promotion codes for a coupon on a connected account.



# Get Subscription
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-subscription

get /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}
Retrieve a single subscription for a connected account.



# List Subscriptions
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-subscriptions

get /stripe/connect/accounts/{accountId}/subscriptions
Retrieve a list of subscriptions for a connected account.



# List Subscriptions by Customer
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-subscriptions-by-customer

get /stripe/connect/accounts/{accountId}/subscriptions/by-customer
Retrieve subscriptions for a connected account filtered by customer.



# Get Transaction
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-transaction

get /stripe/connect/accounts/{accountId}/transactions/{transactionId}
Retrieve a single transaction for a connected account.



# List Transactions
Source: https://docs.chat-dash.com/api-reference/stripe/pages/get-stripe-connect-transactions

get /stripe/connect/accounts/{accountId}/transactions
Retrieve a list of transactions for a connected account.



# Create Coupon
Source: https://docs.chat-dash.com/api-reference/stripe/pages/post-stripe-connect-coupons

post /stripe/connect/accounts/{accountId}/coupons
Create a coupon for a connected account.



# Create Invoice
Source: https://docs.chat-dash.com/api-reference/stripe/pages/post-stripe-connect-invoices

post /stripe/connect/accounts/{accountId}/invoices
Create an invoice for a connected account.



# Create Product
Source: https://docs.chat-dash.com/api-reference/stripe/pages/post-stripe-connect-products

post /stripe/connect/accounts/{accountId}/products
Create a product for a connected account.



# Create Promotion Code
Source: https://docs.chat-dash.com/api-reference/stripe/pages/post-stripe-connect-promotion-codes

post /stripe/connect/accounts/{accountId}/promotion-codes
Create a promotion code for a connected account.



# Create Subscription
Source: https://docs.chat-dash.com/api-reference/stripe/pages/post-stripe-connect-subscriptions

post /stripe/connect/accounts/{accountId}/subscriptions
Create a subscription for a connected account.



# Update Coupon
Source: https://docs.chat-dash.com/api-reference/stripe/pages/put-stripe-connect-coupon

put /stripe/connect/accounts/{accountId}/coupons/{couponId}
Update a coupon for a connected account.



# Update Product
Source: https://docs.chat-dash.com/api-reference/stripe/pages/put-stripe-connect-product

put /stripe/connect/accounts/{accountId}/products/{productId}
Update a product for a connected account.



# Update Subscription
Source: https://docs.chat-dash.com/api-reference/stripe/pages/put-stripe-connect-subscription

put /stripe/connect/accounts/{accountId}/subscriptions/{subscriptionId}
Update a subscription for a connected account.



# Use Case Examples
Source: https://docs.chat-dash.com/api-reference/use-case-examples

Integration ideas to get you started with the ChatDash API

## Custom Agent Integration

Do you want to utilize the ChatDash dashboard, but use a agent builder not officially supported by ChatDash?

1. [Create Agent](https://docs.chat-dash.com/api-reference/agents/pages/post-agents) using the "custom" platform option.
2. [Assign Agent](https://docs.chat-dash.com/api-reference/agents/pages/put-agents-assign) to a client.
3. [Create Conversation](https://docs.chat-dash.com/api-reference/conversations/pages/post-agents-conversations) and [Push Conversation Messages](https://docs.chat-dash.com/api-reference/messages/pages/post-conversations-messages)
   for the agent in your code whenever you want to import conversations into ChatDash.
4. Use the dashboard to view analytics and conversations as you normally would.

\*Steps 1 and 2 can also be done directly in the Agency Dashboard.

## Client Onboarding

Do you want your clients to go through a self-directed onboarding process on your custom domain?

1. Create a custom "register" or "onboarding" page on your website.
2. [Create Client](https://docs.chat-dash.com/api-reference/clients/pages/post-clients) when a client registers.
3. Automatically assign an agent or allow the client to choose from a selection of your existing agents [Assign Agent](https://docs.chat-dash.com/api-reference/agents/pages/put-agents-assign).
4. Direct clients to sign in using the whitelabeled Log In page as you normally would.


# Delete Webhook Subscription
Source: https://docs.chat-dash.com/api-reference/webhooks/pages/delete-webhook-subscription

delete /webhooks/subscriptions/{subscriptionId}
Delete a specific webhook subscription



# Get Webhook Subscription
Source: https://docs.chat-dash.com/api-reference/webhooks/pages/get-webhook-subscription

get /webhooks/subscriptions/{subscriptionId}
Get a specific webhook subscription by ID



# List Webhook Subscriptions
Source: https://docs.chat-dash.com/api-reference/webhooks/pages/get-webhook-subscriptions

get /webhooks/subscriptions
Get all webhook subscriptions for a client



# Create Webhook Subscription
Source: https://docs.chat-dash.com/api-reference/webhooks/pages/post-webhook-subscriptions

post /webhooks/subscriptions
Create a new webhook subscription for receiving event notifications



# Update Subscription Events
Source: https://docs.chat-dash.com/api-reference/webhooks/pages/put-webhook-subscription-events

put /webhooks/subscriptions/{subscriptionId}/events
Update events for a specific webhook subscription