Skip to main content
PUT
/
bot
/
{id}
Update a bot
curl --request PUT \
  --url https://api.closebot.com/bot/{id} \
  --header 'Content-Type: application/json' \
  --header 'X-CB-KEY: <api-key>' \
  --data '
{
  "favorite": true,
  "trash": true,
  "locked": true,
  "rescheduling": true,
  "name": "<string>",
  "folderId": "<string>",
  "category": "<string>",
  "followUpActive": true,
  "followUpSequences": [
    {
      "order": 123,
      "duration": 123,
      "unit": "<string>"
    }
  ],
  "smartFollowUp": true,
  "followUpRepeat": true,
  "followUpVarianceMinutes": 123,
  "followUpExtraPrompt": "<string>"
}
'
{
  "id": "<string>",
  "name": "<string>",
  "modifiedAt": "<string>",
  "modifiedBy": "<string>",
  "versions": [
    {
      "version": "<string>",
      "name": "<string>",
      "published": true,
      "modifiedAt": "2023-11-07T05:31:56Z",
      "modifiedBy": "<string>"
    }
  ],
  "sources": [
    {
      "id": "<string>",
      "category": "<string>",
      "key": "<string>",
      "name": "<string>",
      "tags": [
        {
          "name": "<string>",
          "approveDeny": true,
          "id": "<string>"
        }
      ],
      "channelList": [
        "<string>"
      ],
      "personaNameOverride": "<string>",
      "enabled": true
    }
  ],
  "personaIds": [
    "<string>"
  ],
  "favorited": true,
  "locked": true,
  "reschedulingEnabled": true,
  "category": "<string>",
  "folderId": "<string>",
  "followUpActive": true,
  "followUpSequences": [
    {
      "order": 123,
      "duration": 123,
      "unit": "<string>"
    }
  ],
  "smartFollowUp": true,
  "followUpRepeat": true,
  "followUpVarianceMinutes": 123,
  "followUpExtraPrompt": "<string>",
  "tools": [
    {
      "id": "<string>",
      "type": "<string>",
      "enabled": true,
      "options": {}
    }
  ]
}

Authorizations

X-CB-KEY
string
header
required

CloseBot API Key Authorization

Path Parameters

id
string
required

The bot ID.

Body

favorite
boolean | null

Whether the bot is favorited

trash
boolean | null

Whether the bot is trashed

locked
boolean | null

Whether the bot is locked

rescheduling
boolean | null

Whether the bot has conversation rescheduling enabled

name
string | null

The name of the bot

folderId
string | null

The folder ID of the bot

category
string | null

The category of the bot

followUpActive
boolean | null

Whether the bot does follow-ups

followUpSequences
object[] | null

The follow-up sequences of the bot

smartFollowUp
boolean | null

Whether the bot does smart follow-ups

followUpRepeat
boolean | null

Whether the bot repeats the last follow-up sequence

followUpVarianceMinutes
integer<int32> | null

The variance minutes for the follow-ups

followUpExtraPrompt
string | null

The extra prompt for the follow-ups

Response

Success

id
string | null
name
string | null
modifiedAt
string | null
modifiedBy
string | null
versions
object[] | null
sources
object[] | null
personaIds
string[] | null
favorited
boolean
locked
boolean
reschedulingEnabled
boolean
category
string | null
folderId
string | null
followUpActive
boolean
followUpSequences
object[] | null
smartFollowUp
boolean
followUpRepeat
boolean
followUpVarianceMinutes
integer<int32>
followUpExtraPrompt
string | null
tools
object[] | null