Update conversational components (ice breakers, commands)

PUT/v1/channels/{channelID}/conversational-components

Authorization

bearerAuthbearerAuthrequired

apiKeyAuthapiKeyAuthrequired

Path parameters

channelIDstringrequired

Channel ID

Request body

requiredapplication/json

commandsCommandItem[] | null

Bot commands (max 15)

Show properties

Array of CommandItem

command_namestringrequired

Command name

descriptionstringrequired

Command description

enable_welcome_messageboolean

Enable welcome message

promptsstring[] | null

Ice breaker prompts (max 4)

Responses

200OK

statusstringrequired

400Bad Request

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

401Unauthorized

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

403Forbidden

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

404Not Found

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

422Unprocessable Entity

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

500Internal Server Error

errorErrorBodyrequired

Show properties

codestringrequired

detailsErrorDetail[] | null

Show properties

Array of ErrorDetail

codestring

fieldstring

locationstring

messagestringrequired

request_idstring

Request

curl -X PUT "/v1/channels/string/conversational-components" \
  -H "Content-Type: application/json" \
  -d '{
  "commands": [
    {
      "command_name": "string",
      "description": "string"
    }
  ],
  "enable_welcome_message": true,
  "prompts": [
    "string"
  ]
}'

const response = await fetch("/v1/channels/string/conversational-components", {
  method: "PUT",
  headers: {
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
  "commands": [
    {
      "command_name": "string",
      "description": "string"
    }
  ],
  "enable_welcome_message": true,
  "prompts": [
    "string"
  ]
})
});

import requests

response = requests.put(
    "/v1/channels/string/conversational-components",
    headers={
        "Content-Type": "application/json"
    },
    json={
  "commands": [
    {
      "command_name": "string",
      "description": "string"
    }
  ],
  "enable_welcome_message": True,
  "prompts": [
    "string"
  ]
},
)

Response

{
  "status": "string"
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}

{
  "error": {
    "code": "string",
    "details": [
      {
        "code": "string",
        "field": "string",
        "location": "string",
        "message": "string"
      }
    ],
    "message": "string",
    "request_id": "string"
  }
}