PUT
/
chatbots
/
{chatbotId}
curl --request PUT \
  --url https://api.chat-dash.com/v1/public/chatbots/{chatbotId} \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "<string>",
  "apiId": "<string>",
  "apiKey": "<string>",
  "platformCredentials": {},
  "usingExternalWidget": false
}'
{
  "message": "Chatbot updated successfully"
}

Headers

Authorization
string
required

All requests to the ChatDash API must be validated with the agency API Key found on your agency profile

Path Parameters

chatbotId
string
required

The ID of the chatbot

Body

application/json
name
string

The chatbot's name

apiId
string

The 'ID' for interacting with the chatbot platform's API. Varies by platform:

  • Voiceflow: Project ID
  • OpenAI: Assistant ID
  • Botpress: Messaging API webhook URL
  • Vectorshift: Chatbot Name on VectorShift
  • Flowise: Chatflow ID
  • Vapi: Assistant ID
  • Retell: Agent ID
  • ElevenLabs: Agent ID
  • n8n: N/A
  • Custom: N/A
apiKey
string

The 'Key' for interacting with the chatbot platform's API. Varies by platform:

  • Voiceflow: Dialog API Key
  • OpenAI: API Key
  • Botpress: Personal Access Token
  • Vectorshift: API Key
  • Flowise: API Key
  • Vapi: Private API Key
  • Retell: API Key
  • ElevenLabs: API Key
  • n8n: N/A
  • Custom: N/A
platformCredentials
object

Additional credentials for interacting with certain chatbot platform's API (field only required for the specified platforms below)

usingExternalWidget
boolean
default:
false

Whether the chatbot is using an external widget or interface over ChatDash's native widget. Varied support by platform:

  • Voiceflow: Supported
  • OpenAI: Supported
  • Botpress: Supported
  • Vectorshift: Not Supported
  • Flowise: Supported
  • Vapi: Supported
  • Retell: Supported
  • ElevenLabs: Required to be set to true
  • n8n: Not Supported

Response

200
application/json
OK
message
string