Skip to main content
POST
Update a VoiceLink WebSocket bot

Authorizations

Authorization
string
header
required

API key in format: rg_live_xxxx. Pass as a Bearer token in the Authorization header.

Path Parameters

bot_id
integer
required

VoiceLink bot ID.

Required range: x >= 1

Body

application/json

VoiceLink bot update REPLACES the record — resend every field you want kept.

bot_name
string
required

Display name for the WebSocket bot.

websocket_url
string<uri>
required

WebSocket URL the bot connects to. Required on update because the record is replaced.

status
enum<integer>
required

Bot status: 1 active, 0 inactive.

Available options:
0,
1
connection_id
string<uuid>

Optional unless multiple active VoiceLink connections exist. connectionId is accepted for backwards compatibility.

webhook_url
string

Optional VoiceLink webhook URL for call events.

Response

VoiceLink bot updated.

A VoiceLink upstream response wrapped in the V2 success envelope. The data shape is forwarded from VoiceLink and may vary by endpoint.

success
boolean
required
data
required

VoiceLink upstream response body.