Skip to main content
POST
Connect a Telegram bot

Authorizations

X-API-KEY
string
header
required

Your partner API key, pk_…. Backend only.

Path Parameters

workspace
string<uuid>
required

A workspace uuid from provisioning. It must be administered by a customer you provisioned.

Body

application/json
bot_token
string
required
Required string length: 20 - 120
Example:

"123456:ABC…"

name
string
Maximum string length: 120
Example:

"Acme Motors"

takeover
boolean

Move the bot's webhook here even though it points somewhere else.

Response

Already connected; refreshed

success
boolean
Example:

true

data
object
meta
object