Skip to content

Update a bot

PATCH
/api/v1/bots/{bot_id}
curl --request PATCH \
--url https://renotify.app/api/v1/bots/bot_K1QXKE6hZSmt \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "name": "Welcome Bot", "description": "Handles first-touch conversations.", "mode": "ai", "trigger_type": "keyword", "trigger_value": "help", "target_group_id": 16, "ai_instructions": "Answer politely and keep responses concise.", "ai_temperature": 0.7, "ai_max_tokens": 512, "flow_definition": { "steps": [] }, "settings": { "handoff_after": 3 } }'

Update an existing bot definition.

bot_id
required
string

The ID of the bot.

Example
bot_K1QXKE6hZSmt
Media typeapplication/json
object
name
required

The bot name.

string
Example
Welcome Bot
description

A short description of the bot.

string
nullable
Example
Handles first-touch conversations.
mode
required

The bot mode.

string
Example
ai
trigger_type
required

The trigger type used to activate the bot.

string
Example
keyword
trigger_value

The trigger value when the trigger type requires one.

string
nullable
Example
help
target_group_id

Must match an existing stored value.

integer
nullable
Example
16
ai_instructions

Instructions to use when the bot runs in AI mode.

string
nullable
Example
Answer politely and keep responses concise.
ai_temperature

The AI temperature value.

number
nullable
Example
0.7
ai_max_tokens

The maximum number of tokens for AI replies.

integer
nullable
Example
512
flow_definition

The flow definition used when the bot runs in flow mode.

object
Example
{
"steps": []
}
settings

Additional bot settings.

object
schedule_cron
string
Example
null
schedule_timezone
string
Example
null
Example
{
"handoff_after": 3
}